openapi: 3.0.1
info:
  title: DataForSEO API documentation
  description: 'DataForSEO API is the starting point on your journey towards building powerful SEO software. With DataForSEO you can get all the data you need to build an efficient application while also saving your time and budget. DataForSEO API is using the REST technology for interchanging data between your application and our service. The data exchange is made through the widely used HTTP protocol, which allows applying our API to almost all programming languages.'
  version: 1.0.0
servers:
  - url: https://api.dataforseo.com
  - url: https://sandbox.dataforseo.com
paths:
  /v3/serp/id_list:
    post:
      tags:
        - Serp
      description: 'This endpoint is designed to provide you with a list of IDs and metadata for all SERP tasks created within the specified time period, including both successful and uncompleted tasks.'
      operationId: IdList
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpIdListRequestInfo'
                nullable: true
              example:
                - datetime_from: '2026-09-10 11:12:35'
                  datetime_to: '2026-09-20 11:12:35'
                  limit: 10
                  include_metadata: true
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpIdListResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/serp/errors:
    post:
      tags:
        - Serp
      description: By calling this endpoint you will receive information about the SERP API tasks that returned an error within the past 7 days.
      operationId: Errors
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpErrorsRequestInfo'
                nullable: true
              example:
                - limit: 10
                  offset: 0
                  filtered_function: pingback_url
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpErrorsResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/serp/screenshot:
    post:
      tags:
        - Serp
      description: "‌‌\nUsing the Live Page Screenshot endpoint, you can capture a screenshot of any SERP page."
      operationId: Screenshot
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpScreenshotRequestInfo'
                nullable: true
              example:
                - task_id: 06211235-0696-0139-1000-36727fbd3c90
                  browser_screen_scale_factor: 0.5
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpScreenshotResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/serp/ai_summary:
    post:
      tags:
        - Serp
      description: "‌‌\nThe purpose of the Live SERP API AI Summary endpoint is to provide a summary of the content found on any SERP and generate a response based on the user’s specified prompt.\nTo obtain results, you have to specify task_id, which you can find in the response to the POST request.\nLearn more in our Help Center."
      operationId: AiSummary
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpAiSummaryRequestInfo'
                nullable: true
              example:
                - task_id: 07031739-1535-0139-0000-9d1e639a5b7d
                  prompt: explain what DataForSEO is
                  include_links: true
                  fetch_content: true
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpAiSummaryResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/serp/google/locations:
    get:
      tags:
        - Serp
      description: You will receive the list of locations by this API call. You can filter the list of locations by country when setting a task.
      operationId: GoogleLocations
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleLocationsResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  '/v3/serp/google/locations/{country}':
    get:
      tags:
        - Serp
      description: You will receive the list of locations by this API call. You can filter the list of locations by country when setting a task.
      operationId: GoogleLocationsCountry
      parameters:
        - name: country
          in: path
          description: <em>country ISO code</em><br>optional field<br>specify the ISO code if you want to filter the list of locations by country<br>example:<br><code>us</code>
          required: true
          schema:
            type: string
          example: us
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleLocationsCountryResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/serp/google/languages:
    get:
      tags:
        - Serp
      description: You will receive the list of languages by calling this API.
      operationId: GoogleLanguages
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleLanguagesResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/serp/google/organic/task_post:
    post:
      tags:
        - Serp
      description: "‌‌\nSERP API provides top 10 search engine results by default. These results are specific to the selected location (see the List of Locations) and language (see the List of Languages) settings."
      operationId: GoogleOrganicTaskPost
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleOrganicTaskPostRequestInfo'
                nullable: true
              example:
                - language_code: en
                  location_code: 2840
                  keyword: albert einstein
                - language_name: English
                  location_name: United States
                  keyword: albert einstein
                  priority: 2
                  tag: some_string_123
                  pingback_url: https://your-server.com/pingscript?id=$id&tag=$tag
                - url: https://www.google.co.uk/search?q=albert%20einstein&hl=en&gl=GB&uule=w+CAIQIFISCXXeIa8LoNhHEZkq1d1aOpZS
                  postback_data: html
                  postback_url: https://your-server.com/postbackscript
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleOrganicTaskPostResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/serp/google/organic/tasks_ready:
    get:
      tags:
        - Serp
      description: "‌\nThe ‘Tasks Ready’ endpoint is designed to provide you with the list of completed tasks, which haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed tasks using this endpoint. Then, you can collect the results using the ‘Task GET’ endpoint.\nLearn more about task completion and obtaining a list of completed tasks in this help center article."
      operationId: GoogleOrganicTasksReady
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleOrganicTasksReadyResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/serp/tasks_ready:
    get:
      tags:
        - Serp
      description: "‌\nThe ‘Tasks Ready’ endpoint is designed to provide you with the list of completed tasks, which haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed tasks using this endpoint. Then, you can collect the results using the ‘Task GET’ endpoint.\nLearn more about task completion and obtaining a list of completed tasks in this help center article."
      operationId: TasksReady
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpTasksReadyResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/serp/google/organic/tasks_fixed:
    get:
      tags:
        - Serp
      description: "‌\nThe ‘Tasks Fixed’ endpoint is designed to provide you with the list of re-parsed tasks, which haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed re-parsed tasks using this endpoint. Then, you can re-collect the fixed results using the ‘Task GET’ endpoint."
      operationId: GoogleOrganicTasksFixed
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleOrganicTasksFixedResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  '/v3/serp/google/organic/task_get/regular/{id}':
    get:
      tags:
        - Serp
      description: 'Description of the fields for sending a request:'
      operationId: GoogleOrganicTaskGetRegular
      parameters:
        - name: id
          in: path
          description: <em>task identifier</em><br><strong>unique task identifier in our system in the <a href="https://en.wikipedia.org/wiki/Universally_unique_identifier">UUID</a> format</strong><br>you will be able to use it within <strong>30 days</strong> to request the results of the task at any time
          required: true
          schema:
            type: string
          example: 00000000-0000-0000-0000-000000000000
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleOrganicTaskGetRegularResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  '/v3/serp/google/organic/task_get/advanced/{id}':
    get:
      tags:
        - Serp
      description: 'Description of the fields for sending a request:'
      operationId: GoogleOrganicTaskGetAdvanced
      parameters:
        - name: id
          in: path
          description: <em>task identifier</em><br><strong>unique task identifier in our system in the <a href="https://en.wikipedia.org/wiki/Universally_unique_identifier">UUID</a> format</strong><br>you will be able to use it within <strong>30 days</strong> to request the results of the task at any time
          required: true
          schema:
            type: string
          example: 00000000-0000-0000-0000-000000000000
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleOrganicTaskGetAdvancedResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  '/v3/serp/google/organic/task_get/html/{id}':
    get:
      tags:
        - Serp
      description: 'Description of the fields for sending a request:'
      operationId: GoogleOrganicTaskGetHtml
      parameters:
        - name: id
          in: path
          description: <em>task identifier</em><br><strong>unique task identifier in our system in the <a href="https://en.wikipedia.org/wiki/Universally_unique_identifier">UUID</a> format</strong><br>you will be able to use it within <strong>7 days</strong> to request the results of the task at any time
          required: true
          schema:
            type: string
          example: 00000000-0000-0000-0000-000000000000
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleOrganicTaskGetHtmlResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/serp/google/organic/live/regular:
    post:
      tags:
        - Serp
      description: 'Live SERP provides real-time data on search engine results for the specified keyword, search engine, and location.'
      operationId: GoogleOrganicLiveRegular
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleOrganicLiveRegularRequestInfo'
                nullable: true
              example:
                - language_code: en
                  location_code: 2840
                  keyword: albert einstein
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleOrganicLiveRegularResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/serp/google/organic/live/advanced:
    post:
      tags:
        - Serp
      description: "Live SERP provides real-time data on top search engine results for the specified keyword, search engine, and location. This endpoint will supply a complete overview of featured snippets and other extra elements of SERPs.\nfor more info please visit 'https://docs.dataforseo.com/v3/serp/google/organic/live/advanced/?bash'"
      operationId: GoogleOrganicLiveAdvanced
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleOrganicLiveAdvancedRequestInfo'
                nullable: true
              example:
                - language_code: en
                  location_code: 2840
                  keyword: albert einstein
                  calculate_rectangles: true
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleOrganicLiveAdvancedResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/serp/google/organic/live/html:
    post:
      tags:
        - Serp
      description: "‌\nLive SERP HTML provides a raw HTML page of search engine results for the specified keyword, search engine, and location."
      operationId: GoogleOrganicLiveHtml
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleOrganicLiveHtmlRequestInfo'
                nullable: true
              example:
                - language_code: en
                  location_code: 2840
                  keyword: albert einstein
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleOrganicLiveHtmlResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/serp/google/ai_mode/languages:
    get:
      tags:
        - Serp
      description: "You will receive the list of languages by calling this API.\n \nAs a response of the API server, you will receive JSON-encoded data containing a tasks array with the information specific to the set tasks."
      operationId: GoogleAiModeLanguages
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleAiModeLanguagesResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/serp/google/ai_mode/task_post:
    post:
      tags:
        - Serp
      description: "‌\nGoogle AI Mode SERP API provides search results from the AI Mode feature of Google Search."
      operationId: GoogleAiModeTaskPost
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleAiModeTaskPostRequestInfo'
                nullable: true
              example:
                - language_code: en
                  location_code: 2840
                  keyword: what is google ai mode
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleAiModeTaskPostResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/serp/google/ai_mode/tasks_ready:
    get:
      tags:
        - Serp
      description: "‌\nThe ‘Tasks Ready’ endpoint is designed to provide you with the list of completed tasks, which haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed tasks using this endpoint. Then, you can collect the results using the ‘Task GET’ endpoint.\nLearn more about task completion and obtaining a list of completed tasks in this help center article."
      operationId: GoogleAiModeTasksReady
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleAiModeTasksReadyResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/serp/google/ai_mode/tasks_fixed:
    get:
      tags:
        - Serp
      description: "‌\nThe ‘Tasks Fixed’ endpoint is designed to provide you with the list of re-parsed tasks, which haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed re-parsed tasks using this endpoint. Then, you can re-collect the fixed results using the ‘Task GET’ endpoint."
      operationId: GoogleAiModeTasksFixed
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleAiModeTasksFixedResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  '/v3/serp/google/ai_mode/task_get/advanced/{id}':
    get:
      tags:
        - Serp
      description: 'Description of the fields for sending a request:'
      operationId: GoogleAiModeTaskGetAdvanced
      parameters:
        - name: id
          in: path
          description: <em>task identifier</em><br><a href="https://en.wikipedia.org/wiki/Universally_unique_identifier">a universally unique identifier (UUID)</a><br><strong>unique task identifier in our system</strong><br>you will be able to use it within <strong>30 days</strong> to request the results of the task at any time
          required: true
          schema:
            type: string
          example: 00000000-0000-0000-0000-000000000000
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleAiModeTaskGetAdvancedResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  '/v3/serp/google/ai_mode/task_get/html/{id}':
    get:
      tags:
        - Serp
      description: 'Description of the fields for sending a request:'
      operationId: GoogleAiModeTaskGetHtml
      parameters:
        - name: id
          in: path
          description: <em>task identifier</em><br><strong>unique task identifier in our system in the <a href="https://en.wikipedia.org/wiki/Universally_unique_identifier">UUID</a> format</strong><br>you will be able to use it within <strong>7 days</strong> to request the results of the task at any time
          required: true
          schema:
            type: string
          example: 00000000-0000-0000-0000-000000000000
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleAiModeTaskGetHtmlResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/serp/google/ai_mode/live/advanced:
    post:
      tags:
        - Serp
      description: "‌‌\nGoogle AI Mode SERP API provides search results from the AI Mode feature of Google Search."
      operationId: GoogleAiModeLiveAdvanced
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleAiModeLiveAdvancedRequestInfo'
                nullable: true
              example:
                - language_code: en
                  location_code: 2840
                  keyword: what is google ai mode
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleAiModeLiveAdvancedResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/serp/google/ai_mode/live/html:
    post:
      tags:
        - Serp
      description: "‌\nLive SERP HTML provides a raw HTML page of 100 search engine results for the specified keyword, search engine, and location."
      operationId: GoogleAiModeLiveHtml
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleAiModeLiveHtmlRequestInfo'
                nullable: true
              example:
                - language_code: en
                  location_code: 2840
                  keyword: albert einstein
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleAiModeLiveHtmlResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/serp/google/maps/task_post:
    post:
      tags:
        - Serp
      description: "‌‌\nSERP API provides top 100 search engine results. These results are specific to the selected location (see the List of Locations) and language (see the List of Languages) settings."
      operationId: GoogleMapsTaskPost
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleMapsTaskPostRequestInfo'
                nullable: true
              example:
                - language_code: en
                  location_code: 2840
                  keyword: albert einstein
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleMapsTaskPostResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/serp/google/maps/tasks_ready:
    get:
      tags:
        - Serp
      description: "‌\nThe ‘Tasks Ready’ endpoint is designed to provide you with the list of completed tasks, which haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed tasks using this endpoint. Then, you can collect the results using the ‘Task GET’ endpoint.\nLearn more about task completion and obtaining a list of completed tasks in this help center article."
      operationId: GoogleMapsTasksReady
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleMapsTasksReadyResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/serp/google/maps/tasks_fixed:
    get:
      tags:
        - Serp
      description: "‌\nThe ‘Tasks Fixed’ endpoint is designed to provide you with the list of re-parsed tasks, which haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed re-parsed tasks using this endpoint. Then, you can re-collect the fixed results using the ‘Task GET’ endpoint."
      operationId: GoogleMapsTasksFixed
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleMapsTasksFixedResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  '/v3/serp/google/maps/task_get/advanced/{id}':
    get:
      tags:
        - Serp
      description: 'Description of the fields for sending a request:'
      operationId: GoogleMapsTaskGetAdvanced
      parameters:
        - name: id
          in: path
          description: <em>task identifier</em><br><a href="https://en.wikipedia.org/wiki/Universally_unique_identifier">a universally unique identifier (UUID)</a><br><strong>unique task identifier in our system</strong><br>you will be able to use it within <strong>30 days</strong> to request the results of the task at any time
          required: true
          schema:
            type: string
          example: 00000000-0000-0000-0000-000000000000
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleMapsTaskGetAdvancedResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/serp/google/maps/live/advanced:
    post:
      tags:
        - Serp
      description: "‌‌\nLive Google Maps SERP provides real-time data on top 100 search engine results for the specified keyword, search engine, and location."
      operationId: GoogleMapsLiveAdvanced
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleMapsLiveAdvancedRequestInfo'
                nullable: true
              example:
                - language_code: en
                  location_code: 2840
                  keyword: albert einstein
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleMapsLiveAdvancedResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/serp/google/local_finder/task_post:
    post:
      tags:
        - Serp
      description: "‌‌\nGoogle Local Finder SERP API provides top search engine results specific to the selected location (see the List of Locations) and language (see the List of Languages) settings."
      operationId: GoogleLocalFinderTaskPost
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleLocalFinderTaskPostRequestInfo'
                nullable: true
              example:
                - language_code: en
                  location_code: 2840
                  keyword: local nail services
                  min_rating: 4.5
                  time_filter: monday
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleLocalFinderTaskPostResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/serp/google/local_finder/tasks_ready:
    get:
      tags:
        - Serp
      description: "‌\nThe ‘Tasks Ready’ endpoint is designed to provide you with the list of completed tasks, which haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed tasks using this endpoint. Then, you can collect the results using the ‘Task GET’ endpoint.\nLearn more about task completion and obtaining a list of completed tasks in this help center article."
      operationId: GoogleLocalFinderTasksReady
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleLocalFinderTasksReadyResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/serp/google/local_finder/tasks_fixed:
    get:
      tags:
        - Serp
      description: "‌\nThe ‘Tasks Fixed’ endpoint is designed to provide you with the list of re-parsed tasks, which haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed re-parsed tasks using this endpoint. Then, you can re-collect the fixed results using the ‘Task GET’ endpoint."
      operationId: GoogleLocalFinderTasksFixed
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleLocalFinderTasksFixedResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  '/v3/serp/google/local_finder/task_get/advanced/{id}':
    get:
      tags:
        - Serp
      description: 'Description of the fields for sending a request:'
      operationId: GoogleLocalFinderTaskGetAdvanced
      parameters:
        - name: id
          in: path
          description: <em>task identifier</em><br><a href="https://en.wikipedia.org/wiki/Universally_unique_identifier">a universally unique identifier (UUID)</a><br><strong>unique task identifier in our system</strong><br>you will be able to use it within <strong>30 days</strong> to request the results of the task at any time
          required: true
          schema:
            type: string
          example: 00000000-0000-0000-0000-000000000000
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleLocalFinderTaskGetAdvancedResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  '/v3/serp/google/local_finder/task_get/html/{id}':
    get:
      tags:
        - Serp
      description: 'Description of the fields for sending a request:'
      operationId: GoogleLocalFinderTaskGetHtml
      parameters:
        - name: id
          in: path
          description: <em>task identifier</em><br><strong>unique task identifier in our system in the <a href="https://en.wikipedia.org/wiki/Universally_unique_identifier">UUID</a> format</strong><br>you will be able to use it within <strong>7 days</strong> to request the results of the task at any time
          required: true
          schema:
            type: string
          example: 00000000-0000-0000-0000-000000000000
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleLocalFinderTaskGetHtmlResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/serp/google/local_finder/live/advanced:
    post:
      tags:
        - Serp
      description: "‌‌\nLive Google Local_finder SERP provides real-time search engine results for the specified keyword and location."
      operationId: GoogleLocalFinderLiveAdvanced
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleLocalFinderLiveAdvancedRequestInfo'
                nullable: true
              example:
                - language_code: en
                  location_code: 2840
                  keyword: local nail services
                  min_rating: 4.5
                  time_filter: monday
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleLocalFinderLiveAdvancedResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/serp/google/local_finder/live/html:
    post:
      tags:
        - Serp
      description: "‌\nLive Google Local Finder SERP HTML provides a raw HTML page of the search engine results for the specified keyword, search engine, and location."
      operationId: GoogleLocalFinderLiveHtml
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleLocalFinderLiveHtmlRequestInfo'
                nullable: true
              example:
                - language_code: en
                  location_code: 2840
                  keyword: albert einstein
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleLocalFinderLiveHtmlResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/serp/google/news/task_post:
    post:
      tags:
        - Serp
      description: "‌‌\nSERP API provides top search engine results. These results are specific to the selected location (see the List of Locations) and language (see the List of Languages) settings."
      operationId: GoogleNewsTaskPost
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleNewsTaskPostRequestInfo'
                nullable: true
              example:
                - language_code: en
                  location_code: 2840
                  keyword: albert einstein
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleNewsTaskPostResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/serp/google/news/tasks_ready:
    get:
      tags:
        - Serp
      description: "‌\nThe ‘Tasks Ready’ endpoint is designed to provide you with the list of completed tasks, which haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed tasks using this endpoint. Then, you can collect the results using the ‘Task GET’ endpoint.\nLearn more about task completion and obtaining a list of completed tasks in this help center article."
      operationId: GoogleNewsTasksReady
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleNewsTasksReadyResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/serp/google/news/tasks_fixed:
    get:
      tags:
        - Serp
      description: "‌\nThe ‘Tasks Fixed’ endpoint is designed to provide you with the list of re-parsed tasks, which haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed re-parsed tasks using this endpoint. Then, you can re-collect the fixed results using the ‘Task GET’ endpoint."
      operationId: GoogleNewsTasksFixed
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleNewsTasksFixedResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  '/v3/serp/google/news/task_get/advanced/{id}':
    get:
      tags:
        - Serp
      description: 'Description of the fields for sending a request:'
      operationId: GoogleNewsTaskGetAdvanced
      parameters:
        - name: id
          in: path
          description: <em>task identifier</em><br><strong>unique task identifier in our system in the <a href="https://en.wikipedia.org/wiki/Universally_unique_identifier">UUID</a> format</strong><br>you will be able to use it within <strong>30 days</strong> to request the results of the task at any time
          required: true
          schema:
            type: string
          example: 00000000-0000-0000-0000-000000000000
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleNewsTaskGetAdvancedResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  '/v3/serp/google/news/task_get/html/{id}':
    get:
      tags:
        - Serp
      description: 'Description of the fields for sending a request:'
      operationId: GoogleNewsTaskGetHtml
      parameters:
        - name: id
          in: path
          description: <em>task identifier</em><br><strong>unique task identifier in our system in the <a href="https://en.wikipedia.org/wiki/Universally_unique_identifier">UUID</a> format</strong><br>you will be able to use it within <strong>7 days</strong> to request the results of the task at any time
          required: true
          schema:
            type: string
          example: 00000000-0000-0000-0000-000000000000
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleNewsTaskGetHtmlResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/serp/google/news/live/advanced:
    post:
      tags:
        - Serp
      description: "‌‌\nLive Google News SERP provides real-time data on top search engine results for the specified keyword, search engine, and location."
      operationId: GoogleNewsLiveAdvanced
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleNewsLiveAdvancedRequestInfo'
                nullable: true
              example:
                - language_code: en
                  location_code: 2840
                  keyword: android
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleNewsLiveAdvancedResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/serp/google/news/live/html:
    post:
      tags:
        - Serp
      description: "‌\nLive SERP HTML provides a raw HTML page of 10 search engine results for the specified keyword, search engine, and location."
      operationId: GoogleNewsLiveHtml
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleNewsLiveHtmlRequestInfo'
                nullable: true
              example:
                - language_code: en
                  location_code: 2840
                  keyword: albert einstein
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleNewsLiveHtmlResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/serp/google/images/task_post:
    post:
      tags:
        - Serp
      description: "‌‌\nSERP API provides top 100 search engine results. These results are specific to the selected location (see the List of Locations) and language (see the List of Languages) settings."
      operationId: GoogleImagesTaskPost
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleImagesTaskPostRequestInfo'
                nullable: true
              example:
                - language_code: en
                  location_code: 2840
                  keyword: albert einstein
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleImagesTaskPostResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/serp/google/images/tasks_ready:
    get:
      tags:
        - Serp
      description: "‌\nThe ‘Tasks Ready’ endpoint is designed to provide you with the list of completed tasks, which haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed tasks using this endpoint. Then, you can collect the results using the ‘Task GET’ endpoint.\nLearn more about task completion and obtaining a list of completed tasks in this help center article."
      operationId: GoogleImagesTasksReady
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleImagesTasksReadyResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/serp/google/images/tasks_fixed:
    get:
      tags:
        - Serp
      description: "‌\nThe ‘Tasks Fixed’ endpoint is designed to provide you with the list of re-parsed tasks, which haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed re-parsed tasks using this endpoint. Then, you can re-collect the fixed results using the ‘Task GET’ endpoint."
      operationId: GoogleImagesTasksFixed
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleImagesTasksFixedResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  '/v3/serp/google/images/task_get/advanced/{id}':
    get:
      tags:
        - Serp
      description: 'Description of the fields for sending a request:'
      operationId: GoogleImagesTaskGetAdvanced
      parameters:
        - name: id
          in: path
          description: <em>task identifier</em><br><strong>unique task identifier in our system in the <a href="https://en.wikipedia.org/wiki/Universally_unique_identifier">UUID</a> format</strong><br>you will be able to use it within <strong>30 days</strong> to request the results of the task at any time
          required: true
          schema:
            type: string
          example: 00000000-0000-0000-0000-000000000000
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleImagesTaskGetAdvancedResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  '/v3/serp/google/images/task_get/html/{id}':
    get:
      tags:
        - Serp
      description: 'Description of the fields for sending a request:'
      operationId: GoogleImagesTaskGetHtml
      parameters:
        - name: id
          in: path
          description: <em>task identifier</em><br><strong>unique task identifier in our system in the <a href="https://en.wikipedia.org/wiki/Universally_unique_identifier">UUID</a> format</strong><br>you will be able to use it within <strong>7 days</strong> to request the results of the task at any time
          required: true
          schema:
            type: string
          example: 00000000-0000-0000-0000-000000000000
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleImagesTaskGetHtmlResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/serp/google/images/live/advanced:
    post:
      tags:
        - Serp
      description: "‌\nLive Google Images SERP provides real-time data on top 100 images results for the specified keyword, search engine, and location."
      operationId: GoogleImagesLiveAdvanced
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleImagesLiveAdvancedRequestInfo'
                nullable: true
              example:
                - language_code: en
                  location_code: 2840
                  keyword: albert einstein
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleImagesLiveAdvancedResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/serp/google/images/live/html:
    post:
      tags:
        - Serp
      description: "‌\nLive SERP HTML provides a raw HTML page of 100 search engine results for the specified keyword, search engine, and location."
      operationId: GoogleImagesLiveHtml
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleImagesLiveHtmlRequestInfo'
                nullable: true
              example:
                - language_code: en
                  location_code: 2840
                  keyword: albert einstein
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleImagesLiveHtmlResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/serp/google/search_by_image/task_post:
    post:
      tags:
        - Serp
      description: "‌‌\nGoogle Search By Image SERP API provides up to top 100 search engine results based on the image you specified. These results are specific to the selected location (see the List of Locations) and language (see the List of Languages) settings."
      operationId: GoogleSearchByImageTaskPost
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleSearchByImageTaskPostRequestInfo'
                nullable: true
              example:
                - language_code: en
                  location_code: 2840
                  image_url: https://dataforseo.com/wp-content/uploads/2016/11/data_for_seo_light_429.png
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleSearchByImageTaskPostResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/serp/google/search_by_image/tasks_ready:
    get:
      tags:
        - Serp
      description: "‌\nThe ‘Tasks Ready’ endpoint is designed to provide you with the list of completed tasks, which haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed tasks using this endpoint. Then, you can collect the results using the ‘Task GET’ endpoint."
      operationId: GoogleSearchByImageTasksReady
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleSearchByImageTasksReadyResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/serp/google/search_by_image/tasks_fixed:
    get:
      tags:
        - Serp
      description: "‌\nThe ‘Tasks Fixed’ endpoint is designed to provide you with the list of re-parsed tasks, which haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed re-parsed tasks using this endpoint. Then, you can re-collect the fixed results using the ‘Task GET’ endpoint."
      operationId: GoogleSearchByImageTasksFixed
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleSearchByImageTasksFixedResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  '/v3/serp/google/search_by_image/task_get/advanced/{id}':
    get:
      tags:
        - Serp
      description: 'Description of the fields for sending a request:'
      operationId: GoogleSearchByImageTaskGetAdvanced
      parameters:
        - name: id
          in: path
          description: <em>task identifier</em><br><strong>unique task identifier in our system in the <a href="https://en.wikipedia.org/wiki/Universally_unique_identifier">UUID</a> format</strong><br>you will be able to use it within <strong>30 days</strong> to request the results of the task at any time
          required: true
          schema:
            type: string
          example: 00000000-0000-0000-0000-000000000000
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleSearchByImageTaskGetAdvancedResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/serp/google/jobs/task_post:
    post:
      tags:
        - Serp
      description: "‌‌\nThis endpoint will provide you with SERP data from the Google Jobs search engine. The returned results are specific to the keyword as well as the language and location parameters of the POST request."
      operationId: GoogleJobsTaskPost
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleJobsTaskPostRequestInfo'
                nullable: true
              example:
                - language_code: en
                  location_code: 2840
                  keyword: .net developer
                - language_name: English
                  location_name: United States
                  keyword: .net developer
                  tag: some_string_123
                  pingback_url: https://your-server.com/pingscript?id=$id&tag=$tag
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleJobsTaskPostResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/serp/google/jobs/tasks_ready:
    get:
      tags:
        - Serp
      description: "‌\nThe ‘Tasks Ready’ endpoint is designed to provide you with the list of completed tasks, which haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed tasks using this endpoint. Then, you can collect the results using the ‘Task GET’ endpoint.\nLearn more about task completion and obtaining a list of completed tasks in this help center article."
      operationId: GoogleJobsTasksReady
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleJobsTasksReadyResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/serp/google/jobs/tasks_fixed:
    get:
      tags:
        - Serp
      description: "‌\nThe ‘Tasks Fixed’ endpoint is designed to provide you with the list of re-parsed tasks, which haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed re-parsed tasks using this endpoint. Then, you can re-collect the fixed results using the ‘Task GET’ endpoint."
      operationId: GoogleJobsTasksFixed
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleJobsTasksFixedResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  '/v3/serp/google/jobs/task_get/advanced/{id}':
    get:
      tags:
        - Serp
      description: 'Description of the fields for sending a request:'
      operationId: GoogleJobsTaskGetAdvanced
      parameters:
        - name: id
          in: path
          description: <em>task identifier</em><br><strong>unique task identifier in our system in the <a href="https://en.wikipedia.org/wiki/Universally_unique_identifier">UUID</a> format</strong><br>you will be able to use it within <strong>30 days</strong> to request the results of the task at any time
          required: true
          schema:
            type: string
          example: 00000000-0000-0000-0000-000000000000
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleJobsTaskGetAdvancedResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  '/v3/serp/google/jobs/task_get/html/{id}':
    get:
      tags:
        - Serp
      description: 'Description of the fields for sending a request:'
      operationId: GoogleJobsTaskGetHtml
      parameters:
        - name: id
          in: path
          description: <em>task identifier</em><br><strong>unique task identifier in our system in the <a href="https://en.wikipedia.org/wiki/Universally_unique_identifier">UUID</a> format</strong><br>you will be able to use it within <strong>7 days</strong> to request the results of the task at any time
          required: true
          schema:
            type: string
          example: 00000000-0000-0000-0000-000000000000
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleJobsTaskGetHtmlResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/serp/google/autocomplete/task_post:
    post:
      tags:
        - Serp
      description: "‌‌\nGoogle Autocomplete is a feature within Google Search that improves the search experience by allowing users to complete searches they started to type. DataForSEO SERP API will provide you with all the suggestions Google Autocomplete offers for a particular keyword, the position of the cursor pointer, and the search client."
      operationId: GoogleAutocompleteTaskPost
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleAutocompleteTaskPostRequestInfo'
                nullable: true
              example:
                - language_code: en
                  location_code: 2840
                  keyword: albert einstein
                  cursor_pointer: 6
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleAutocompleteTaskPostResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/serp/google/autocomplete/tasks_ready:
    get:
      tags:
        - Serp
      description: "‌\nThe ‘Tasks Ready’ endpoint is designed to provide you with the list of completed tasks, which haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed tasks using this endpoint. Then, you can collect the results using the ‘Task GET’ endpoint.\nLearn more about task completion and obtaining a list of completed tasks in this help center article."
      operationId: GoogleAutocompleteTasksReady
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleAutocompleteTasksReadyResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/serp/google/autocomplete/tasks_fixed:
    get:
      tags:
        - Serp
      description: "‌\nThe ‘Tasks Fixed’ endpoint is designed to provide you with the list of re-parsed tasks, which haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed re-parsed tasks using this endpoint. Then, you can re-collect the fixed results using the ‘Task GET’ endpoint."
      operationId: GoogleAutocompleteTasksFixed
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleAutocompleteTasksFixedResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  '/v3/serp/google/autocomplete/task_get/advanced/{id}':
    get:
      tags:
        - Serp
      description: 'Description of the fields for sending a request:'
      operationId: GoogleAutocompleteTaskGetAdvanced
      parameters:
        - name: id
          in: path
          description: <em>task identifier</em><br><strong>unique task identifier in our system in the <a href="https://en.wikipedia.org/wiki/Universally_unique_identifier">UUID</a> format</strong><br>you will be able to use it within <strong>30 days</strong> to request the results of the task at any time
          required: true
          schema:
            type: string
          example: 00000000-0000-0000-0000-000000000000
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleAutocompleteTaskGetAdvancedResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/serp/google/autocomplete/live/advanced:
    post:
      tags:
        - Serp
      description: "‌‌\nGoogle Autocomplete is a feature within Google Search that improves the search experience by allowing users to complete searches they started to type. DataForSEO SERP API will provide you with all the suggestions Google Autocomplete offers for a particular keyword, the position of the cursor pointer, and the search client."
      operationId: GoogleAutocompleteLiveAdvanced
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleAutocompleteLiveAdvancedRequestInfo'
                nullable: true
              example:
                - language_code: en
                  location_code: 2840
                  keyword: albert einstein
                  client: gws-wiz-serp
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleAutocompleteLiveAdvancedResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/serp/google/dataset_search/task_post:
    post:
      tags:
        - Serp
      description: "‌‌\nGoogle Dataset Search API provides top 20 Google Dataset search engine results. These results are specific to the indicated keyword. You can specify other parameters optionally."
      operationId: GoogleDatasetSearchTaskPost
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleDatasetSearchTaskPostRequestInfo'
                nullable: true
              example:
                - keyword: water quality
                  last_updated: 1m
                  file_formats:
                    - archive
                    - image
                  usage_rights: noncommercial
                  is_free: true
                  topics:
                    - natural_sciences
                    - geo
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleDatasetSearchTaskPostResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/serp/google/dataset_search/tasks_ready:
    get:
      tags:
        - Serp
      description: "‌\nThe ‘Tasks Ready’ endpoint is designed to provide you with the list of completed tasks, which haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed tasks using this endpoint. Then, you can collect the results using the ‘Task GET’ endpoint.\nLearn more about task completion and obtaining a list of completed tasks in this help center article."
      operationId: GoogleDatasetSearchTasksReady
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleDatasetSearchTasksReadyResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/serp/google/dataset_search/tasks_fixed:
    get:
      tags:
        - Serp
      description: "‌\nThe ‘Tasks Fixed’ endpoint is designed to provide you with the list of re-parsed tasks, which haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed re-parsed tasks using this endpoint. Then, you can re-collect the fixed results using the ‘Task GET’ endpoint."
      operationId: GoogleDatasetSearchTasksFixed
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleDatasetSearchTasksFixedResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  '/v3/serp/google/dataset_search/task_get/advanced/{id}':
    get:
      tags:
        - Serp
      description: 'Description of the fields for sending a request:'
      operationId: GoogleDatasetSearchTaskGetAdvanced
      parameters:
        - name: id
          in: path
          description: <em>task identifier</em><br><strong>unique task identifier in our system in the <a href="https://en.wikipedia.org/wiki/Universally_unique_identifier">UUID</a> format</strong><br>you will be able to use it within <strong>30 days</strong> to request the results of the task at any time
          required: true
          schema:
            type: string
          example: 00000000-0000-0000-0000-000000000000
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleDatasetSearchTaskGetAdvancedResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/serp/google/dataset_search/live/advanced:
    post:
      tags:
        - Serp
      description: "‌\nLive Google Dataset Search provides real-time data on the top 20 Google Dataset search engine results. These results are specific to the indicated keyword. You can specify other parameters optionally."
      operationId: GoogleDatasetSearchLiveAdvanced
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleDatasetSearchLiveAdvancedRequestInfo'
                nullable: true
              example:
                - keyword: water quality
                  last_updated: 1m
                  file_formats:
                    - archive
                    - image
                  usage_rights: noncommercial
                  is_free: true
                  topics:
                    - natural_sciences
                    - geo
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleDatasetSearchLiveAdvancedResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/serp/google/dataset_info/task_post:
    post:
      tags:
        - Serp
      description: "‌‌\nGoogle Dataset Info API provides detailed information about the dataset you specify in the POST request. You will get data from a page of the dataset displayed separately from the SERP. It contains information about dataset content, authors, licenses, and description on the SERP."
      operationId: GoogleDatasetInfoTaskPost
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleDatasetInfoTaskPostRequestInfo'
                nullable: true
              example:
                - dataset_id: L2cvMTFqbl85ZHN6MQ==
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleDatasetInfoTaskPostResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/serp/google/dataset_info/tasks_ready:
    get:
      tags:
        - Serp
      description: "‌\nThe ‘Tasks Ready’ endpoint is designed to provide you with the list of completed tasks, which haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed tasks using this endpoint. Then, you can collect the results using the ‘Task GET’ endpoint.\nLearn more about task completion and obtaining a list of completed tasks in this help center article."
      operationId: GoogleDatasetInfoTasksReady
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleDatasetInfoTasksReadyResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/serp/google/dataset_info/tasks_fixed:
    get:
      tags:
        - Serp
      description: "‌\nThe ‘Tasks Fixed’ endpoint is designed to provide you with the list of re-parsed tasks, which haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed re-parsed tasks using this endpoint. Then, you can re-collect the fixed results using the ‘Task GET’ endpoint."
      operationId: GoogleDatasetInfoTasksFixed
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleDatasetInfoTasksFixedResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  '/v3/serp/google/dataset_info/task_get/advanced/{id}':
    get:
      tags:
        - Serp
      description: 'Description of the fields for sending a request:'
      operationId: GoogleDatasetInfoTaskGetAdvanced
      parameters:
        - name: id
          in: path
          description: <em>task identifier</em><br><strong>unique task identifier in our system in the <a href="https://en.wikipedia.org/wiki/Universally_unique_identifier">UUID</a> format</strong><br>you will be able to use it within <strong>30 days</strong> to request the results of the task at any time
          required: true
          schema:
            type: string
          example: 00000000-0000-0000-0000-000000000000
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleDatasetInfoTaskGetAdvancedResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/serp/google/dataset_info/live/advanced:
    post:
      tags:
        - Serp
      description: "‌\nLive Google Dataset Info provides real-time data on the dataset you specify in the request. You will get data from a page of the dataset displayed separately from the SERP. It contains information about dataset content, authors, licenses, and description on the SERP."
      operationId: GoogleDatasetInfoLiveAdvanced
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleDatasetInfoLiveAdvancedRequestInfo'
                nullable: true
              example:
                - dataset_id: L2cvMTFqbl85ZHN6MQ==
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleDatasetInfoLiveAdvancedResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/serp/google/ads_advertisers/locations:
    get:
      tags:
        - Serp
      description: "‌\n‌‌As a response of the API server, you will receive JSON-encoded data containing a tasks array with the information specific to the set tasks."
      operationId: GoogleAdsAdvertisersLocations
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleAdsAdvertisersLocationsResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/serp/google/ads_advertisers/task_post:
    post:
      tags:
        - Serp
      description: Google Ads Advertisers provides information on advertisers that run campaigns on Google Ads based on the Ads Transparency platform. ‌‌
      operationId: GoogleAdsAdvertisersTaskPost
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleAdsAdvertisersTaskPostRequestInfo'
                nullable: true
              example:
                - location_code: 2840
                  keyword: apple
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleAdsAdvertisersTaskPostResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/serp/google/ads_advertisers/tasks_ready:
    get:
      tags:
        - Serp
      description: "‌\nThe ‘Tasks Ready’ endpoint is designed to provide you with the list of completed tasks, which haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed tasks using this endpoint. Then, you can collect the results using the ‘Task GET’ endpoint.\nLearn more about task completion and obtaining a list of completed tasks in this help center article."
      operationId: GoogleAdsAdvertisersTasksReady
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleAdsAdvertisersTasksReadyResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  '/v3/serp/google/ads_advertisers/task_get/advanced/{id}':
    get:
      tags:
        - Serp
      description: 'Description of the fields for sending a request:'
      operationId: GoogleAdsAdvertisersTaskGetAdvanced
      parameters:
        - name: id
          in: path
          description: <em>task identifier</em><br><strong>unique task identifier in our system in the <a href="https://en.wikipedia.org/wiki/Universally_unique_identifier">UUID</a> format</strong><br>you will be able to use it within <strong>30 days</strong> to request the results of the task at any time
          required: true
          schema:
            type: string
          example: 00000000-0000-0000-0000-000000000000
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleAdsAdvertisersTaskGetAdvancedResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/serp/google/ads_search/locations:
    get:
      tags:
        - Serp
      description: ''
      operationId: GoogleAdsSearchLocations
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleAdsSearchLocationsResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/serp/google/ads_search/task_post:
    post:
      tags:
        - Serp
      description: Google Ads Search provides information on ads that are run by advertisers on Google Ads. Information is based on the Ads Transparency platform and adapted for the convenience of DataForSEO users. ‌‌
      operationId: GoogleAdsSearchTaskPost
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleAdsSearchTaskPostRequestInfo'
                nullable: true
              example:
                - location_code: 2840
                  platform: google_search
                  advertiser_ids:
                    - AR13752565271262920705
                    - AR02439908557932462081
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleAdsSearchTaskPostResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/serp/google/ads_search/tasks_ready:
    get:
      tags:
        - Serp
      description: "‌\nThe ‘Tasks Ready’ endpoint is designed to provide you with the list of completed tasks, which haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed tasks using this endpoint. Then, you can collect the results using the ‘Task GET’ endpoint.\nLearn more about task completion and obtaining a list of completed tasks in this help center article."
      operationId: GoogleAdsSearchTasksReady
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleAdsSearchTasksReadyResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  '/v3/serp/google/ads_search/task_get/advanced/{id}':
    get:
      tags:
        - Serp
      description: 'Description of the fields for sending a request:'
      operationId: GoogleAdsSearchTaskGetAdvanced
      parameters:
        - name: id
          in: path
          description: <em>task identifier</em><br><strong>unique task identifier in our system in the <a href="https://en.wikipedia.org/wiki/Universally_unique_identifier">UUID</a> format</strong><br>you will be able to use it within <strong>30 days</strong> to request the results of the task at any time
          required: true
          schema:
            type: string
          example: 00000000-0000-0000-0000-000000000000
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleAdsSearchTaskGetAdvancedResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/serp/bing/locations:
    get:
      tags:
        - Serp
      description: You will receive the list of locations by this API call. You can filter the list of locations by country when setting a task.
      operationId: BingLocations
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpBingLocationsResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  '/v3/serp/bing/locations/{country}':
    get:
      tags:
        - Serp
      description: You will receive the list of locations by this API call. You can filter the list of locations by country when setting a task.
      operationId: BingLocationsCountry
      parameters:
        - name: country
          in: path
          description: <em>country ISO code</em><br>optional field<br>specify the ISO code if you want to filter the list of locations by country<br>example:<br><code>us</code>
          required: true
          schema:
            type: string
          example: us
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpBingLocationsCountryResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/serp/bing/languages:
    get:
      tags:
        - Serp
      description: You will receive the list of languages by calling this API.
      operationId: BingLanguages
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpBingLanguagesResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/serp/bing/organic/task_post:
    post:
      tags:
        - Serp
      description: SERP API provides search engine results. These results are specific to the selected location (see the List of Locations) and language (see the List of Languages) settings.
      operationId: BingOrganicTaskPost
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpBingOrganicTaskPostRequestInfo'
                nullable: true
              example:
                - language_code: en
                  location_code: 2840
                  keyword: albert einstein
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpBingOrganicTaskPostResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/serp/bing/organic/tasks_ready:
    get:
      tags:
        - Serp
      description: "‌\nThe ‘Tasks Ready’ endpoint is designed to provide you with the list of completed tasks, which haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed tasks using this endpoint. Then, you can collect the results using the ‘Task GET’ endpoint.\nLearn more about task completion and obtaining a list of completed tasks in this help center article."
      operationId: BingOrganicTasksReady
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpBingOrganicTasksReadyResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/serp/bing/organic/tasks_fixed:
    get:
      tags:
        - Serp
      description: "‌\nThe ‘Tasks Fixed’ endpoint is designed to provide you with the list of re-parsed tasks, which haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed re-parsed tasks using this endpoint. Then, you can re-collect the fixed results using the ‘Task GET’ endpoint."
      operationId: BingOrganicTasksFixed
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpBingOrganicTasksFixedResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  '/v3/serp/bing/organic/task_get/regular/{id}':
    get:
      tags:
        - Serp
      description: 'Description of the fields for sending a request:'
      operationId: BingOrganicTaskGetRegular
      parameters:
        - name: id
          in: path
          description: <em>task identifier</em><br><strong>unique task identifier in our system in the <a href="https://en.wikipedia.org/wiki/Universally_unique_identifier">UUID</a> format</strong><br>you will be able to use it within <strong>30 days</strong> to request the results of the task at any time
          required: true
          schema:
            type: string
          example: 00000000-0000-0000-0000-000000000000
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpBingOrganicTaskGetRegularResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  '/v3/serp/bing/organic/task_get/advanced/{id}':
    get:
      tags:
        - Serp
      description: 'Description of the fields for sending a request:'
      operationId: BingOrganicTaskGetAdvanced
      parameters:
        - name: id
          in: path
          description: <em>task identifier</em><br><strong>unique task identifier in our system in the <a href="https://en.wikipedia.org/wiki/Universally_unique_identifier">UUID</a> format</strong><br>you will be able to use it within <strong>30 days</strong> to request the results of the task at any time
          required: true
          schema:
            type: string
          example: 00000000-0000-0000-0000-000000000000
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpBingOrganicTaskGetAdvancedResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  '/v3/serp/bing/organic/task_get/html/{id}':
    get:
      tags:
        - Serp
      description: 'Description of the fields for sending a request:'
      operationId: BingOrganicTaskGetHtml
      parameters:
        - name: id
          in: path
          description: <em>task identifier</em><br><strong>unique task identifier in our system in the <a href="https://en.wikipedia.org/wiki/Universally_unique_identifier">UUID</a> format</strong><br>you will be able to use it within <strong>7 days</strong> to request the results of the task at any time
          required: true
          schema:
            type: string
          example: 00000000-0000-0000-0000-000000000000
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpBingOrganicTaskGetHtmlResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/serp/bing/organic/live/regular:
    post:
      tags:
        - Serp
      description: 'Live SERP provides real-time data on search engine results for the specified keyword, search engine, and location.'
      operationId: BingOrganicLiveRegular
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpBingOrganicLiveRegularRequestInfo'
                nullable: true
              example:
                - language_code: en
                  location_code: 2840
                  keyword: albert einstein
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpBingOrganicLiveRegularResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/serp/bing/organic/live/advanced:
    post:
      tags:
        - Serp
      description: 'Live SERP provides real-time data on top 100 search engine results for the specified keyword, search engine, and location. This endpoint will supply a complete overview of featured snippets and other extra elements of SERPs.'
      operationId: BingOrganicLiveAdvanced
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpBingOrganicLiveAdvancedRequestInfo'
                nullable: true
              example:
                - language_code: en
                  location_code: 2840
                  keyword: flight ticket new york san francisco
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpBingOrganicLiveAdvancedResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/serp/bing/organic/live/html:
    post:
      tags:
        - Serp
      description: 'Live SERP HTML provides a raw HTML page of search engine results for the specified keyword, search engine, and location.'
      operationId: BingOrganicLiveHtml
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpBingOrganicLiveHtmlRequestInfo'
                nullable: true
              example:
                - language_code: en
                  location_code: 2840
                  keyword: albert einstein
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpBingOrganicLiveHtmlResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/serp/youtube/locations:
    get:
      tags:
        - Serp
      description: You will receive the list of locations by this API call. You can filter the list of locations by country when setting a task.
      operationId: YoutubeLocations
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpYoutubeLocationsResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  '/v3/serp/youtube/locations/{country}':
    get:
      tags:
        - Serp
      description: You will receive the list of locations by this API call. You can filter the list of locations by country when setting a task.
      operationId: YoutubeLocationsCountry
      parameters:
        - name: country
          in: path
          description: <em>country ISO code</em><br>optional field<br>specify the ISO code if you want to filter the list of locations by country<br>example:<br><code>us</code>
          required: true
          schema:
            type: string
          example: us
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpYoutubeLocationsCountryResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/serp/youtube/languages:
    get:
      tags:
        - Serp
      description: You will receive the list of languages by calling this API.
      operationId: YoutubeLanguages
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpYoutubeLanguagesResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/serp/youtube/video_info/task_post:
    post:
      tags:
        - Serp
      description: "YouTube Video Info API provides detailed information about the video you specify in the POST request. You will get data from the watching page containing key video and content metrics as well as the channel where the video is published.\nfor more info please visit 'https://docs.dataforseo.com/v3/serp/youtube/video_info/task_post/?bash'"
      operationId: YoutubeVideoInfoTaskPost
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpYoutubeVideoInfoTaskPostRequestInfo'
                nullable: true
              example:
                - language_code: en
                  location_code: 2840
                  video_id: vQXvyV0zIP4
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpYoutubeVideoInfoTaskPostResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/serp/youtube/video_info/tasks_ready:
    get:
      tags:
        - Serp
      description: "‌\nThe ‘Tasks Ready’ endpoint is designed to provide you with the list of completed tasks, which haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed tasks using this endpoint. Then, you can collect the results using the ‘Task GET’ endpoint.\nLearn more about task completion and obtaining a list of completed tasks in this help center article."
      operationId: YoutubeVideoInfoTasksReady
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpYoutubeVideoInfoTasksReadyResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/serp/youtube/video_info/tasks_fixed:
    get:
      tags:
        - Serp
      description: "‌\nThe ‘Tasks Fixed’ endpoint is designed to provide you with the list of re-parsed tasks, which haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed re-parsed tasks using this endpoint. Then, you can re-collect the fixed results using the ‘Task GET’ endpoint."
      operationId: YoutubeVideoInfoTasksFixed
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpYoutubeVideoInfoTasksFixedResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  '/v3/serp/youtube/video_info/task_get/advanced/{id}':
    get:
      tags:
        - Serp
      description: 'Description of the fields for sending a request:'
      operationId: YoutubeVideoInfoTaskGetAdvanced
      parameters:
        - name: id
          in: path
          description: <em>task identifier</em><br><strong>unique task identifier in our system in the <a href="https://en.wikipedia.org/wiki/Universally_unique_identifier">UUID</a> format</strong><br>you will be able to use it within <strong>30 days</strong> to request the results of the task at any time
          required: true
          schema:
            type: string
          example: 00000000-0000-0000-0000-000000000000
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpYoutubeVideoInfoTaskGetAdvancedResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/serp/youtube/video_info/live/advanced:
    post:
      tags:
        - Serp
      description: "Live YouTube Video Info provides real-time data on the video you specify in the request. You will get data from the watching page containing key video and content metrics as well as the channel where the video is published.\nfor more info please visit 'https://docs.dataforseo.com/v3/serp/youtube/video_info/live/advanced/?bash'"
      operationId: YoutubeVideoInfoLiveAdvanced
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpYoutubeVideoInfoLiveAdvancedRequestInfo'
                nullable: true
              example:
                - language_code: en
                  location_code: 2840
                  video_id: vQXvyV0zIP4
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpYoutubeVideoInfoLiveAdvancedResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/serp/youtube/organic/task_post:
    post:
      tags:
        - Serp
      description: "YouTube Organic API provides the top 20 blocks of search engine results. These results are specific to the selected location (see the List of Locations) and language (see the List of Languages) settings.\nfor more info please visit 'https://docs.dataforseo.com/v3/serp/youtube/organic/task_post/'"
      operationId: YoutubeOrganicTaskPost
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpYoutubeOrganicTaskPostRequestInfo'
                nullable: true
              example:
                - language_code: en
                  location_code: 2840
                  keyword: audi
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpYoutubeOrganicTaskPostResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/serp/youtube/organic/tasks_ready:
    get:
      tags:
        - Serp
      description: "‌\nThe ‘Tasks Ready’ endpoint is designed to provide you with the list of completed tasks, which haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed tasks using this endpoint. Then, you can collect the results using the ‘Task GET’ endpoint.\nLearn more about task completion and obtaining a list of completed tasks in this help center article."
      operationId: YoutubeOrganicTasksReady
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpYoutubeOrganicTasksReadyResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/serp/youtube/organic/tasks_fixed:
    get:
      tags:
        - Serp
      description: "‌\nThe ‘Tasks Fixed’ endpoint is designed to provide you with the list of re-parsed tasks, which haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed re-parsed tasks using this endpoint. Then, you can re-collect the fixed results using the ‘Task GET’ endpoint."
      operationId: YoutubeOrganicTasksFixed
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpYoutubeOrganicTasksFixedResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  '/v3/serp/youtube/organic/task_get/advanced/{id}':
    get:
      tags:
        - Serp
      description: 'Description of the fields for sending a request:'
      operationId: YoutubeOrganicTaskGetAdvanced
      parameters:
        - name: id
          in: path
          description: <em>task identifier</em><br><strong>unique task identifier in our system in the <a href="https://en.wikipedia.org/wiki/Universally_unique_identifier">UUID</a> format</strong><br>you will be able to use it within <strong>30 days</strong> to request the results of the task at any time
          required: true
          schema:
            type: string
          example: 00000000-0000-0000-0000-000000000000
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpYoutubeOrganicTaskGetAdvancedResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/serp/youtube/organic/live/advanced:
    post:
      tags:
        - Serp
      description: "Live SERP provides real-time data on the top 20 blocks of YouTube search engine results. These results are specific to the selected location (see the List of Locations) and language (see the List of Languages) settings.\nfor more info please visit 'https://docs.dataforseo.com/v3/serp/youtube/organic/live/advanced/'"
      operationId: YoutubeOrganicLiveAdvanced
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpYoutubeOrganicLiveAdvancedRequestInfo'
                nullable: true
              example:
                - language_code: en
                  location_code: 2840
                  keyword: audi
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpYoutubeOrganicLiveAdvancedResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/serp/youtube/video_subtitles/task_post:
    post:
      tags:
        - Serp
      description: "YouTube Subtitles API provides data on all subtitles in the video you specify in the POST request. You will get data from the watching page containing subtitled text, its language, and duration in the video.\nfor more info please visit 'https://docs.dataforseo.com/v3/serp/youtube/video_subtitles/task_post/?bash'"
      operationId: YoutubeVideoSubtitlesTaskPost
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpYoutubeVideoSubtitlesTaskPostRequestInfo'
                nullable: true
              example:
                - language_code: en
                  location_code: 2840
                  video_id: Y8Wu4rSNJms
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpYoutubeVideoSubtitlesTaskPostResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/serp/youtube/video_subtitles/tasks_ready:
    get:
      tags:
        - Serp
      description: "‌\nThe ‘Tasks Ready’ endpoint is designed to provide you with the list of completed tasks, which haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed tasks using this endpoint. Then, you can collect the results using the ‘Task GET’ endpoint.\nLearn more about task completion and obtaining a list of completed tasks in this help center article."
      operationId: YoutubeVideoSubtitlesTasksReady
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpYoutubeVideoSubtitlesTasksReadyResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/serp/youtube/video_subtitles/tasks_fixed:
    get:
      tags:
        - Serp
      description: "‌\nThe ‘Tasks Fixed’ endpoint is designed to provide you with the list of re-parsed tasks, which haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed re-parsed tasks using this endpoint. Then, you can re-collect the fixed results using the ‘Task GET’ endpoint."
      operationId: YoutubeVideoSubtitlesTasksFixed
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpYoutubeVideoSubtitlesTasksFixedResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  '/v3/serp/youtube/video_subtitles/task_get/advanced/{id}':
    get:
      tags:
        - Serp
      description: 'Description of the fields for sending a request:'
      operationId: YoutubeVideoSubtitlesTaskGetAdvanced
      parameters:
        - name: id
          in: path
          description: <em>task identifier</em><br><strong>unique task identifier in our system in the <a href="https://en.wikipedia.org/wiki/Universally_unique_identifier">UUID</a> format</strong><br>you will be able to use it within <strong>30 days</strong> to request the results of the task at any time
          required: true
          schema:
            type: string
          example: 00000000-0000-0000-0000-000000000000
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpYoutubeVideoSubtitlesTaskGetAdvancedResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/serp/youtube/video_subtitles/live/advanced:
    post:
      tags:
        - Serp
      description: "Live YouTube Subtitles provides real-time data on subtitles in the video you specify in the request. You will get data from the watching page containing subtitled text, its language, and duration in the video.\nfor more info please visit 'https://docs.dataforseo.com/v3/serp/youtube/video_subtitles/live/advanced/?bash'"
      operationId: YoutubeVideoSubtitlesLiveAdvanced
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpYoutubeVideoSubtitlesLiveAdvancedRequestInfo'
                nullable: true
              example:
                - language_code: en
                  location_code: 2840
                  video_id: Y8Wu4rSNJms
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpYoutubeVideoSubtitlesLiveAdvancedResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/serp/youtube/video_comments/task_post:
    post:
      tags:
        - Serp
      description: "YouTube Comments API provides data on comments on the video you specify in the request. You will get the top 20 comments on the video as well as information about the author, and key comment metrics.\nfor more info please visit 'https://docs.dataforseo.com/v3/serp/youtube/video_comments/task_post/?bash'"
      operationId: YoutubeVideoCommentsTaskPost
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpYoutubeVideoCommentsTaskPostRequestInfo'
                nullable: true
              example:
                - language_code: en
                  location_code: 2840
                  video_id: vQXvyV0zIP4
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpYoutubeVideoCommentsTaskPostResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/serp/youtube/video_comments/tasks_ready:
    get:
      tags:
        - Serp
      description: "‌\nThe ‘Tasks Ready’ endpoint is designed to provide you with the list of completed tasks, which haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed tasks using this endpoint. Then, you can collect the results using the ‘Task GET’ endpoint.\nLearn more about task completion and obtaining a list of completed tasks in this help center article."
      operationId: YoutubeVideoCommentsTasksReady
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpYoutubeVideoCommentsTasksReadyResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/serp/youtube/video_comments/tasks_fixed:
    get:
      tags:
        - Serp
      description: "‌\nThe ‘Tasks Fixed’ endpoint is designed to provide you with the list of re-parsed tasks, which haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed re-parsed tasks using this endpoint. Then, you can re-collect the fixed results using the ‘Task GET’ endpoint."
      operationId: YoutubeVideoCommentsTasksFixed
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpYoutubeVideoCommentsTasksFixedResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  '/v3/serp/youtube/video_comments/task_get/advanced/{id}':
    get:
      tags:
        - Serp
      description: 'Description of the fields for sending a request:'
      operationId: YoutubeVideoCommentsTaskGetAdvanced
      parameters:
        - name: id
          in: path
          description: <em>task identifier</em><br><strong>unique task identifier in our system in the <a href="https://en.wikipedia.org/wiki/Universally_unique_identifier">UUID</a> format</strong><br>you will be able to use it within <strong>30 days</strong> to request the results of the task at any time
          required: true
          schema:
            type: string
          example: 00000000-0000-0000-0000-000000000000
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpYoutubeVideoCommentsTaskGetAdvancedResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/serp/youtube/video_comments/live/advanced:
    post:
      tags:
        - Serp
      description: "‌\nLive YouTube Comments provides real-time data on comments on the video you specify in the request. You will get the top 20 comments on the video as well as information about the author, and key comment metrics."
      operationId: YoutubeVideoCommentsLiveAdvanced
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpYoutubeVideoCommentsLiveAdvancedRequestInfo'
                nullable: true
              example:
                - language_code: en
                  location_code: 2840
                  video_id: vQXvyV0zIP4
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpYoutubeVideoCommentsLiveAdvancedResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/serp/yahoo/locations:
    get:
      tags:
        - Serp
      description: You will receive the list of locations by this API call. You can filter the list of locations by country when setting a task.
      operationId: YahooLocations
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpYahooLocationsResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  '/v3/serp/yahoo/locations/{country}':
    get:
      tags:
        - Serp
      description: You will receive the list of locations by this API call. You can filter the list of locations by country when setting a task.
      operationId: YahooLocationsCountry
      parameters:
        - name: country
          in: path
          description: <em>country ISO code</em><br>optional field<br>specify the ISO code if you want to filter the list of locations by country<br>example:<br><code>us</code>
          required: true
          schema:
            type: string
          example: us
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpYahooLocationsCountryResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/serp/yahoo/languages:
    get:
      tags:
        - Serp
      description: You will receive the list of languages by calling this API.
      operationId: YahooLanguages
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpYahooLanguagesResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/serp/yahoo/organic/task_post:
    post:
      tags:
        - Serp
      description: "‌‌\nSERP API provides top search engine results. These results are specific to the selected location (see the List of Locations) and language (see the List of Languages) settings."
      operationId: YahooOrganicTaskPost
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpYahooOrganicTaskPostRequestInfo'
                nullable: true
              example:
                - language_code: en
                  location_code: 2840
                  keyword: albert einstein
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpYahooOrganicTaskPostResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/serp/yahoo/organic/tasks_ready:
    get:
      tags:
        - Serp
      description: "‌\nThe ‘Tasks Ready’ endpoint is designed to provide you with the list of completed tasks, which haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed tasks using this endpoint. Then, you can collect the results using the ‘Task GET’ endpoint.\nLearn more about task completion and obtaining a list of completed tasks in this help center article."
      operationId: YahooOrganicTasksReady
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpYahooOrganicTasksReadyResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/serp/yahoo/organic/tasks_fixed:
    get:
      tags:
        - Serp
      description: "‌\nThe ‘Tasks Fixed’ endpoint is designed to provide you with the list of re-parsed tasks, which haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed re-parsed tasks using this endpoint. Then, you can re-collect the fixed results using the ‘Task GET’ endpoint."
      operationId: YahooOrganicTasksFixed
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpYahooOrganicTasksFixedResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  '/v3/serp/yahoo/organic/task_get/regular/{id}':
    get:
      tags:
        - Serp
      description: 'Description of the fields for sending a request:'
      operationId: YahooOrganicTaskGetRegular
      parameters:
        - name: id
          in: path
          description: <em>task identifier</em><br><strong>unique task identifier in our system in the <a href="https://en.wikipedia.org/wiki/Universally_unique_identifier">UUID</a> format</strong><br>you will be able to use it within <strong>30 days</strong> to request the results of the task at any time
          required: true
          schema:
            type: string
          example: 00000000-0000-0000-0000-000000000000
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpYahooOrganicTaskGetRegularResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  '/v3/serp/yahoo/organic/task_get/advanced/{id}':
    get:
      tags:
        - Serp
      description: 'Description of the fields for sending a request:'
      operationId: YahooOrganicTaskGetAdvanced
      parameters:
        - name: id
          in: path
          description: <em>task identifier</em><br><strong>unique task identifier in our system in the <a href="https://en.wikipedia.org/wiki/Universally_unique_identifier">UUID</a> format</strong><br>you will be able to use it within <strong>30 days</strong> to request the results of the task at any time
          required: true
          schema:
            type: string
          example: 00000000-0000-0000-0000-000000000000
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpYahooOrganicTaskGetAdvancedResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  '/v3/serp/yahoo/organic/task_get/html/{id}':
    get:
      tags:
        - Serp
      description: 'Description of the fields for sending a request:'
      operationId: YahooOrganicTaskGetHtml
      parameters:
        - name: id
          in: path
          description: <em>task identifier</em><br><strong>unique task identifier in our system in the <a href="https://en.wikipedia.org/wiki/Universally_unique_identifier">UUID</a> format</strong><br>you will be able to use it within <strong>7 days</strong> to request the results of the task at any time
          required: true
          schema:
            type: string
          example: 00000000-0000-0000-0000-000000000000
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpYahooOrganicTaskGetHtmlResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/serp/yahoo/organic/live/regular:
    post:
      tags:
        - Serp
      description: 'Live Yahoo SERP provides real-time data on search engine results for the specified keyword, search engine, and location.'
      operationId: YahooOrganicLiveRegular
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpYahooOrganicLiveRegularRequestInfo'
                nullable: true
              example:
                - language_code: en
                  location_code: 2840
                  keyword: albert einstein
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpYahooOrganicLiveRegularResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/serp/yahoo/organic/live/advanced:
    post:
      tags:
        - Serp
      description: Live SERP provides real-time data on top search engine results. These results are specific to the selected location (see the List of Locations) and language (see the List of Languages) settings.
      operationId: YahooOrganicLiveAdvanced
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpYahooOrganicLiveAdvancedRequestInfo'
                nullable: true
              example:
                - language_code: en
                  location_code: 2840
                  keyword: albert einstein
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpYahooOrganicLiveAdvancedResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/serp/yahoo/organic/live/html:
    post:
      tags:
        - Serp
      description: 'Live SERP HTML provides a raw HTML page of search engine results for the specified keyword, search engine, and location.'
      operationId: YahooOrganicLiveHtml
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpYahooOrganicLiveHtmlRequestInfo'
                nullable: true
              example:
                - language_code: en
                  location_code: 2840
                  keyword: albert einstein
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpYahooOrganicLiveHtmlResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/serp/baidu/locations:
    get:
      tags:
        - Serp
      description: You will receive the list of locations by this API call. You can filter the list of locations by country when setting a task.
      operationId: BaiduLocations
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpBaiduLocationsResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  '/v3/serp/baidu/locations/{country}':
    get:
      tags:
        - Serp
      description: You will receive the list of locations by this API call. You can filter the list of locations by country when setting a task.
      operationId: BaiduLocationsCountry
      parameters:
        - name: country
          in: path
          description: <em>country ISO code</em><br>optional field<br>specify the ISO code if you want to filter the list of locations by country<br>example:<br><code>us</code>
          required: true
          schema:
            type: string
          example: us
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpBaiduLocationsCountryResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/serp/baidu/languages:
    get:
      tags:
        - Serp
      description: You will receive the list of languages by calling this API. You can also download the full list of supported languages in the CSV format (last updated 2026-04-06).
      operationId: BaiduLanguages
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpBaiduLanguagesResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/serp/baidu/organic/task_post:
    post:
      tags:
        - Serp
      description: Baidu SERP API provides top 10 search engine results. These results are specific to the selected location (see the List of Locations) and other settings.
      operationId: BaiduOrganicTaskPost
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpBaiduOrganicTaskPostRequestInfo'
                nullable: true
              example:
                - location_code: 2156
                  keyword: best iphone ever
                  tag: some_string_123
                  priority: 2
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpBaiduOrganicTaskPostResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/serp/baidu/organic/tasks_ready:
    get:
      tags:
        - Serp
      description: "‌\nThe ‘Tasks Ready’ endpoint is designed to provide you with the list of completed tasks, which haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed tasks using this endpoint. Then, you can collect the results using the ‘Task GET’ endpoint.\nLearn more about task completion and obtaining a list of completed tasks in this help center article."
      operationId: BaiduOrganicTasksReady
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpBaiduOrganicTasksReadyResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/serp/baidu/organic/tasks_fixed:
    get:
      tags:
        - Serp
      description: "‌\nThe ‘Tasks Fixed’ endpoint is designed to provide you with the list of re-parsed tasks, which haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed re-parsed tasks using this endpoint. Then, you can re-collect the fixed results using the ‘Task GET’ endpoint."
      operationId: BaiduOrganicTasksFixed
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpBaiduOrganicTasksFixedResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  '/v3/serp/baidu/organic/task_get/regular/{id}':
    get:
      tags:
        - Serp
      description: 'Description of the fields for sending a request:'
      operationId: BaiduOrganicTaskGetRegular
      parameters:
        - name: id
          in: path
          description: <em>task identifier</em><br><strong>unique task identifier in our system in the <a href="https://en.wikipedia.org/wiki/Universally_unique_identifier">UUID</a> format</strong><br>you will be able to use it within <strong>30 days</strong> to request the results of the task at any time
          required: true
          schema:
            type: string
          example: 00000000-0000-0000-0000-000000000000
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpBaiduOrganicTaskGetRegularResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  '/v3/serp/baidu/organic/task_get/advanced/{id}':
    get:
      tags:
        - Serp
      description: 'Description of the fields for sending a request:'
      operationId: BaiduOrganicTaskGetAdvanced
      parameters:
        - name: id
          in: path
          description: <em>task identifier</em><br><strong>unique task identifier in our system in the <a href="https://en.wikipedia.org/wiki/Universally_unique_identifier">UUID</a> format</strong><br>you will be able to use it within <strong>30 days</strong> to request the results of the task at any time
          required: true
          schema:
            type: string
          example: 00000000-0000-0000-0000-000000000000
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpBaiduOrganicTaskGetAdvancedResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  '/v3/serp/baidu/organic/task_get/html/{id}':
    get:
      tags:
        - Serp
      description: 'Description of the fields for sending a request:'
      operationId: BaiduOrganicTaskGetHtml
      parameters:
        - name: id
          in: path
          description: <em>task identifier</em><br><strong>unique task identifier in our system in the <a href="https://en.wikipedia.org/wiki/Universally_unique_identifier">UUID</a> format</strong><br>you will be able to use it within <strong>7 days</strong> to request the results of the task at any time
          required: true
          schema:
            type: string
          example: 00000000-0000-0000-0000-000000000000
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpBaiduOrganicTaskGetHtmlResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/serp/naver/organic/task_post:
    post:
      tags:
        - Serp
      description: "‌‌\nNaver SERP API provides top 15 search engine results. Naver search results do not vary by location and language, and the search parameters for this search engine do not contain language and location variables. However, you can specify a keyword in any language, and the search engine results may vary depending on the language you used for specifying the search query."
      operationId: NaverOrganicTaskPost
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpNaverOrganicTaskPostRequestInfo'
                nullable: true
              example:
                - keyword: albert einstein
                  device: desktop
                  tag: some_string_123
                  postback_url: https://your-server.com/postbackscript.php
                  postback_data: regular
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpNaverOrganicTaskPostResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/serp/naver/organic/tasks_ready:
    get:
      tags:
        - Serp
      description: "‌\nThe ‘Tasks Ready’ endpoint is designed to provide you with the list of completed tasks, which haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed tasks using this endpoint. Then, you can collect the results using the ‘Task GET’ endpoint.\nLearn more about task completion and obtaining a list of completed tasks in this help center article."
      operationId: NaverOrganicTasksReady
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpNaverOrganicTasksReadyResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/serp/naver/organic/tasks_fixed:
    get:
      tags:
        - Serp
      description: "‌\nThe ‘Tasks Fixed’ endpoint is designed to provide you with the list of re-parsed tasks, which haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed re-parsed tasks using this endpoint. Then, you can re-collect the fixed results using the ‘Task GET’ endpoint."
      operationId: NaverOrganicTasksFixed
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpNaverOrganicTasksFixedResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  '/v3/serp/naver/organic/task_get/regular/{id}':
    get:
      tags:
        - Serp
      description: 'Description of the fields for sending a request:'
      operationId: NaverOrganicTaskGetRegular
      parameters:
        - name: id
          in: path
          description: <em>task identifier</em><br><strong>unique task identifier in our system in the <a href="https://en.wikipedia.org/wiki/Universally_unique_identifier">UUID</a> format</strong><br>you will be able to use it within <strong>30 days</strong> to request the results of the task at any time
          required: true
          schema:
            type: string
          example: 00000000-0000-0000-0000-000000000000
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpNaverOrganicTaskGetRegularResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  '/v3/serp/naver/organic/task_get/advanced/{id}':
    get:
      tags:
        - Serp
      description: 'Description of the fields for sending a request:'
      operationId: NaverOrganicTaskGetAdvanced
      parameters:
        - name: id
          in: path
          description: <em>task identifier</em><br><strong>unique task identifier in our system in the <a href="https://en.wikipedia.org/wiki/Universally_unique_identifier">UUID</a> format</strong><br>you will be able to use it within <strong>30 days</strong> to request the results of the task at any time
          required: true
          schema:
            type: string
          example: 00000000-0000-0000-0000-000000000000
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpNaverOrganicTaskGetAdvancedResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  '/v3/serp/naver/organic/task_get/html/{id}':
    get:
      tags:
        - Serp
      description: 'Description of the fields for sending a request:'
      operationId: NaverOrganicTaskGetHtml
      parameters:
        - name: id
          in: path
          description: <em>task identifier</em><br><strong>unique task identifier in our system in the <a href="https://en.wikipedia.org/wiki/Universally_unique_identifier">UUID</a> format</strong><br>you will be able to use it within <strong>7 days</strong> to request the results of the task at any time
          required: true
          schema:
            type: string
          example: 00000000-0000-0000-0000-000000000000
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpNaverOrganicTaskGetHtmlResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/serp/seznam/locations:
    get:
      tags:
        - Serp
      description: You will receive the list of locations by this API call. You can filter the list of locations by country when setting a task.
      operationId: SeznamLocations
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpSeznamLocationsResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  '/v3/serp/seznam/locations/{country}':
    get:
      tags:
        - Serp
      description: You will receive the list of locations by this API call. You can filter the list of locations by country when setting a task.
      operationId: SeznamLocationsCountry
      parameters:
        - name: country
          in: path
          description: <em>country ISO code</em><br>optional field<br>specify the ISO code if you want to filter the list of locations by country<br>example:<br><code>us</code>
          required: true
          schema:
            type: string
          example: us
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpSeznamLocationsCountryResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/serp/seznam/languages:
    get:
      tags:
        - Serp
      description: You will receive the list of languages by calling this API.
      operationId: SeznamLanguages
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpSeznamLanguagesResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/serp/seznam/organic/task_post:
    post:
      tags:
        - Serp
      description: "‌‌\nSeznam SERP API provides top 10 search engine results from one of the most popular search engines in the Czech Republic. Seznam is focused on the local search market, and thus supports the Czech language only."
      operationId: SeznamOrganicTaskPost
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpSeznamOrganicTaskPostRequestInfo'
                nullable: true
              example:
                - language_code: cs
                  location_code: 2203
                  keyword: albert einstein
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpSeznamOrganicTaskPostResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/serp/seznam/organic/tasks_ready:
    get:
      tags:
        - Serp
      description: "‌\nThe ‘Tasks Ready’ endpoint is designed to provide you with the list of completed tasks, which haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed tasks using this endpoint. Then, you can collect the results using the ‘Task GET’ endpoint.\nLearn more about task completion and obtaining a list of completed tasks in this help center article."
      operationId: SeznamOrganicTasksReady
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpSeznamOrganicTasksReadyResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/serp/seznam/organic/tasks_fixed:
    get:
      tags:
        - Serp
      description: "‌\nThe ‘Tasks Fixed’ endpoint is designed to provide you with the list of re-parsed tasks, which haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed re-parsed tasks using this endpoint. Then, you can re-collect the fixed results using the ‘Task GET’ endpoint."
      operationId: SeznamOrganicTasksFixed
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpSeznamOrganicTasksFixedResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  '/v3/serp/seznam/organic/task_get/regular/{id}':
    get:
      tags:
        - Serp
      description: 'Description of the fields for sending a request:'
      operationId: SeznamOrganicTaskGetRegular
      parameters:
        - name: id
          in: path
          description: <em>task identifier</em><br><strong>unique task identifier in our system in the <a href="https://en.wikipedia.org/wiki/Universally_unique_identifier">UUID</a> format</strong><br>you will be able to use it within <strong>30 days</strong> to request the results of the task at any time
          required: true
          schema:
            type: string
          example: 00000000-0000-0000-0000-000000000000
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpSeznamOrganicTaskGetRegularResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  '/v3/serp/seznam/organic/task_get/advanced/{id}':
    get:
      tags:
        - Serp
      description: 'Description of the fields for sending a request:'
      operationId: SeznamOrganicTaskGetAdvanced
      parameters:
        - name: id
          in: path
          description: <em>task identifier</em><br><strong>unique task identifier in our system in the <a href="https://en.wikipedia.org/wiki/Universally_unique_identifier">UUID</a> format</strong><br>you will be able to use it within <strong>30 days</strong> to request the results of the task at any time
          required: true
          schema:
            type: string
          example: 00000000-0000-0000-0000-000000000000
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpSeznamOrganicTaskGetAdvancedResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  '/v3/serp/seznam/organic/task_get/html/{id}':
    get:
      tags:
        - Serp
      description: 'Description of the fields for sending a request:'
      operationId: SeznamOrganicTaskGetHtml
      parameters:
        - name: id
          in: path
          description: <em>task identifier</em><br><strong>unique task identifier in our system in the <a href="https://en.wikipedia.org/wiki/Universally_unique_identifier">UUID</a> format</strong><br>you will be able to use it within <strong>7 days</strong> to request the results of the task at any time
          required: true
          schema:
            type: string
          example: 00000000-0000-0000-0000-000000000000
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpSeznamOrganicTaskGetHtmlResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/serp/google/finance_explore/task_post:
    post:
      tags:
        - Serp
      description: "‌\nGoogle Finance Explore API provides real-time data from the ‘Explore’ tab of Google Finance. These results are specific to the parameters you specify in the request: location and language."
      operationId: GoogleFinanceExploreTaskPost
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleFinanceExploreTaskPostRequestInfo'
                nullable: true
              example:
                - location_code: 2840
                  language_name: English
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleFinanceExploreTaskPostResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/serp/google/finance_explore/tasks_ready:
    get:
      tags:
        - Serp
      description: "‌\nThe ‘Tasks Ready’ endpoint is designed to provide you with the list of completed tasks, which haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed tasks using this endpoint. Then, you can collect the results using the ‘Task GET’ endpoint.\nLearn more about task completion and obtaining a list of completed tasks in this help center article."
      operationId: GoogleFinanceExploreTasksReady
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleFinanceExploreTasksReadyResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  '/v3/serp/google/finance_explore/task_get/advanced/{id}':
    get:
      tags:
        - Serp
      description: "‌\nLive Google Finance Explore provides real-time data from the ‘Explore’ tab of Google Finance. These results are specific to the parameters you specify in the request: ticker in the keyword field, location and language."
      operationId: GoogleFinanceExploreTaskGetAdvanced
      parameters:
        - name: id
          in: path
          description: <em>task identifier</em><br><strong>unique task identifier in our system in the <a href="https://en.wikipedia.org/wiki/Universally_unique_identifier">UUID</a> format</strong><br>you will be able to use it within <strong>30 days</strong> to request the results of the task at any time
          required: true
          schema:
            type: string
          example: 00000000-0000-0000-0000-000000000000
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleFinanceExploreTaskGetAdvancedResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  '/v3/serp/google/finance_explore/task_get/html/{id}':
    get:
      tags:
        - Serp
      description: 'Description of the fields for sending a request:'
      operationId: GoogleFinanceExploreTaskGetHtml
      parameters:
        - name: id
          in: path
          description: <em>task identifier</em><br><strong>unique task identifier in our system in the <a href="https://en.wikipedia.org/wiki/Universally_unique_identifier">UUID</a> format</strong><br>you will be able to use it within <strong>7 days</strong> to request the results of the task at any time
          required: true
          schema:
            type: string
          example: 00000000-0000-0000-0000-000000000000
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleFinanceExploreTaskGetHtmlResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/serp/google/finance_explore/live/advanced:
    post:
      tags:
        - Serp
      description: "‌\nLive Google Finance Explore provides real-time data from the ‘Explore’ tab of Google Finance. These results are specific to the parameters you specify in the request: location and language."
      operationId: GoogleFinanceExploreLiveAdvanced
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleFinanceExploreLiveAdvancedRequestInfo'
                nullable: true
              example:
                - location_code: 2840
                  language_name: English
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleFinanceExploreLiveAdvancedResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/serp/google/finance_explore/live/html:
    post:
      tags:
        - Serp
      description: "‌\nLive SERP HTML provides raw HTML page from the ‘Explore’ tab of Google Finance. These results are specific to the parameters you specify in the request: location and language."
      operationId: GoogleFinanceExploreLiveHtml
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleFinanceExploreLiveHtmlRequestInfo'
                nullable: true
              example:
                - language_code: en
                  location_code: 2840
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleFinanceExploreLiveHtmlResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/serp/google/finance_markets/task_post:
    post:
      tags:
        - Serp
      description: "‌\nGoogle Finance Markets API provides real-time data from the ‘Markets’ tab of Google Finance. These results are specific to the parameters you specify in the request:  location, language, and market_type."
      operationId: GoogleFinanceMarketsTaskPost
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleFinanceMarketsTaskPostRequestInfo'
                nullable: true
              example:
                - location_code: 2840
                  language_name: English
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleFinanceMarketsTaskPostResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/serp/google/finance_markets/tasks_ready:
    get:
      tags:
        - Serp
      description: "‌\nThe ‘Tasks Ready’ endpoint is designed to provide you with the list of completed tasks, which haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed tasks using this endpoint. Then, you can collect the results using the ‘Task GET’ endpoint.\nLearn more about task completion and obtaining a list of completed tasks in this help center article."
      operationId: GoogleFinanceMarketsTasksReady
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleFinanceMarketsTasksReadyResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  '/v3/serp/google/finance_markets/task_get/advanced/{id}':
    get:
      tags:
        - Serp
      description: "‌\nGoogle Finance Markets API provides real-time data from the ‘Markets’ tab of Google Finance. These results are specific to the parameters you specify in the request: ticker in the keyword field, location and language."
      operationId: GoogleFinanceMarketsTaskGetAdvanced
      parameters:
        - name: id
          in: path
          description: <em>task identifier</em><br><strong>unique task identifier in our system in the <a href="https://en.wikipedia.org/wiki/Universally_unique_identifier">UUID</a> format</strong><br>you will be able to use it within <strong>30 days</strong> to request the results of the task at any time
          required: true
          schema:
            type: string
          example: 00000000-0000-0000-0000-000000000000
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleFinanceMarketsTaskGetAdvancedResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  '/v3/serp/google/finance_markets/task_get/html/{id}':
    get:
      tags:
        - Serp
      description: 'Description of the fields for sending a request:'
      operationId: GoogleFinanceMarketsTaskGetHtml
      parameters:
        - name: id
          in: path
          description: <em>task identifier</em><br><strong>unique task identifier in our system in the <a href="https://en.wikipedia.org/wiki/Universally_unique_identifier">UUID</a> format</strong><br>you will be able to use it within <strong>7 days</strong> to request the results of the task at any time
          required: true
          schema:
            type: string
          example: 00000000-0000-0000-0000-000000000000
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleFinanceMarketsTaskGetHtmlResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/serp/google/finance_markets/live/advanced:
    post:
      tags:
        - Serp
      description: "‌\nLive Google Finance Markets provides real-time data from the ‘Markets’ tab of Google Finance. These results are specific to the parameters you specify in the request: location, language, and market_type."
      operationId: GoogleFinanceMarketsLiveAdvanced
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleFinanceMarketsLiveAdvancedRequestInfo'
                nullable: true
              example:
                - location_code: 2840
                  language_name: English
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleFinanceMarketsLiveAdvancedResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/serp/google/finance_markets/live/html:
    post:
      tags:
        - Serp
      description: "‌\nLive SERP HTML provides raw HTML from the ‘Markets’ tab of Google Finance. These results are specific to the parameters you specify in the request: location and language."
      operationId: GoogleFinanceMarketsLiveHtml
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleFinanceMarketsLiveHtmlRequestInfo'
                nullable: true
              example:
                - language_code: en
                  location_code: 2840
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleFinanceMarketsLiveHtmlResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/serp/google/finance_quote/task_post:
    post:
      tags:
        - Serp
      description: "‌\nGoogle Finance Quote provides real-time data from the ‘Quote’ tab of Google Finance. These results are specific to the parameters you specify in the request: ticker in the keyword field, location and language."
      operationId: GoogleFinanceQuoteTaskPost
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleFinanceQuoteTaskPostRequestInfo'
                nullable: true
              example:
                - keyword: .DJI:INDEXDJX
                  location_code: 2840
                  language_name: English
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleFinanceQuoteTaskPostResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/serp/google/finance_quote/tasks_ready:
    get:
      tags:
        - Serp
      description: "‌\nThe ‘Tasks Ready’ endpoint is designed to provide you with the list of completed tasks, which haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed tasks using this endpoint. Then, you can collect the results using the ‘Task GET’ endpoint.\nLearn more about task completion and obtaining a list of completed tasks in this help center article."
      operationId: GoogleFinanceQuoteTasksReady
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleFinanceQuoteTasksReadyResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  '/v3/serp/google/finance_quote/task_get/advanced/{id}':
    get:
      tags:
        - Serp
      description: "‌\nLive Google Finance Quote provides real-time data from the ‘Quote’ tab of Google Finance. These results are specific to the parameters you specify in the request: ticker in the keyword field, location and language."
      operationId: GoogleFinanceQuoteTaskGetAdvanced
      parameters:
        - name: id
          in: path
          description: <em>task identifier</em><br><strong>unique task identifier in our system in the <a href="https://en.wikipedia.org/wiki/Universally_unique_identifier">UUID</a> format</strong><br>you will be able to use it within <strong>30 days</strong> to request the results of the task at any time
          required: true
          schema:
            type: string
          example: 00000000-0000-0000-0000-000000000000
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleFinanceQuoteTaskGetAdvancedResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  '/v3/serp/google/finance_quote/task_get/html/{id}':
    get:
      tags:
        - Serp
      description: 'Description of the fields for sending a request:'
      operationId: GoogleFinanceQuoteTaskGetHtml
      parameters:
        - name: id
          in: path
          description: <em>task identifier</em><br><strong>unique task identifier in our system in the <a href="https://en.wikipedia.org/wiki/Universally_unique_identifier">UUID</a> format</strong><br>you will be able to use it within <strong>7 days</strong> to request the results of the task at any time
          required: true
          schema:
            type: string
          example: 00000000-0000-0000-0000-000000000000
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleFinanceQuoteTaskGetHtmlResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/serp/google/finance_quote/live/advanced:
    post:
      tags:
        - Serp
      description: "‌\nLive Google Finance Quote provides real-time data from the ‘Quote’ tab of Google Finance. These results are specific to the parameters you specify in the request: ticker in the keyword field, location and language."
      operationId: GoogleFinanceQuoteLiveAdvanced
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleFinanceQuoteLiveAdvancedRequestInfo'
                nullable: true
              example:
                - keyword: CLW00:NYMEX
                  location_code: 2840
                  language_name: English
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleFinanceQuoteLiveAdvancedResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/serp/google/finance_quote/live/html:
    post:
      tags:
        - Serp
      description: "‌\nLive SERP HTML provides raw HTML from the ‘Quote’ tab of Google Finance. These results are specific to the parameters you specify in the request: ticker in the keyword field, location and language."
      operationId: GoogleFinanceQuoteLiveHtml
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleFinanceQuoteLiveHtmlRequestInfo'
                nullable: true
              example:
                - language_code: en
                  location_code: 2840
                  keyword: NASDAQ-100
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleFinanceQuoteLiveHtmlResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/serp/google/finance_ticker_search/task_post:
    post:
      tags:
        - Serp
      description: "‌\nGoogle Finance Ticker Search allows you to search for financial instruments available on Google Finance along with additional information. The result is specific to the parameters you specify in the request: keyword (name of a company or financial instrument) in the keyword field, location and language."
      operationId: GoogleFinanceTickerSearchTaskPost
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleFinanceTickerSearchTaskPostRequestInfo'
                nullable: true
              example:
                - language_name: English
                  location_code: 2840
                  category: all
                  keyword: DJ
                  priority: 2
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleFinanceTickerSearchTaskPostResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/serp/google/finance_ticker_search/tasks_ready:
    get:
      tags:
        - Serp
      description: "‌\nThe ‘Tasks Ready’ endpoint is designed to provide you with the list of completed tasks, which haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed tasks using this endpoint. Then, you can collect the results using the ‘Task GET’ endpoint.\nLearn more about task completion and obtaining a list of completed tasks in this help center article."
      operationId: GoogleFinanceTickerSearchTasksReady
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleFinanceTickerSearchTasksReadyResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  '/v3/serp/google/finance_ticker_search/task_get/advanced/{id}':
    get:
      tags:
        - Serp
      description: "‌\nGoogle Finance Ticker Search allows you to search for financial instruments available on Google Finance along with additional information. The result is specific to the parameters you specify in the request: keyword (name of a company or financial instrument) in the keyword field, location and language."
      operationId: GoogleFinanceTickerSearchTaskGetAdvanced
      parameters:
        - name: id
          in: path
          description: <em>task identifier</em><br><strong>unique task identifier in our system in the <a href="https://en.wikipedia.org/wiki/Universally_unique_identifier">UUID</a> format</strong><br>you will be able to use it within <strong>30 days</strong> to request the results of the task at any time
          required: true
          schema:
            type: string
          example: 00000000-0000-0000-0000-000000000000
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleFinanceTickerSearchTaskGetAdvancedResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/serp/google/finance_ticker_search/live/advanced:
    post:
      tags:
        - Serp
      description: "‌\nLive Google Finance Ticker Search allows you to search for financial instruments available on Google Finance along with additional information. The result is specific to the parameters you specify in the request: keyword (name of a company or financial instrument) in the keyword field, location and language."
      operationId: GoogleFinanceTickerSearchLiveAdvanced
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleFinanceTickerSearchLiveAdvancedRequestInfo'
                nullable: true
              example:
                - language_name: English
                  location_code: 2840
                  category: all
                  keyword: DJ
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleFinanceTickerSearchLiveAdvancedResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/dataforseo_labs/id_list:
    post:
      tags:
        - DataforseoLabs
      description: 'This endpoint is designed to provide you with a list of IDs and metadata for all DataForSEO Labs tasks created within the specified time period, including both successful and uncompleted tasks.'
      operationId: DataforseoLabsIdList
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/DataforseoLabsIdListRequestInfo'
                nullable: true
              example:
                - datetime_from: '2026-09-10 11:12:35'
                  datetime_to: '2026-09-20 11:12:35'
                  limit: 10
                  include_metadata: true
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/DataforseoLabsIdListResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/dataforseo_labs/status:
    get:
      tags:
        - DataforseoLabs
      description: "‌\nBy calling this endpoint, you will find out when the DataForSEO Labs data was last updated. The API response will provide separate update dates for the Google, Bing, and Amazon endpoints of DataForSEO Labs API."
      operationId: Status
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/DataforseoLabsStatusResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/dataforseo_labs/errors:
    post:
      tags:
        - DataforseoLabs
      description: By calling this endpoint you will receive information about the DataForSEO Labs API tasks that returned an error within the past 7 days.
      operationId: DataforseoLabsErrors
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/DataforseoLabsErrorsRequestInfo'
                nullable: true
              example:
                - limit: 10
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/DataforseoLabsErrorsResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/dataforseo_labs/available_filters:
    get:
      tags:
        - DataforseoLabs
      description: "‌‌\nHere you will find all the necessary information about filters that can be used with DataForSEO Labs API endpoints."
      operationId: AvailableFilters
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/DataforseoLabsAvailableFiltersResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/dataforseo_labs/locations_and_languages:
    get:
      tags:
        - DataforseoLabs
      description: "‌\nUsing this endpoint you can get the full list of locations and languages supported in DataForSEO Labs API. Available sources currently include Google, Bing, and Amazon search engines. However, you should note that Amazon and Bing locations and languages are currently limited to the US/English."
      operationId: LocationsAndLanguages
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/DataforseoLabsLocationsAndLanguagesResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/dataforseo_labs/categories:
    get:
      tags:
        - DataforseoLabs
      description: "We use Google product and service categories. This endpoint will provide you with the full list of available categories.\nYou can also download the CSV file by this link."
      operationId: Categories
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/DataforseoLabsCategoriesResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/dataforseo_labs/google/available_history:
    get:
      tags:
        - DataforseoLabs
      description: "By calling this endpoint, you will find obtain a list of dates available for setting in the first_date and second_date fields of the Domain Metrics by Categories endpoint.\nfor more info please visit 'https://docs.dataforseo.com/v3/dataforseo_labs/google/available_history/live/?bash'"
      operationId: GoogleAvailableHistory
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/DataforseoLabsGoogleAvailableHistoryResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/dataforseo_labs/google/keywords_for_site/live:
    post:
      tags:
        - DataforseoLabs
      description: "‌\nThe Keywords For Site endpoint will provide you with a list of keywords relevant to the target domain, subdomain, or webpage. Each keyword is supplied with relevant categories, search volume data for the last month, cost-per-click, competition, and search volume trend values for the past 12 months."
      operationId: GoogleKeywordsForSiteLive
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/DataforseoLabsGoogleKeywordsForSiteLiveRequestInfo'
                nullable: true
              example:
                - target: apple.com
                  language_code: en
                  location_code: 2840
                  include_serp_info: true
                  include_subdomains: true
                  filters:
                    - serp_info.se_results_count
                    - '>'
                    - 0
                  limit: 3
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/DataforseoLabsGoogleKeywordsForSiteLiveResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/dataforseo_labs/google/related_keywords/live:
    post:
      tags:
        - DataforseoLabs
      description: "The Related Keywords endpoint provides keywords appearing in the “Searches Related to” SERP element.\n  View the element.\nYou can get up to 4680 keyword ideas by specifying the search depth. Each related keyword comes with the list of relevant product categories, search volume rate for the last month, search volume trend for the previous 12 months, as well as current cost-per-click and competition values."
      operationId: GoogleRelatedKeywordsLive
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/DataforseoLabsGoogleRelatedKeywordsLiveRequestInfo'
                nullable: true
              example:
                - keyword: phone
                  language_name: English
                  location_code: 2840
                  limit: 3
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/DataforseoLabsGoogleRelatedKeywordsLiveResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/dataforseo_labs/google/keyword_suggestions/live:
    post:
      tags:
        - DataforseoLabs
      description: "‌‌\nThe Keyword Suggestions endpoint provides search queries that include the specified seed keyword."
      operationId: GoogleKeywordSuggestionsLive
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/DataforseoLabsGoogleKeywordSuggestionsLiveRequestInfo'
                nullable: true
              example:
                - keyword: phone
                  location_code: 2840
                  language_code: en
                  include_serp_info: true
                  include_seed_keyword: true
                  limit: 1
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/DataforseoLabsGoogleKeywordSuggestionsLiveResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/dataforseo_labs/google/keyword_ideas/live:
    post:
      tags:
        - DataforseoLabs
      description: "‌\nThe Keyword Ideas endpoint provides search terms that are relevant to the product or service categories of the specified keywords. The algorithm selects the keywords which fall into the same categories as the seed keywords specified in a POST array."
      operationId: GoogleKeywordIdeasLive
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/DataforseoLabsGoogleKeywordIdeasLiveRequestInfo'
                nullable: true
              example:
                - keywords:
                    - phone
                    - watch
                  location_code: 2840
                  language_code: en
                  include_serp_info: true
                  limit: 3
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/DataforseoLabsGoogleKeywordIdeasLiveResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/dataforseo_labs/google/bulk_keyword_difficulty/live:
    post:
      tags:
        - DataforseoLabs
      description: 'This endpoint will provide you with the Keyword Difficulty metric for a maximum of 1,000 keywords in one API request. Keyword Difficulty stands for the relative difficulty of ranking in the first top-10 organic results for the related keyword. Keyword Difficulty in DataForSEO API responses indicates the chance of getting in top-10 organic results for a keyword on a logarithmic scale from 0 to 100.'
      operationId: GoogleBulkKeywordDifficultyLive
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/DataforseoLabsGoogleBulkKeywordDifficultyLiveRequestInfo'
                nullable: true
              example:
                - location_code: 2840
                  language_code: en
                  keywords:
                    - dentist new york
                    - pizza brooklyn
                    - car dealer los angeles
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/DataforseoLabsGoogleBulkKeywordDifficultyLiveResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/dataforseo_labs/google/search_intent/live:
    post:
      tags:
        - DataforseoLabs
      description: "‌\nThis endpoint will provide you with search intent data for up to 1,000 keywords. For each keyword that you specify when setting a task, the API will return the keyword’s search intent and intent probability. Besides the highest probable search intent, the results will also provide you with other likely search intent(s) and their probability."
      operationId: GoogleSearchIntentLive
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/DataforseoLabsGoogleSearchIntentLiveRequestInfo'
                nullable: true
              example:
                - keywords:
                    - login page
                    - audi a7
                    - elon musk
                    - milk store new york
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/DataforseoLabsGoogleSearchIntentLiveResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/dataforseo_labs/google/categories_for_keywords/languages:
    get:
      tags:
        - DataforseoLabs
      description: "‌\nUsing this endpoint you can get the full list of languages supported for the Google Categories for Keywords endpoint of DataForSEO Labs API."
      operationId: GoogleCategoriesForKeywordsLanguages
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/DataforseoLabsGoogleCategoriesForKeywordsLanguagesResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/dataforseo_labs/google/categories_for_domain/live:
    post:
      tags:
        - DataforseoLabs
      description: "‌\nThis endpoint will provide you with Google product or service categories that include keywords the domain ranks for in search. Furthermore, you will obtain general rankings and traffic data for the keywords under a certain category."
      operationId: GoogleCategoriesForDomainLive
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/DataforseoLabsGoogleCategoriesForDomainLiveRequestInfo'
                nullable: true
              example:
                - target: dataforseo.com
                  language_code: en
                  location_name: United States
                  item_types:
                    - paid
                    - organic
                    - featured_snippet
                    - local_pack
                  limit: 3
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/DataforseoLabsGoogleCategoriesForDomainLiveResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/dataforseo_labs/google/categories_for_keywords/live:
    post:
      tags:
        - DataforseoLabs
      description: 'This endpoint will provide you with Google product and service categories related for each specified keyword. You can indicate a maximum of 1,000 keywords in one API request.'
      operationId: GoogleCategoriesForKeywordsLive
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/DataforseoLabsGoogleCategoriesForKeywordsLiveRequestInfo'
                nullable: true
              example:
                - language_code: en
                  keywords:
                    - dentist new york
                    - pizza brooklyn
                    - car dealer los angeles
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/DataforseoLabsGoogleCategoriesForKeywordsLiveResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/dataforseo_labs/google/keywords_for_categories/live:
    post:
      tags:
        - DataforseoLabs
      description: "‌\nThis endpoint will provide you with a list of keywords relevant to the specified product categories. You will get the search volume rate for the last month, search volume trend for the previous 12 months, as well as current cost-per-click and competition values for each keyword."
      operationId: GoogleKeywordsForCategoriesLive
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/DataforseoLabsGoogleKeywordsForCategoriesLiveRequestInfo'
                nullable: true
              example:
                - category_codes:
                    - '12191'
                    - '12193'
                  language_name: English
                  location_code: 2840
                  include_serp_info: true
                  limit: 3
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/DataforseoLabsGoogleKeywordsForCategoriesLiveResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/dataforseo_labs/google/domain_metrics_by_categories/live:
    post:
      tags:
        - DataforseoLabs
      description: "‌\nThis endpoint will provide you with dynamics of change in metrics of domains relevant to the specified product and service categories. You will receive historical ranking data from Google SERPs, along with valuable current and historical domain metrics, such as ETV, impressions ETV, estimated paid traffic cost, the total count of SERPs that contain domains, and more."
      operationId: GoogleDomainMetricsByCategoriesLive
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/DataforseoLabsGoogleDomainMetricsByCategoriesLiveRequestInfo'
                nullable: true
              example:
                - location_code: 2840
                  language_code: en
                  category_codes:
                    - '13418'
                    - '11494'
                  first_date: '2021-06-01'
                  second_date: '2021-10-01'
                  limit: 3
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/DataforseoLabsGoogleDomainMetricsByCategoriesLiveResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/dataforseo_labs/google/top_searches/live:
    post:
      tags:
        - DataforseoLabs
      description: "‌‌\nThe Top Searches endpoint of DataForSEO Labs API can provide you with over 7 billion keywords from the DataForSEO Keyword Database. Each keyword in the API response is provided with a set of relevant keyword data with Google Ads metrics, product categories, and Google SERP data."
      operationId: GoogleTopSearchesLive
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/DataforseoLabsGoogleTopSearchesLiveRequestInfo'
                nullable: true
              example:
                - language_name: English
                  location_code: 2840
                  limit: 3
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/DataforseoLabsGoogleTopSearchesLiveResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/dataforseo_labs/google/ranked_keywords/live:
    post:
      tags:
        - DataforseoLabs
      description: "‌\nThis endpoint will provide you with the list of keywords that any domain, subdomain, or webpage is ranking for. You will also get SERP elements related to the keyword position, as well as monthly searches and other data relevant to the returned keywords."
      operationId: GoogleRankedKeywordsLive
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/DataforseoLabsGoogleRankedKeywordsLiveRequestInfo'
                nullable: true
              example:
                - target: dataforseo.com
                  language_name: English
                  location_name: United States
                  load_rank_absolute: true
                  limit: 3
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/DataforseoLabsGoogleRankedKeywordsLiveResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/dataforseo_labs/google/serp_competitors/live:
    post:
      tags:
        - DataforseoLabs
      description: "‌\nThis endpoint will provide you with a list of domains ranking for the keywords you specify. You will also get SERP rankings, rating, estimated traffic volume, and visibility values the provided domains gain from the specified keywords."
      operationId: GoogleSerpCompetitorsLive
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/DataforseoLabsGoogleSerpCompetitorsLiveRequestInfo'
                nullable: true
              example:
                - keywords:
                    - phone
                  language_name: English
                  location_code: 2840
                  item_types:
                    - organic
                  limit: 5
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/DataforseoLabsGoogleSerpCompetitorsLiveResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/dataforseo_labs/google/competitors_domain/live:
    post:
      tags:
        - DataforseoLabs
      description: "‌\nThis endpoint will provide you with a full overview of ranking and traffic data of the competitor domains from organic and paid search. In addition to that, you will get the metrics specific to the keywords both competitor domains and your domain rank for within the same SERP."
      operationId: GoogleCompetitorsDomainLive
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/DataforseoLabsGoogleCompetitorsDomainLiveRequestInfo'
                nullable: true
              example:
                - target: newmouth.com
                  intersecting_domains:
                    - dentaly.org
                    - health.com
                    - trysnow.com
                  language_name: English
                  location_code: 2840
                  limit: 3
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/DataforseoLabsGoogleCompetitorsDomainLiveResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/dataforseo_labs/google/domain_intersection/live:
    post:
      tags:
        - DataforseoLabs
      description: "This endpoint will provide you with the keywords for which both specified domains rank within the same SERP. You will get search volume, competition, cost-per-click and other data on each intersecting keyword. Along with that, you will get data on the first and second domain’s SERP element discovered for this keyword, as well as the estimated traffic volume and cost of ad traffic. Domain Intersection endpoint supports organic, paid, local pack, and featured snippet results.\nfor more info please visit 'https://docs.dataforseo.com/v3/dataforseo_labs/google/domain_intersection/live/?bash'"
      operationId: GoogleDomainIntersectionLive
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/DataforseoLabsGoogleDomainIntersectionLiveRequestInfo'
                nullable: true
              example:
                - target1: mom.com
                  target2: quora.com
                  language_code: en
                  location_code: 2840
                  include_serp_info: true
                  limit: 3
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/DataforseoLabsGoogleDomainIntersectionLiveResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/dataforseo_labs/google/subdomains/live:
    post:
      tags:
        - DataforseoLabs
      description: "‌‌\nThis endpoint will provide you with a list of subdomains of the specified domain, along with the ranking distribution across organic and paid search. In addition to that, you will also get the estimated traffic volume of subdomains based on search volume and impressions."
      operationId: GoogleSubdomainsLive
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/DataforseoLabsGoogleSubdomainsLiveRequestInfo'
                nullable: true
              example:
                - target: dataforseo.com
                  language_name: English
                  location_code: 2840
                  filters:
                    - 
                      - metrics.organic.pos_1
                      - <>
                      - 0
                    - or
                    - 
                      - metrics.organic.pos_2_3
                      - <>
                      - 0
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/DataforseoLabsGoogleSubdomainsLiveResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/dataforseo_labs/google/relevant_pages/live:
    post:
      tags:
        - DataforseoLabs
      description: ‌
      operationId: GoogleRelevantPagesLive
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/DataforseoLabsGoogleRelevantPagesLiveRequestInfo'
                nullable: true
              example:
                - target: amazon.com
                  language_name: English
                  location_code: 2840
                  filters:
                    - 
                      - metrics.organic.pos_1
                      - <>
                      - 0
                    - or
                    - 
                      - metrics.organic.pos_2_3
                      - <>
                      - 0
                  limit: 3
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/DataforseoLabsGoogleRelevantPagesLiveResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/dataforseo_labs/google/domain_rank_overview/live:
    post:
      tags:
        - DataforseoLabs
      description: "‌\nThis endpoint will provide you with ranking and traffic data from organic and paid search for the specified domain. You will be able to review the domain ranking distribution in SERPs as well as estimated monthly traffic volume for both organic and paid results."
      operationId: GoogleDomainRankOverviewLive
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/DataforseoLabsGoogleDomainRankOverviewLiveRequestInfo'
                nullable: true
              example:
                - target: dataforseo.com
                  language_name: English
                  location_code: 2840
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/DataforseoLabsGoogleDomainRankOverviewLiveResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/dataforseo_labs/google/historical_serps/live:
    post:
      tags:
        - DataforseoLabs
      description: "‌\nThis endpoint will provide you with Google SERPs collected within the specified time frame. You will also receive a complete overview of featured snippets and other extra elements that were present within the specified dates. The data will allow you to analyze the dynamics of keyword rankings over time for the specified keyword and location."
      operationId: GoogleHistoricalSerpsLive
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/DataforseoLabsGoogleHistoricalSerpsLiveRequestInfo'
                nullable: true
              example:
                - keyword: albert einstein
                  datetime_from: '2026-09-10 11:12:35'
                  datetime_to: '2026-09-20 11:12:35'
                  location_code: 2840
                  language_code: en
                  limit: 10
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/DataforseoLabsGoogleHistoricalSerpsLiveResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/dataforseo_labs/google/historical_rank_overview/live:
    post:
      tags:
        - DataforseoLabs
      description: "‌\nThis endpoint will provide you with historical data on rankings and traffic of the specified domain, such as domain ranking distribution in SERPs and estimated monthly traffic volume for both organic and paid results."
      operationId: GoogleHistoricalRankOverviewLive
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/DataforseoLabsGoogleHistoricalRankOverviewLiveRequestInfo'
                nullable: true
              example:
                - target: dataforseo.com
                  location_code: 2840
                  language_code: en
                  date_from: '2021-01-01'
                  date_to: '2021-03-29'
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/DataforseoLabsGoogleHistoricalRankOverviewLiveResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/dataforseo_labs/google/page_intersection/live:
    post:
      tags:
        - DataforseoLabs
      description: "This endpoint will provide you with the keywords for which specified pages rank within the same SERP. You will get search volume, competition, cost-per-click data on each intersecting keyword. Along with that, you will get data on SERP elements that specified pages rank for in search results, as well as the estimated traffic volume and cost of ad traffic. Page Intersection endpoint supports organic, paid, local pack and featured snippet results.\nfor more info please visit 'https://docs.dataforseo.com/v3/dataforseo_labs/google/page_intersection/live/?bash'"
      operationId: GooglePageIntersectionLive
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/DataforseoLabsGooglePageIntersectionLiveRequestInfo'
                nullable: true
              example:
                - pages:
                    '1': https://forbes.com
                    '2': https://cnn.com/*
                  language_name: English
                  location_code: 2840
                  include_serp_info: true
                  limit: 3
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/DataforseoLabsGooglePageIntersectionLiveResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/dataforseo_labs/google/bulk_traffic_estimation/live:
    post:
      tags:
        - DataforseoLabs
      description: "‌\nThis endpoint will provide you with estimated monthly traffic volumes for up to 1,000 domains, subdomains, or webpages. Along with organic search traffic estimations, you will also get separate values for paid search, featured snippet, and local pack results."
      operationId: GoogleBulkTrafficEstimationLive
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/DataforseoLabsGoogleBulkTrafficEstimationLiveRequestInfo'
                nullable: true
              example:
                - targets:
                    - dataforseo.com
                    - cnn.com
                    - forbes.com
                  location_code: 2840
                  language_code: en
                  item_types:
                    - organic
                    - paid
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/DataforseoLabsGoogleBulkTrafficEstimationLiveResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/dataforseo_labs/google/historical_bulk_traffic_estimation/live:
    post:
      tags:
        - DataforseoLabs
      description: "‌\nThis endpoint will provide you with historical monthly traffic volumes for up to 1,000 domains collected within the specified time range through October 2020. If you do not specify the range, data will be returned for the previous 12 months. Along with organic search traffic estimations, you will also get separate values for paid search, featured snippet, and local pack results."
      operationId: GoogleHistoricalBulkTrafficEstimationLive
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/DataforseoLabsGoogleHistoricalBulkTrafficEstimationLiveRequestInfo'
                nullable: true
              example:
                - targets:
                    - dataforseo.com
                    - cnn.com
                    - forbes.com
                  location_code: 2840
                  language_code: en
                  date_from: '2021-01-01'
                  date_to: '2021-03-29'
                  item_types:
                    - organic
                    - paid
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/DataforseoLabsGoogleHistoricalBulkTrafficEstimationLiveResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/dataforseo_labs/google/historical_keyword_data/live:
    post:
      tags:
        - DataforseoLabs
      description: "‌‌ \nThis endpoint provides Google historical keyword data for specified keywords, including search volume, cost-per-click, competition values for paid search, monthly searches, and search volume trends. You can get historical keyword  data since August, 2021, depending on keywords along with location and language combination. You can find the list of supported locations and languages here."
      operationId: GoogleHistoricalKeywordDataLive
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/DataforseoLabsGoogleHistoricalKeywordDataLiveRequestInfo'
                nullable: true
              example:
                - language_code: en
                  location_code: 2840
                  keywords:
                    - iphone
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/DataforseoLabsGoogleHistoricalKeywordDataLiveResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/dataforseo_labs/google/keyword_overview/live:
    post:
      tags:
        - DataforseoLabs
      description: "‌‌ \nThis endpoint provides Google keyword data for specified keywords. For each keyword, you will receive current cost-per-click, competition values for paid search, search volume, search intent, monthly searches, as well as SERP and backlink information. Additionally, you can obtain clickstream data, such as clickstream search volume, by specifying the include_clickstream_data parameter."
      operationId: GoogleKeywordOverviewLive
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/DataforseoLabsGoogleKeywordOverviewLiveRequestInfo'
                nullable: true
              example:
                - language_code: en
                  location_code: 2840
                  include_clickstream_data: true
                  include_serp_info: true
                  keywords:
                    - iphone
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/DataforseoLabsGoogleKeywordOverviewLiveResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/dataforseo_labs/amazon/bulk_search_volume/live:
    post:
      tags:
        - DataforseoLabs
      description: "‌\nThis endpoint will provide you with search volume values for a maximum of 1,000 keywords in one API request. Here search volume represents the approximate number of monthly searches for a keyword on Amazon. The returned results are specific to the keywords, location, and language parameters specified in a POST request."
      operationId: AmazonBulkSearchVolumeLive
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/DataforseoLabsAmazonBulkSearchVolumeLiveRequestInfo'
                nullable: true
              example:
                - keywords:
                    - buy laptop
                    - cheap laptops for sale
                    - purchase laptop
                  location_code: 2840
                  language_code: en
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/DataforseoLabsAmazonBulkSearchVolumeLiveResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/dataforseo_labs/amazon/related_keywords/live:
    post:
      tags:
        - DataforseoLabs
      description: "‌‌\nThe Related Keywords endpoint provides keywords appearing in the “Related Searches” section on Amazon."
      operationId: AmazonRelatedKeywordsLive
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/DataforseoLabsAmazonRelatedKeywordsLiveRequestInfo'
                nullable: true
              example:
                - keyword: computer mouse
                  language_name: English
                  location_code: 2840
                  limit: 5
                  include_seed_keyword: true
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/DataforseoLabsAmazonRelatedKeywordsLiveResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/dataforseo_labs/amazon/ranked_keywords/live:
    post:
      tags:
        - DataforseoLabs
      description: "‌\nThis endpoint will provide you with a list of keywords the target product ranks for on Amazon. The returned results are specific to the asin specified in a POST request. Learn more about ASIN in this help center article."
      operationId: AmazonRankedKeywordsLive
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/DataforseoLabsAmazonRankedKeywordsLiveRequestInfo'
                nullable: true
              example:
                - asin: B00R92CL5E
                  location_code: 2840
                  language_code: en
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/DataforseoLabsAmazonRankedKeywordsLiveResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/dataforseo_labs/amazon/product_rank_overview/live:
    post:
      tags:
        - DataforseoLabs
      description: "‌\nThis endpoint will provide you with ranking data from organic and paid Amazon SERPs for the target products. The returned results are specific to the asins specified in a POST request. Learn more about ASIN in this help center article."
      operationId: AmazonProductRankOverviewLive
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/DataforseoLabsAmazonProductRankOverviewLiveRequestInfo'
                nullable: true
              example:
                - asins:
                    - B001TJ3HUG
                    - B01LW2SL7R
                  language_name: English
                  location_code: 2840
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/DataforseoLabsAmazonProductRankOverviewLiveResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/dataforseo_labs/amazon/product_competitors/live:
    post:
      tags:
        - DataforseoLabs
      description: "‌\nThis endpoint will provide you with a list of products that intersect with a target asin in Amazon SERPs. The data can help you identify product competitors for any listing published on Amazon. The returned results are specific to the asin as well as the location and language parameters specified in a POST request."
      operationId: AmazonProductCompetitorsLive
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/DataforseoLabsAmazonProductCompetitorsLiveRequestInfo'
                nullable: true
              example:
                - asin: 019005476X
                  location_code: 2840
                  language_code: en
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/DataforseoLabsAmazonProductCompetitorsLiveResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/dataforseo_labs/amazon/product_keyword_intersections/live:
    post:
      tags:
        - DataforseoLabs
      description: "‌\nThis endpoint will provide you with a list of keywords for which the target products intersect in Amazon SERP. The returned results are specific to the asins specified in a POST request. Learn more about ASIN in this help center article."
      operationId: AmazonProductKeywordIntersectionsLive
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/DataforseoLabsAmazonProductKeywordIntersectionsLiveRequestInfo'
                nullable: true
              example:
                - asins:
                    '1': B09172433Z
                    '2': B07GBZ4Q68
                    '3': B07GCKQD77
                  language_name: English
                  location_code: 2840
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/DataforseoLabsAmazonProductKeywordIntersectionsLiveResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/dataforseo_labs/google/bulk_app_metrics/live:
    post:
      tags:
        - DataforseoLabs
      description: "‌\nThis endpoint will provide you with ranking metrics for up to 1000 Google Play applications."
      operationId: GoogleBulkAppMetricsLive
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/DataforseoLabsGoogleBulkAppMetricsLiveRequestInfo'
                nullable: true
              example:
                - app_ids:
                    - org.telegram.messenger
                    - com.zhiliaoapp.musically
                  language_name: English
                  location_code: 2840
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/DataforseoLabsGoogleBulkAppMetricsLiveResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/dataforseo_labs/google/keywords_for_app/live:
    post:
      tags:
        - DataforseoLabs
      description: "‌\nThis endpoint will provide you with a list of keywords for which the target app ranks on Google Play. You will obtain keyword data and discover the app’s ranking position for each returned keyword."
      operationId: GoogleKeywordsForAppLive
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/DataforseoLabsGoogleKeywordsForAppLiveRequestInfo'
                nullable: true
              example:
                - app_id: org.telegram.messenger
                  language_name: English
                  location_code: 2840
                  limit: 10
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/DataforseoLabsGoogleKeywordsForAppLiveResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/dataforseo_labs/google/app_competitors/live:
    post:
      tags:
        - DataforseoLabs
      description: "‌\nThis endpoint will provide you with a list of mobile applications that intersect with the target app for its ranking keywords on Google Play. You will obtain the IDs of competitor apps along with search volume and ranking data on competitor ranking keywords."
      operationId: GoogleAppCompetitorsLive
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/DataforseoLabsGoogleAppCompetitorsLiveRequestInfo'
                nullable: true
              example:
                - app_id: org.telegram.messenger
                  language_name: English
                  location_code: 2840
                  limit: 10
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/DataforseoLabsGoogleAppCompetitorsLiveResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/dataforseo_labs/google/app_intersection/live:
    post:
      tags:
        - DataforseoLabs
      description: "‌\nThis endpoint will provide you with a list of keywords for which the mobile applications specified in the app_ids object rank within the same Google Play SERP."
      operationId: GoogleAppIntersectionLive
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/DataforseoLabsGoogleAppIntersectionLiveRequestInfo'
                nullable: true
              example:
                - app_ids:
                    '1': '686449807'
                    '2': '382617920'
                  language_name: English
                  location_code: 2840
                  limit: 10
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/DataforseoLabsGoogleAppIntersectionLiveResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/dataforseo_labs/apple/bulk_app_metrics/live:
    post:
      tags:
        - DataforseoLabs
      description: "‌\nThis endpoint will provide you with ranking metrics for up to 1000 App Store applications."
      operationId: AppleBulkAppMetricsLive
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/DataforseoLabsAppleBulkAppMetricsLiveRequestInfo'
                nullable: true
              example:
                - app_ids:
                    - '686449807'
                    - '382617920'
                  language_name: English
                  location_code: 2840
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/DataforseoLabsAppleBulkAppMetricsLiveResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/dataforseo_labs/apple/keywords_for_app/live:
    post:
      tags:
        - DataforseoLabs
      description: "‌\nThis endpoint will provide you with a list of keywords for which the target app ranks on App Store. You will obtain keyword data and discover the app’s ranking position for each returned keyword."
      operationId: AppleKeywordsForAppLive
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/DataforseoLabsAppleKeywordsForAppLiveRequestInfo'
                nullable: true
              example:
                - app_id: '686449807'
                  language_name: English
                  location_code: 2840
                  limit: 10
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/DataforseoLabsAppleKeywordsForAppLiveResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/dataforseo_labs/apple/app_competitors/live:
    post:
      tags:
        - DataforseoLabs
      description: "‌\nThis endpoint will provide you with a list of mobile applications that intersect with the target app for its ranking keywords on App Store. You will obtain the IDs of competitor apps along with search volume and ranking data on competitor ranking keywords."
      operationId: AppleAppCompetitorsLive
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/DataforseoLabsAppleAppCompetitorsLiveRequestInfo'
                nullable: true
              example:
                - app_id: '686449807'
                  language_name: English
                  location_code: 2840
                  limit: 10
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/DataforseoLabsAppleAppCompetitorsLiveResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/dataforseo_labs/apple/app_intersection/live:
    post:
      tags:
        - DataforseoLabs
      description: "‌\nThis endpoint will provide you with a list of keywords for which the mobile applications specified in the app_ids object rank within the same App Store SERP."
      operationId: AppleAppIntersectionLive
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/DataforseoLabsAppleAppIntersectionLiveRequestInfo'
                nullable: true
              example:
                - app_ids:
                    '1': '686449807'
                    '2': '382617920'
                  language_name: English
                  location_code: 2840
                  limit: 10
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/DataforseoLabsAppleAppIntersectionLiveResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/domain_analytics/id_list:
    post:
      tags:
        - DomainAnalytics
      description: 'This endpoint is designed to provide you with a list of IDs and metadata for all Domain Analytics tasks created within the specified time period, including both successful and uncompleted tasks.'
      operationId: DomainAnalyticsIdList
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/DomainAnalyticsIdListRequestInfo'
                nullable: true
              example:
                - datetime_from: '2026-09-10 11:12:35'
                  datetime_to: '2026-09-20 11:12:35'
                  limit: 10
                  include_metadata: true
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/DomainAnalyticsIdListResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/domain_analytics/errors:
    post:
      tags:
        - DomainAnalytics
      description: By calling this endpoint you will receive information about the Domain Analytics API tasks that returned an error within the past 7 days.
      operationId: DomainAnalyticsErrors
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/DomainAnalyticsErrorsRequestInfo'
                nullable: true
              example:
                - limit: 10
                  offset: 0
                  filtered_function: pingback_url
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/DomainAnalyticsErrorsResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/domain_analytics/technologies/available_filters:
    get:
      tags:
        - DomainAnalytics
      description: "‌‌\nHere you will find all the necessary information about filters that can be used with Domain Analytics Technologies API endpoints."
      operationId: TechnologiesAvailableFilters
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/DomainAnalyticsTechnologiesAvailableFiltersResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/domain_analytics/technologies/locations:
    get:
      tags:
        - DomainAnalytics
      description: You will receive the list of locations by this API call.
      operationId: TechnologiesLocations
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/DomainAnalyticsTechnologiesLocationsResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/domain_analytics/technologies/languages:
    get:
      tags:
        - DomainAnalytics
      description: "You will receive the list of languages by calling this API.\n \nAs a response of the API server, you will receive JSON-encoded data containing a tasks array with the information specific to the set tasks."
      operationId: TechnologiesLanguages
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/DomainAnalyticsTechnologiesLanguagesResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/domain_analytics/technologies/technologies:
    get:
      tags:
        - DomainAnalytics
      description: This endpoint will provide you with the full list of available technologies structured by technology groups and categories each particular technology belongs to.
      operationId: TechnologiesTechnologies
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/DomainAnalyticsTechnologiesTechnologiesResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/domain_analytics/technologies/aggregation_technologies/live:
    post:
      tags:
        - DomainAnalytics
      description: "‌‌\nThe Aggregation Technologies endpoint will provide you with a list of the most popular technologies websites use alongside the technologies you specify. Alternatively, you can specify technology categories or groups to obtain wider stats."
      operationId: TechnologiesAggregationTechnologiesLive
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/DomainAnalyticsTechnologiesAggregationTechnologiesLiveRequestInfo'
                nullable: true
              example:
                - mode: entry
                  technology: Nginx
                  keyword: WordPress
                  filters:
                    - 
                      - country_iso_code
                      - =
                      - US
                    - and
                    - 
                      - domain_rank
                      - '>'
                      - 800
                  order_by:
                    - 'groups_count,desc'
                  limit: 10
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/DomainAnalyticsTechnologiesAggregationTechnologiesLiveResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/domain_analytics/technologies/technologies_summary/live:
    post:
      tags:
        - DomainAnalytics
      description: "‌‌\nThe Technologies Summary endpoint will provide you with the number of domains across different countries and languages that use the specified technology names, technology groups, or technology categories."
      operationId: TechnologiesTechnologiesSummaryLive
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/DomainAnalyticsTechnologiesTechnologiesSummaryLiveRequestInfo'
                nullable: true
              example:
                - mode: entry
                  technologies:
                    - Ngi
                  keywords:
                    - WordPress
                  filters:
                    - 
                      - country_iso_code
                      - =
                      - US
                    - and
                    - 
                      - domain_rank
                      - '>'
                      - 800
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/DomainAnalyticsTechnologiesTechnologiesSummaryLiveResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/domain_analytics/technologies/technology_stats/live:
    post:
      tags:
        - DomainAnalytics
      description: "‌‌\nThe Technology Stats endpoint will provide you with historical data on the number of domains across different countries and languages that use the specified technology."
      operationId: TechnologiesTechnologyStatsLive
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/DomainAnalyticsTechnologiesTechnologyStatsLiveRequestInfo'
                nullable: true
              example:
                - technology: jQuery
                  date_from: '2022-10-31'
                  date_to: '2023-06-01'
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/DomainAnalyticsTechnologiesTechnologyStatsLiveResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/domain_analytics/technologies/domains_by_technology/live:
    post:
      tags:
        - DomainAnalytics
      description: "‌‌\nThis endpoint provides domains based on the technology they use. In addition to the list of domains, you will also get their technology profiles, the country and language they belong to, and other related data."
      operationId: TechnologiesDomainsByTechnologyLive
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/DomainAnalyticsTechnologiesDomainsByTechnologyLiveRequestInfo'
                nullable: true
              example:
                - technologies:
                    - Nginx
                  filters:
                    - 
                      - country_iso_code
                      - =
                      - US
                    - and
                    - 
                      - domain_rank
                      - '>'
                      - 800
                  order_by:
                    - 'last_visited,desc'
                  limit: 10
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/DomainAnalyticsTechnologiesDomainsByTechnologyLiveResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/domain_analytics/technologies/domains_by_html_terms/live:
    post:
      tags:
        - DomainAnalytics
      description: "‌‌\nThis endpoint provides domains based on the HTML terms they use on their homepage. In addition to the list of domains, you will also get their technology profiles, the country and language they belong to, and other related data."
      operationId: TechnologiesDomainsByHtmlTermsLive
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/DomainAnalyticsTechnologiesDomainsByHtmlTermsLiveRequestInfo'
                nullable: true
              example:
                - search_terms:
                    - data-attrid
                  order_by:
                    - 'last_visited,desc'
                  limit: 10
                  offset: 0
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/DomainAnalyticsTechnologiesDomainsByHtmlTermsLiveResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/domain_analytics/technologies/domain_technologies/live:
    post:
      tags:
        - DomainAnalytics
      description: "‌‌\nUsing this endpoint you will get a list of technologies used in a particular domain."
      operationId: TechnologiesDomainTechnologiesLive
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/DomainAnalyticsTechnologiesDomainTechnologiesLiveRequestInfo'
                nullable: true
              example:
                - target: dataforseo.com
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/DomainAnalyticsTechnologiesDomainTechnologiesLiveResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/domain_analytics/whois/available_filters:
    get:
      tags:
        - DomainAnalytics
      description: "‌‌\nHere you will find all the necessary information about filters that can be used with Domain Analytics Whois API."
      operationId: WhoisAvailableFilters
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/DomainAnalyticsWhoisAvailableFiltersResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/domain_analytics/whois/overview/live:
    post:
      tags:
        - DomainAnalytics
      description: "‌\nThis endpoint will provide you with Whois data enriched with backlink stats, and ranking and traffic info from organic and paid search results. Using this endpoint you will be able to get all these data for the domains matching the parameters you specify in the request."
      operationId: WhoisOverviewLive
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/DomainAnalyticsWhoisOverviewLiveRequestInfo'
                nullable: true
              example:
                - limit: 2
                  filters:
                    - 
                      - epp_status_codes
                      - in
                      - 
                        - client_transfer_prohibited
                        - client_update_prohibited
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/DomainAnalyticsWhoisOverviewLiveResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/keywords_data/id_list:
    post:
      tags:
        - KeywordsData
      description: 'This endpoint is designed to provide you with a list of IDs and metadata for all Keywords Data tasks created within the specified time period, including both successful and uncompleted tasks.'
      operationId: KeywordsDataIdList
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/KeywordsDataIdListRequestInfo'
                nullable: true
              example:
                - datetime_from: '2026-09-10 11:12:35'
                  datetime_to: '2026-09-20 11:12:35'
                  limit: 10
                  include_metadata: true
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/KeywordsDataIdListResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/keywords_data/errors:
    post:
      tags:
        - KeywordsData
      description: By calling this endpoint you will receive information about the Keywords Data API tasks that returned an error within the past 7 days.
      operationId: KeywordsDataErrors
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/KeywordsDataErrorsRequestInfo'
                nullable: true
              example:
                - limit: 10
                  offset: 0
                  filtered_function: pingback_url
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/KeywordsDataErrorsResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/keywords_data/google_ads/status:
    get:
      tags:
        - KeywordsData
      description: "‌\nBy calling this endpoint, you will know if Google updated keyword data for the previous month. Generally, Google updates keyword data in the middle of the month. So, if Google updated its data in October, you would be able to see the actual search volume, cost-per-click, competition, and other metrics for September. If Google didn’t update its data in October, the latest information would be available for August."
      operationId: GoogleAdsStatus
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/KeywordsDataGoogleAdsStatusResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/keywords_data/google_ads/locations:
    get:
      tags:
        - KeywordsData
      description: "‌\nWe use Google Geographical Targeting. You can refer to Google Ads Target Types page to review the full list of possible location types. With Keywords Data API, you can select any location type supported by Google, except for “Okrug”.\nPostal Codes can be used to set a task, albeit API response will not return data for such tasks."
      operationId: GoogleAdsLocations
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/KeywordsDataGoogleAdsLocationsResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  '/v3/keywords_data/google_ads/locations/{country}':
    get:
      tags:
        - KeywordsData
      description: "‌\nWe use Google Geographical Targeting. You can refer to Google Ads Target Types page to review the full list of possible location types. With Keywords Data API, you can select any location type supported by Google, except for “Okrug”.\nPostal Codes can be used to set a task, albeit API response will not return data for such tasks."
      operationId: GoogleAdsLocationsCountry
      parameters:
        - name: country
          in: path
          description: "country ISO code\noptional field\nspecify the ISO code if you want to filter the list of locations by country\nexample:\nus"
          required: true
          schema:
            type: string
          example: us
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/KeywordsDataGoogleAdsLocationsCountryResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/keywords_data/google_ads/languages:
    get:
      tags:
        - KeywordsData
      description: "By calling this API you will receive the list of languages supported by Keywords Data API.\n‌\n‌‌As a response of the API server, you will receive JSON-encoded data containing a tasks array with the information about available languages."
      operationId: GoogleAdsLanguages
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/KeywordsDataGoogleAdsLanguagesResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/keywords_data/google_ads/search_volume/task_post:
    post:
      tags:
        - KeywordsData
      description: "‌\nNote that Google Ads Keywords Data API is based on the latest version of the Google Ads API that has replaced legacy Google AdWords API. If you’re using DataForSEO Google AdWords API, you need to upgrade to DataForSEO Google Ads API."
      operationId: GoogleAdsSearchVolumeTaskPost
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/KeywordsDataGoogleAdsSearchVolumeTaskPostRequestInfo'
                nullable: true
              example:
                - location_name: United States
                  keywords:
                    - buy laptop
                    - cheap laptops for sale
                    - purchase laptop
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/KeywordsDataGoogleAdsSearchVolumeTaskPostResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/keywords_data/google_ads/search_volume/tasks_ready:
    get:
      tags:
        - KeywordsData
      description: "‌\nThis endpoint is designed to provide you with a list of completed tasks, which haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed tasks using this endpoint. Then, you can collect the results using the ‘Task GET’ endpoint."
      operationId: GoogleAdsSearchVolumeTasksReady
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/KeywordsDataGoogleAdsSearchVolumeTasksReadyResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  '/v3/keywords_data/google_ads/search_volume/task_get/{id}':
    get:
      tags:
        - KeywordsData
      description: "‌\nNote that Google Ads Keywords Data API is based on the latest version of the Google Ads API that has replaced legacy Google AdWords API. If you’re using DataForSEO Google AdWords API, you need to upgrade to DataForSEO Google Ads API."
      operationId: GoogleAdsSearchVolumeTaskGet
      parameters:
        - name: id
          in: path
          description: <em>task identifier</em><br><strong>unique task identifier in our system in the <a href="https://en.wikipedia.org/wiki/Universally_unique_identifier">UUID</a> format</strong><br>you will be able to use it within <strong>30 days</strong> to request the results of the task at any time
          required: true
          schema:
            type: string
          example: 00000000-0000-0000-0000-000000000000
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/KeywordsDataGoogleAdsSearchVolumeTaskGetResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/keywords_data/google_ads/search_volume/live:
    post:
      tags:
        - KeywordsData
      description: "‌\nNote that Google Ads Keywords Data API is based on the latest version of the Google Ads API that has replaced legacy Google AdWords API. If you’re using DataForSEO Google AdWords API, you need to upgrade to DataForSEO Google Ads API."
      operationId: GoogleAdsSearchVolumeLive
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/KeywordsDataGoogleAdsSearchVolumeLiveRequestInfo'
                nullable: true
              example:
                - location_code: 2840
                  keywords:
                    - buy laptop
                    - cheap laptops for sale
                    - purchase laptop
                  date_from: '2021-08-01'
                  search_partners: true
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/KeywordsDataGoogleAdsSearchVolumeLiveResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/keywords_data/google_ads/keywords_for_site/task_post:
    post:
      tags:
        - KeywordsData
      description: ‌
      operationId: GoogleAdsKeywordsForSiteTaskPost
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/KeywordsDataGoogleAdsKeywordsForSiteTaskPostRequestInfo'
                nullable: true
              example:
                - location_code: 2840
                  target: dataforseo.com
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/KeywordsDataGoogleAdsKeywordsForSiteTaskPostResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/keywords_data/google_ads/keywords_for_site/tasks_ready:
    get:
      tags:
        - KeywordsData
      description: "‌\nThis endpoint is designed to provide you with a list of completed tasks, which haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed tasks using this endpoint. Then, you can collect the results using the ‘Task GET’ endpoint."
      operationId: GoogleAdsKeywordsForSiteTasksReady
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/KeywordsDataGoogleAdsKeywordsForSiteTasksReadyResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  '/v3/keywords_data/google_ads/keywords_for_site/task_get/{id}':
    get:
      tags:
        - KeywordsData
      description: "‌\nNote that Google Ads Keywords Data API is based on the latest version of the Google Ads API that has replaced legacy Google AdWords API. If you’re using DataForSEO Google AdWords API, you need to upgrade to DataForSEO Google Ads API.\n‌‌\nThis endpoint will provide you with a list of keywords relevant to the specified domain along with their bids, search volumes for the last month, search volume trends for the last year (for estimating search volume dynamics), and competition levels."
      operationId: GoogleAdsKeywordsForSiteTaskGet
      parameters:
        - name: id
          in: path
          description: <em>task identifier</em><br><strong>unique task identifier in our system in the <a href="https://en.wikipedia.org/wiki/Universally_unique_identifier">UUID</a> format</strong><br>you will be able to use it within <strong>30 days</strong> to request the results of the task at any time
          required: true
          schema:
            type: string
          example: 00000000-0000-0000-0000-000000000000
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/KeywordsDataGoogleAdsKeywordsForSiteTaskGetResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/keywords_data/google_ads/keywords_for_site/live:
    post:
      tags:
        - KeywordsData
      description: "Note that Google Ads Keywords Data API is based on the latest version of the Google Ads API that has replaced legacy Google AdWords API. If you’re using DataForSEO Google AdWords API, you need to upgrade to DataForSEO Google Ads API.\n‌‌\nThis endpoint will provide you with a list of keywords relevant to the specified domain along with their bids, search volumes for the last month, search volume trends for the last year (for estimating search volume dynamics), and competition levels."
      operationId: GoogleAdsKeywordsForSiteLive
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/KeywordsDataGoogleAdsKeywordsForSiteLiveRequestInfo'
                nullable: true
              example:
                - location_code: 2840
                  target: dataforseo.com
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/KeywordsDataGoogleAdsKeywordsForSiteLiveResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/keywords_data/google_ads/keywords_for_keywords/task_post:
    post:
      tags:
        - KeywordsData
      description: "Note that Google Ads Keywords Data API is based on the latest version of the Google Ads API that has replaced legacy Google AdWords API. If you’re using DataForSEO Google AdWords API, you need to upgrade to DataForSEO Google Ads API.\n‌‌\nThis endpoint will provide relevant keywords for the specified terms. Set up to 20 keywords in the keywords array and get keyword suggestions from Google Ads. You can get up to 20,000 keyword suggestions with all essential keyword data in response to one request."
      operationId: GoogleAdsKeywordsForKeywordsTaskPost
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/KeywordsDataGoogleAdsKeywordsForKeywordsTaskPostRequestInfo'
                nullable: true
              example:
                - location_code: 2840
                  keywords:
                    - phone
                    - cellphone
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/KeywordsDataGoogleAdsKeywordsForKeywordsTaskPostResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/keywords_data/google_ads/keywords_for_keywords/tasks_ready:
    get:
      tags:
        - KeywordsData
      description: "‌\nThis endpoint is designed to provide you with a list of completed tasks, which haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed tasks using this endpoint. Then, you can collect the results using the ‘Task GET’ endpoint."
      operationId: GoogleAdsKeywordsForKeywordsTasksReady
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/KeywordsDataGoogleAdsKeywordsForKeywordsTasksReadyResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  '/v3/keywords_data/google_ads/keywords_for_keywords/task_get/{id}':
    get:
      tags:
        - KeywordsData
      description: "Note that Google Ads Keywords Data API is based on the latest version of the Google Ads API that has replaced legacy Google AdWords API. If you’re using DataForSEO Google AdWords API, you need to upgrade to DataForSEO Google Ads API.\n‌\nThis endpoint will select relevant keywords for the specified terms. Set up to 20 keywords and get the results, which are suggested by Google Ads for your query."
      operationId: GoogleAdsKeywordsForKeywordsTaskGet
      parameters:
        - name: id
          in: path
          description: <em>task identifier</em><br><strong>unique task identifier in our system in the <a href="https://en.wikipedia.org/wiki/Universally_unique_identifier">UUID</a> format</strong><br>you will be able to use it within <strong>30 days</strong> to request the results of the task at any time
          required: true
          schema:
            type: string
          example: 00000000-0000-0000-0000-000000000000
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/KeywordsDataGoogleAdsKeywordsForKeywordsTaskGetResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/keywords_data/google_ads/keywords_for_keywords/live:
    post:
      tags:
        - KeywordsData
      description: "Note that Google Ads Keywords Data API is based on the latest version of the Google Ads API that has replaced legacy Google AdWords API. If you’re using DataForSEO Google AdWords API, you need to upgrade to DataForSEO Google Ads API.\n‌‌\nThis endpoint will provide relevant keywords for the specified terms. Set up to 20 keywords in the keywords array and get keyword suggestions from Google Ads."
      operationId: GoogleAdsKeywordsForKeywordsLive
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/KeywordsDataGoogleAdsKeywordsForKeywordsLiveRequestInfo'
                nullable: true
              example:
                - location_code: 2840
                  keywords:
                    - phone
                    - cellphone
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/KeywordsDataGoogleAdsKeywordsForKeywordsLiveResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/keywords_data/google_ads/ad_traffic_by_keywords/task_post:
    post:
      tags:
        - KeywordsData
      description: ''
      operationId: GoogleAdsAdTrafficByKeywordsTaskPost
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/KeywordsDataGoogleAdsAdTrafficByKeywordsTaskPostRequestInfo'
                nullable: true
              example:
                - language_code: en
                  location_code: 2840
                  bid: 999
                  match: exact
                  keywords:
                    - seo marketing
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/KeywordsDataGoogleAdsAdTrafficByKeywordsTaskPostResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/keywords_data/google_ads/ad_traffic_by_keywords/tasks_ready:
    get:
      tags:
        - KeywordsData
      description: "‌\nThis endpoint is designed to provide you with a list of completed tasks, which haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed tasks using this endpoint. Then, you can collect the results using the ‘Task GET’ endpoint."
      operationId: GoogleAdsAdTrafficByKeywordsTasksReady
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/KeywordsDataGoogleAdsAdTrafficByKeywordsTasksReadyResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  '/v3/keywords_data/google_ads/ad_traffic_by_keywords/task_get/{id}':
    get:
      tags:
        - KeywordsData
      description: ''
      operationId: GoogleAdsAdTrafficByKeywordsTaskGet
      parameters:
        - name: id
          in: path
          description: <em>task identifier</em><br><strong>unique task identifier in our system in the <a href="https://en.wikipedia.org/wiki/Universally_unique_identifier">UUID</a> format</strong><br>you will be able to use it within <strong>30 days</strong> to request the results of the task at any time
          required: true
          schema:
            type: string
          example: 00000000-0000-0000-0000-000000000000
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/KeywordsDataGoogleAdsAdTrafficByKeywordsTaskGetResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/keywords_data/google_ads/ad_traffic_by_keywords/live:
    post:
      tags:
        - KeywordsData
      description: ''
      operationId: GoogleAdsAdTrafficByKeywordsLive
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/KeywordsDataGoogleAdsAdTrafficByKeywordsLiveRequestInfo'
                nullable: true
              example:
                - location_code: 2840
                  language_code: en
                  bid: 999
                  match: exact
                  keywords:
                    - seo marketing
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/KeywordsDataGoogleAdsAdTrafficByKeywordsLiveResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/keywords_data/google_trends/locations:
    get:
      tags:
        - KeywordsData
      description: ‌
      operationId: GoogleTrendsLocations
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/KeywordsDataGoogleTrendsLocationsResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  '/v3/keywords_data/google_trends/locations/{country}':
    get:
      tags:
        - KeywordsData
      description: ‌
      operationId: GoogleTrendsLocationsCountry
      parameters:
        - name: country
          in: path
          description: <em>country ISO code</em><br>optional field<br>specify the ISO code if you want to filter the list of locations by country<br>example:<br><code>us</code>
          required: true
          schema:
            type: string
          example: us
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/KeywordsDataGoogleTrendsLocationsCountryResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/keywords_data/google_trends/languages:
    get:
      tags:
        - KeywordsData
      description: "By calling this API you will receive the list of languages supported by Google Trends API.\n‌\n‌‌As a response of the API server, you will receive JSON-encoded data containing a tasks array with the information about available languages."
      operationId: GoogleTrendsLanguages
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/KeywordsDataGoogleTrendsLanguagesResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/keywords_data/google_trends/categories:
    get:
      tags:
        - KeywordsData
      description: "By calling this API you will receive the list of categories supported by Google Trends API.\n‌\n‌‌As a response of the API server, you will receive JSON-encoded data containing a tasks array with the information about available categories."
      operationId: GoogleTrendsCategories
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/KeywordsDataGoogleTrendsCategoriesResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/keywords_data/google_trends/explore/task_post:
    post:
      tags:
        - KeywordsData
      description: "‌\nThis endpoint will provide you with the keyword popularity data from the ‘Explore’ feature of Google Trends. You can check keyword trends for Google Search, Google News, Google Images, Google Shopping, and YouTube."
      operationId: GoogleTrendsExploreTaskPost
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/KeywordsDataGoogleTrendsExploreTaskPostRequestInfo'
                nullable: true
              example:
                - date_from: '2019-01-01'
                  date_to: '2020-01-01'
                  type: youtube
                  category_code: 3
                  keywords:
                    - seo api
                    - rank api
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/KeywordsDataGoogleTrendsExploreTaskPostResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/keywords_data/google_trends/explore/tasks_ready:
    get:
      tags:
        - KeywordsData
      description: "‌\nThis endpoint is designed to provide you with a list of completed tasks, which haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed tasks using this endpoint. Then, you can collect the results using the ‘Task GET’ endpoint."
      operationId: GoogleTrendsExploreTasksReady
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/KeywordsDataGoogleTrendsExploreTasksReadyResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  '/v3/keywords_data/google_trends/explore/task_get/{id}':
    get:
      tags:
        - KeywordsData
      description: ‌
      operationId: GoogleTrendsExploreTaskGet
      parameters:
        - name: id
          in: path
          description: <em>task identifier</em><br><strong>unique task identifier in our system in the <a href="https://en.wikipedia.org/wiki/Universally_unique_identifier">UUID</a> format</strong><br>you will be able to use it within <strong>30 days</strong> to request the results of the task at any time
          required: true
          schema:
            type: string
          example: 00000000-0000-0000-0000-000000000000
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/KeywordsDataGoogleTrendsExploreTaskGetResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/keywords_data/google_trends/explore/live:
    post:
      tags:
        - KeywordsData
      description: 'This endpoint will provide you with the keyword popularity data from the ‘Explore’ feature of Google Trends. You can check keyword trends for Google Search, Google News, Google Images, Google Shopping, and YouTube.'
      operationId: GoogleTrendsExploreLive
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/KeywordsDataGoogleTrendsExploreLiveRequestInfo'
                nullable: true
              example:
                - location_name: United States
                  date_from: '2019-01-01'
                  date_to: '2020-01-01'
                  type: youtube
                  category_code: 3
                  keywords:
                    - rugby
                    - cricket
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/KeywordsDataGoogleTrendsExploreLiveResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/keywords_data/dataforseo_trends/locations:
    get:
      tags:
        - KeywordsData
      description: You will receive the list of DataForSEO Trends locations by calling this API. You can filter the list of locations by country when setting a task. Please note that the minimum geographic scope supported for the DataForSEO Trends API is country level.
      operationId: DataforseoTrendsLocations
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/KeywordsDataDataforseoTrendsLocationsResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  '/v3/keywords_data/dataforseo_trends/locations/{country}':
    get:
      tags:
        - KeywordsData
      description: You will receive the list of DataForSEO Trends locations by calling this API. You can filter the list of locations by country when setting a task. Please note that the minimum geographic scope supported for the DataForSEO Trends API is country level.
      operationId: DataforseoTrendsLocationsCountry
      parameters:
        - name: country
          in: path
          description: <em>country ISO code</em><br>optional field<br>specify the ISO code if you want to filter the list of locations by country<br>example:<br><code>us</code>
          required: true
          schema:
            type: string
          example: us
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/KeywordsDataDataforseoTrendsLocationsCountryResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/keywords_data/dataforseo_trends/explore/live:
    post:
      tags:
        - KeywordsData
      description: 'This endpoint will provide you with the keyword popularity data from DataForSEO Trends. You can check keyword trends for Google Search, Google News, and Google Shopping.'
      operationId: DataforseoTrendsExploreLive
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/KeywordsDataDataforseoTrendsExploreLiveRequestInfo'
                nullable: true
              example:
                - keywords:
                    - iphone 14
                    - samsung s23
                  location_code: 2840
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/KeywordsDataDataforseoTrendsExploreLiveResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/keywords_data/dataforseo_trends/subregion_interests/live:
    post:
      tags:
        - KeywordsData
      description: 'This endpoint will provide you with location-specific keyword popularity data from DataForSEO Trends. You can check keyword trends for Google Search, Google News, and Google Shopping.'
      operationId: DataforseoTrendsSubregionInterestsLive
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/KeywordsDataDataforseoTrendsSubregionInterestsLiveRequestInfo'
                nullable: true
              example:
                - keywords:
                    - rugby
                    - cricket
                  date_from: '2023-01-01'
                  date_to: '2024-01-01'
                  type: web
                  location_name: United States
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/KeywordsDataDataforseoTrendsSubregionInterestsLiveResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/keywords_data/dataforseo_trends/demography/live:
    post:
      tags:
        - KeywordsData
      description: 'This endpoint will provide you with the demographic breakdown (by age and gender) of keyword popularity per each specified term based on DataForSEO Trends data. You can check keyword trends for Google Search, Google News, and Google Shopping.'
      operationId: DataforseoTrendsDemographyLive
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/KeywordsDataDataforseoTrendsDemographyLiveRequestInfo'
                nullable: true
              example:
                - keywords:
                    - rugby
                    - cricket
                  date_from: '2023-01-01'
                  date_to: '2024-01-01'
                  type: web
                  location_name: United States
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/KeywordsDataDataforseoTrendsDemographyLiveResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/keywords_data/dataforseo_trends/merged_data/live:
    post:
      tags:
        - KeywordsData
      description: 'This endpoint will provide you with the keyword popularity data from DataForSEO Trends. In addition to keyword popularity rate over the given time range, you will get location-specific keyword popularity data, and a demographic breakdown of keyword popularity per each specified term along with comparative values.'
      operationId: DataforseoTrendsMergedDataLive
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/KeywordsDataDataforseoTrendsMergedDataLiveRequestInfo'
                nullable: true
              example:
                - keywords:
                    - rugby
                    - cricket
                  date_from: '2023-01-01'
                  date_to: '2024-01-01'
                  type: web
                  location_name: United States
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/KeywordsDataDataforseoTrendsMergedDataLiveResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/keywords_data/bing/locations:
    get:
      tags:
        - KeywordsData
      description: By calling this API you will receive the list of locations supported in Bing Ads API.
      operationId: KeywordsDataBingLocations
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/KeywordsDataBingLocationsResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/keywords_data/bing/languages:
    get:
      tags:
        - KeywordsData
      description: By calling this API you will receive the list of languages supported by Bing Ads API.
      operationId: KeywordsDataBingLanguages
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/KeywordsDataBingLanguagesResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/keywords_data/bing/search_volume/task_post:
    post:
      tags:
        - KeywordsData
      description: "‌\nThis endpoint will provide you with search volume data for the last month, search volume trend for up to 24 past months (that will let you estimate search volume dynamics), current cost-per-click and competition values for paid search."
      operationId: BingSearchVolumeTaskPost
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/KeywordsDataBingSearchVolumeTaskPostRequestInfo'
                nullable: true
              example:
                - location_name: United States
                  language_name: English
                  keywords:
                    - average page rpm adsense
                    - adsense blank ads how long
                    - leads and prospects
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/KeywordsDataBingSearchVolumeTaskPostResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/keywords_data/bing/search_volume/tasks_ready:
    get:
      tags:
        - KeywordsData
      description: "‌\nThis endpoint is designed to provide you with the list of completed tasks, which haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed tasks using this endpoint. Then, you can collect the results using the ‘Task GET’ endpoint."
      operationId: BingSearchVolumeTasksReady
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/KeywordsDataBingSearchVolumeTasksReadyResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  '/v3/keywords_data/bing/search_volume/task_get/{id}':
    get:
      tags:
        - KeywordsData
      description: ‌
      operationId: BingSearchVolumeTaskGet
      parameters:
        - name: id
          in: path
          description: <em>task identifier</em><br><strong>unique task identifier in our system in the <a href="https://en.wikipedia.org/wiki/Universally_unique_identifier">UUID</a> format</strong><br>you will be able to use it within <strong>30 days</strong> to request the results of the task at any time
          required: true
          schema:
            type: string
          example: 00000000-0000-0000-0000-000000000000
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/KeywordsDataBingSearchVolumeTaskGetResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/keywords_data/bing/search_volume/live:
    post:
      tags:
        - KeywordsData
      description: '‌This endpoint will provide you with search volume data for the last month, search volume trend for up to 24 past months (that will let you estimate search volume dynamics), current cost-per-click and competition values for paid search.'
      operationId: BingSearchVolumeLive
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/KeywordsDataBingSearchVolumeLiveRequestInfo'
                nullable: true
              example:
                - location_name: United States
                  language_code: en
                  keywords:
                    - tom and jerry
                    - silicon valley
                    - spider man
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/KeywordsDataBingSearchVolumeLiveResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/keywords_data/bing/audience_estimation/job_functions:
    get:
      tags:
        - KeywordsData
      description: By calling this API you will receive the list of job functions with job_function_id supported by Bing Ads Audience Estimation endpoint.
      operationId: BingAudienceEstimationJobFunctions
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/KeywordsDataBingAudienceEstimationJobFunctionsResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/keywords_data/bing/audience_estimation/industries:
    get:
      tags:
        - KeywordsData
      description: By calling this API you will receive the list of industries with industry_id supported by Bing Ads Audience Estimation endpoint.
      operationId: BingAudienceEstimationIndustries
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/KeywordsDataBingAudienceEstimationIndustriesResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/keywords_data/bing/audience_estimation/task_post:
    post:
      tags:
        - KeywordsData
      description: "‌\nThis endpoint provides estimated audience size for an ad campaign based on specified targeting criteria. It returns data on the total estimated audience, such as suggested bid and budget for an ad campaign and estimated engagement metrics."
      operationId: BingAudienceEstimationTaskPost
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/KeywordsDataBingAudienceEstimationTaskPostRequestInfo'
                nullable: true
              example:
                - location_coordinate: '29.6821525,-82.4098881,100'
                  age:
                    - twenty_five_to_thirty_four
                    - eighteen_to_twenty_four
                    - unknown
                  bid: 1
                  daily_budget: 24
                  gender:
                    - male
                  industry:
                    - '806303407'
                    - '806301758'
                  job_function:
                    - '806298607'
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/KeywordsDataBingAudienceEstimationTaskPostResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/keywords_data/bing/audience_estimation/tasks_ready:
    get:
      tags:
        - KeywordsData
      description: "‌\nThis endpoint is designed to provide you with the list of completed tasks, which haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed tasks using this endpoint. Then, you can collect the results using the ‘Task GET’ endpoint."
      operationId: BingAudienceEstimationTasksReady
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/KeywordsDataBingAudienceEstimationTasksReadyResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  '/v3/keywords_data/bing/audience_estimation/task_get/{id}':
    get:
      tags:
        - KeywordsData
      description: ‌
      operationId: BingAudienceEstimationTaskGet
      parameters:
        - name: id
          in: path
          description: <em>task identifier</em><br><strong>unique task identifier in our system in the <a href="https://en.wikipedia.org/wiki/Universally_unique_identifier">UUID</a> format</strong><br>you will be able to use it within <strong>30 days</strong> to request the results of the task at any time
          required: true
          schema:
            type: string
          example: 00000000-0000-0000-0000-000000000000
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/KeywordsDataBingAudienceEstimationTaskGetResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/keywords_data/bing/audience_estimation/live:
    post:
      tags:
        - KeywordsData
      description: 'This endpoint provides estimated audience size for an ad campaign based on specified targeting criteria. It returns data on the total estimated audience, such as suggested bid and budget for an ad campaign and estimated engagement metrics.'
      operationId: BingAudienceEstimationLive
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/KeywordsDataBingAudienceEstimationLiveRequestInfo'
                nullable: true
              example:
                - location_coordinate: '29.6821525,-82.4098881,100'
                  age:
                    - twenty_five_to_thirty_four
                    - eighteen_to_twenty_four
                    - unknown
                  bid: 1
                  daily_budget: 24
                  gender:
                    - male
                  industry:
                    - '806303407'
                    - '806301758'
                  job_function:
                    - '806298607'
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/KeywordsDataBingAudienceEstimationLiveResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/keywords_data/bing/keywords_for_site/task_post:
    post:
      tags:
        - KeywordsData
      description: '‌This endpoint will provide you with a list of keywords relevant to the specified website along with their search volume for the last month, search volume trend for up to 24 past months (for estimating search volume dynamics), current cost-per-click and competition level for paid search. The maximum number of returned keywords is 3000.'
      operationId: BingKeywordsForSiteTaskPost
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/KeywordsDataBingKeywordsForSiteTaskPostRequestInfo'
                nullable: true
              example:
                - language_code: en
                  location_code: 2840
                  target: dataforseo.com
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/KeywordsDataBingKeywordsForSiteTaskPostResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/keywords_data/bing/keywords_for_site/tasks_ready:
    get:
      tags:
        - KeywordsData
      description: "‌\nThis endpoint is designed to provide you with the list of completed tasks, which haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed tasks using this endpoint. Then, you can collect the results using the ‘Task GET’ endpoint."
      operationId: BingKeywordsForSiteTasksReady
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/KeywordsDataBingKeywordsForSiteTasksReadyResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  '/v3/keywords_data/bing/keywords_for_site/task_get/{id}':
    get:
      tags:
        - KeywordsData
      description: "‌\nThis endpoint will provide you with a list of keywords relevant to the specified website along with their search volume for the last month, search volume trend for the last year (for estimating search volume dynamics), current cost-per-click and competition level for paid search. The maximum number of returned keywords is 3000."
      operationId: BingKeywordsForSiteTaskGet
      parameters:
        - name: id
          in: path
          description: <em>task identifier</em><br><strong>unique task identifier in our system in the <a href="https://en.wikipedia.org/wiki/Universally_unique_identifier">UUID</a> format</strong><br>you will be able to use it within <strong>30 days</strong> to request the results of the task at any time
          required: true
          schema:
            type: string
          example: 00000000-0000-0000-0000-000000000000
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/KeywordsDataBingKeywordsForSiteTaskGetResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/keywords_data/bing/keywords_for_site/live:
    post:
      tags:
        - KeywordsData
      description: '‌This endpoint will provide you with a list of keywords relevant to the specified URL along with their search volume for the last month, search volume trend for up to 24 past months (for estimating search volume dynamics), current cost-per-click and competition values for paid search. The maximum number of returned keywords is 3000.'
      operationId: BingKeywordsForSiteLive
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/KeywordsDataBingKeywordsForSiteLiveRequestInfo'
                nullable: true
              example:
                - language_code: en
                  location_code: 2840
                  target: dataforseo.com
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/KeywordsDataBingKeywordsForSiteLiveResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/keywords_data/bing/keywords_for_keywords/task_post:
    post:
      tags:
        - KeywordsData
      description: "‌‌\nThis endpoint will select relevant keywords for the specified terms. Set up to 200 keywords and get the results, which are suggested by Bing Ads for your query. You can get up to 3000 keyword suggestions using this function."
      operationId: BingKeywordsForKeywordsTaskPost
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/KeywordsDataBingKeywordsForKeywordsTaskPostRequestInfo'
                nullable: true
              example:
                - location_code: 2840
                  language_code: en
                  keywords:
                    - average page rpm adsense
                    - adsense blank ads how long
                    - leads and prospects
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/KeywordsDataBingKeywordsForKeywordsTaskPostResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/keywords_data/bing/keywords_for_keywords/tasks_ready:
    get:
      tags:
        - KeywordsData
      description: "‌\nThis endpoint is designed to provide you with the list of completed tasks, which haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed tasks using this endpoint. Then, you can collect the results using the ‘Task GET’ endpoint."
      operationId: BingKeywordsForKeywordsTasksReady
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/KeywordsDataBingKeywordsForKeywordsTasksReadyResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  '/v3/keywords_data/bing/keywords_for_keywords/task_get/{id}':
    get:
      tags:
        - KeywordsData
      description: "‌\nThis endpoint will select relevant keywords for the specified terms. Set up to 200 keywords and get the results, which are suggested by Bing Ads for your query. You can get up to 3000 keyword suggestions using this function."
      operationId: BingKeywordsForKeywordsTaskGet
      parameters:
        - name: id
          in: path
          description: <em>task identifier</em><br><strong>unique task identifier in our system in the <a href="https://en.wikipedia.org/wiki/Universally_unique_identifier">UUID</a> format</strong><br>you will be able to use it within <strong>30 days</strong> to request the results of the task at any time
          required: true
          schema:
            type: string
          example: 00000000-0000-0000-0000-000000000000
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/KeywordsDataBingKeywordsForKeywordsTaskGetResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/keywords_data/bing/keywords_for_keywords/live:
    post:
      tags:
        - KeywordsData
      description: "‌\nThis endpoint will select the relevant keywords for the specified ones. Set up to 200 keywords and get the results, which are suggested by Bing Ads for your query. You can get up to 3000 keyword suggestions using this function."
      operationId: BingKeywordsForKeywordsLive
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/KeywordsDataBingKeywordsForKeywordsLiveRequestInfo'
                nullable: true
              example:
                - location_name: United States
                  language_name: English
                  keywords:
                    - average page rpm adsense
                    - adsense blank ads how long
                    - leads and prospects
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/KeywordsDataBingKeywordsForKeywordsLiveResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/keywords_data/bing/keyword_performance/locations_and_languages:
    get:
      tags:
        - KeywordsData
      description: "‌\nUsing this endpoint you can get the full list of locations and languages supported in Keyword Performance endpoints of Bing Keywords Data API."
      operationId: BingKeywordPerformanceLocationsAndLanguages
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/KeywordsDataBingKeywordPerformanceLocationsAndLanguagesResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/keywords_data/bing/keyword_performance/task_post:
    post:
      tags:
        - KeywordsData
      description: "‌\nYou can receive a set of keyword performance stats for a group of keywords depending on the specified match type, location and language parameters. Ad position, clicks, impressions, and other keyword metrics are aggregated for the last month for one or all of the following device types: mobile, desktop, tablet."
      operationId: BingKeywordPerformanceTaskPost
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/KeywordsDataBingKeywordPerformanceTaskPostRequestInfo'
                nullable: true
              example:
                - location_code: 2840
                  language_code: en
                  keywords:
                    - dataforseo
                    - seo
                    - ranking
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/KeywordsDataBingKeywordPerformanceTaskPostResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/keywords_data/bing/keyword_performance/tasks_ready:
    get:
      tags:
        - KeywordsData
      description: "‌\nThis endpoint is designed to provide you with the list of completed tasks, which haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed tasks using this endpoint. Then, you can collect the results using the ‘Task GET’ endpoint."
      operationId: BingKeywordPerformanceTasksReady
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/KeywordsDataBingKeywordPerformanceTasksReadyResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  '/v3/keywords_data/bing/keyword_performance/task_get/{id}':
    get:
      tags:
        - KeywordsData
      description: "‌\nYou can receive a set of keyword performance stats for a group of keywords depending on the specified match type, location and language parameters. Ad position, clicks, impressions, and other keyword metrics are aggregated for the last month for one or all of the following device types: mobile, desktop, tablet."
      operationId: BingKeywordPerformanceTaskGet
      parameters:
        - name: id
          in: path
          description: <em>task identifier</em><br><strong>unique task identifier in our system in the <a href="https://en.wikipedia.org/wiki/Universally_unique_identifier">UUID</a> format</strong><br>you will be able to use it within <strong>30 days</strong> to request the results of the task at any time
          required: true
          schema:
            type: string
          example: 00000000-0000-0000-0000-000000000000
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/KeywordsDataBingKeywordPerformanceTaskGetResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/keywords_data/bing/keyword_performance/live:
    post:
      tags:
        - KeywordsData
      description: "‌\nYou can receive a set of keyword performance stats for a group of keywords depending on the specified match type, location and language parameters. Ad position, clicks, impressions, and other keyword metrics are aggregated for the last month for one or all of the following device types: mobile, desktop, tablet."
      operationId: BingKeywordPerformanceLive
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/KeywordsDataBingKeywordPerformanceLiveRequestInfo'
                nullable: true
              example:
                - location_code: 2840
                  language_code: en
                  keywords:
                    - dataforseo
                    - seo
                    - ranking
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/KeywordsDataBingKeywordPerformanceLiveResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/keywords_data/bing/search_volume_history/locations_and_languages:
    get:
      tags:
        - KeywordsData
      description: By calling this API you will receive the list of locations and languages supported by Bing ‘Search Volume History’ endpoint.
      operationId: BingSearchVolumeHistoryLocationsAndLanguages
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/KeywordsDataBingSearchVolumeHistoryLocationsAndLanguagesResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/keywords_data/bing/search_volume_history/task_post:
    post:
      tags:
        - KeywordsData
      description: "‌\nThis endpoint will provide you with historical search volume data for up to 1000 keywords in one request. You can get search volume for keywords in monthly, weekly, or daily format and specify the device type."
      operationId: BingSearchVolumeHistoryTaskPost
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/KeywordsDataBingSearchVolumeHistoryTaskPostRequestInfo'
                nullable: true
              example:
                - location_code: 2840
                  language_code: en
                  keywords:
                    - 10 minute timer
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/KeywordsDataBingSearchVolumeHistoryTaskPostResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/keywords_data/bing/search_volume_history/tasks_ready:
    get:
      tags:
        - KeywordsData
      description: "‌\nThis endpoint is designed to provide you with the list of completed tasks, which haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed tasks using this endpoint. Then, you can collect the results using the ‘Task GET’ endpoint."
      operationId: BingSearchVolumeHistoryTasksReady
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/KeywordsDataBingSearchVolumeHistoryTasksReadyResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  '/v3/keywords_data/bing/search_volume_history/task_get/{id}':
    get:
      tags:
        - KeywordsData
      description: ‌
      operationId: BingSearchVolumeHistoryTaskGet
      parameters:
        - name: id
          in: path
          description: <em>task identifier</em><br><strong>unique task identifier in our system in the <a href="https://en.wikipedia.org/wiki/Universally_unique_identifier">UUID</a> format</strong><br>you will be able to use it within <strong>30 days</strong> to request the results of the task at any time
          required: true
          schema:
            type: string
          example: 00000000-0000-0000-0000-000000000000
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/KeywordsDataBingSearchVolumeHistoryTaskGetResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/keywords_data/bing/search_volume_history/live:
    post:
      tags:
        - KeywordsData
      description: '‌This endpoint will provide you with historical search volume data for up to 1000 keywords in one request. You can get search volume for keywords in monthly, weekly, or daily format and specify the device type.'
      operationId: BingSearchVolumeHistoryLive
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/KeywordsDataBingSearchVolumeHistoryLiveRequestInfo'
                nullable: true
              example:
                - location_code: 2840
                  language_code: en
                  keywords:
                    - 10 minute timer
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/KeywordsDataBingSearchVolumeHistoryLiveResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/keywords_data/clickstream_data/locations_and_languages:
    get:
      tags:
        - KeywordsData
      description: "‌\nUsing this endpoint you can get the full list of locations and languages supported in DataForSEO Clickstream Data API."
      operationId: ClickstreamDataLocationsAndLanguages
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/KeywordsDataClickstreamDataLocationsAndLanguagesResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/keywords_data/clickstream_data/dataforseo_search_volume/live:
    post:
      tags:
        - KeywordsData
      description: ‌
      operationId: ClickstreamDataDataforseoSearchVolumeLive
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/KeywordsDataClickstreamDataDataforseoSearchVolumeLiveRequestInfo'
                nullable: true
              example:
                - location_code: 2840
                  language_code: en
                  tag: test-tag
                  keywords:
                    - you tube
                    - youtube
                    - youtub
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/KeywordsDataClickstreamDataDataforseoSearchVolumeLiveResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/keywords_data/clickstream_data/global_search_volume/live:
    post:
      tags:
        - KeywordsData
      description: "‌‌ \nThe Clickstream Global Search Volume endpoint of DataForSEO Keywords Data API is designed to provide clickstream-based search volume data for up to 1000 keywords in a single Live request. What’s more, it offers geographical distribution of clickstream search volume values across all available locations."
      operationId: ClickstreamDataGlobalSearchVolumeLive
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/KeywordsDataClickstreamDataGlobalSearchVolumeLiveRequestInfo'
                nullable: true
              example:
                - tag: test-tag
                  keywords:
                    - you tube
                    - youtube
                    - youtub
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/KeywordsDataClickstreamDataGlobalSearchVolumeLiveResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/keywords_data/clickstream_data/bulk_search_volume/live:
    post:
      tags:
        - KeywordsData
      description: "‌‌ \nThe Bulk Clickstream Search Volume endpoint of DataForSEO Keywords Data API is designed to provide clickstream-based search volume data for up to 1000 keywords in a single Live request. What’s more, it offers historical search volume values for up to 12 months (depending on keywords, location, and language parameters)."
      operationId: ClickstreamDataBulkSearchVolumeLive
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/KeywordsDataClickstreamDataBulkSearchVolumeLiveRequestInfo'
                nullable: true
              example:
                - location_code: 2840
                  tag: test-tag
                  keywords:
                    - you tube
                    - youtube
                    - youtub
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/KeywordsDataClickstreamDataBulkSearchVolumeLiveResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/backlinks/id_list:
    post:
      tags:
        - Backlinks
      description: 'This endpoint is designed to provide you with a list of IDs and metadata for all Backlinks tasks created within the specified time period, including both successful and uncompleted tasks.'
      operationId: BacklinksIdList
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/BacklinksIdListRequestInfo'
                nullable: true
              example:
                - datetime_from: '2026-09-10 11:12:35'
                  datetime_to: '2026-09-20 11:12:35'
                  limit: 10
                  include_metadata: true
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/BacklinksIdListResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/backlinks/errors:
    post:
      tags:
        - Backlinks
      description: By calling this endpoint you will receive information about the Backlinks API tasks that returned an error within the past 7 days.
      operationId: BacklinksErrors
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/BacklinksErrorsRequestInfo'
                nullable: true
              example:
                - limit: 10
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/BacklinksErrorsResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/backlinks/available_filters:
    get:
      tags:
        - Backlinks
      description: "Backlinks API features plenty of parameters that support custom filtration. By applying filters to your POST requests, you will be able to effortlessly extract data that matches your requirements. Note that we do not charge any fees for using data filtering or sorting rules.\n‌‌\nHere you will find all the necessary information about filters that can be used with DataForSEO Backlinks API endpoints."
      operationId: BacklinksAvailableFilters
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/BacklinksAvailableFiltersResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/backlinks/index:
    get:
      tags:
        - Backlinks
      description: "‌\nThis endpoint will provide you with the total number of backlinks, domains, and pages our database contains for the moment when you make a request. You will also get stats for the last 12 months."
      operationId: Index
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/BacklinksIndexResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/backlinks/summary/live:
    post:
      tags:
        - Backlinks
      description: "‌\nThis endpoint will provide you with an overview of backlinks data available for a given domain, subdomain, or webpage."
      operationId: SummaryLive
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/BacklinksSummaryLiveRequestInfo'
                nullable: true
              example:
                - target: explodingtopics.com
                  internal_list_limit: 10
                  include_subdomains: true
                  backlinks_filters:
                    - dofollow
                    - =
                    - true
                  backlinks_status_type: all
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/BacklinksSummaryLiveResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/backlinks/history/live:
    post:
      tags:
        - Backlinks
      description: "‌\nThis endpoint will provide you with historical backlinks data back to the beginning of 2019. You can receive the number of backlinks a given domain had in a specific time period, the number of new & lost backlinks, referring domains, and more."
      operationId: HistoryLive
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/BacklinksHistoryLiveRequestInfo'
                nullable: true
              example:
                - target: cnn.com
                  date_from: '2020-01-01'
                  date_to: '2021-01-01'
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/BacklinksHistoryLiveResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/backlinks/backlinks/live:
    post:
      tags:
        - Backlinks
      description: "‌\nThis endpoint will provide you with a list of backlinks and relevant data for the specified domain, subdomain, or webpage."
      operationId: BacklinksLive
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/BacklinksBacklinksLiveRequestInfo'
                nullable: true
              example:
                - target: forbes.com
                  mode: as_is
                  filters:
                    - dofollow
                    - =
                    - true
                  limit: 5
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/BacklinksBacklinksLiveResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/backlinks/anchors/live:
    post:
      tags:
        - Backlinks
      description: "‌‌\nThis endpoint will provide you with a detailed overview of anchors used when linking to the specified website with relevant backlink data for each of them."
      operationId: AnchorsLive
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/BacklinksAnchorsLiveRequestInfo'
                nullable: true
              example:
                - target: forbes.com
                  limit: 4
                  order_by:
                    - 'backlinks,desc'
                  filters:
                    - anchor
                    - like
                    - '%news%'
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/BacklinksAnchorsLiveResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/backlinks/domain_pages/live:
    post:
      tags:
        - Backlinks
      description: "‌‌\nThis endpoint will provide you with a detailed overview of domain pages with backlink data for each page."
      operationId: DomainPagesLive
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/BacklinksDomainPagesLiveRequestInfo'
                nullable: true
              example:
                - target: forbes.com
                  limit: 5
                  filters:
                    - 
                      - page_summary.backlinks
                      - '>'
                      - 5
                    - and
                    - 
                      - page
                      - like
                      - '%sites%'
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/BacklinksDomainPagesLiveResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/backlinks/domain_pages_summary/live:
    post:
      tags:
        - Backlinks
      description: 'This endpoint will provide you with detailed summary data on all backlinks and related metrics for each page of the target domain or subdomain you specify. If you indicate a single page as a target, you will get comprehensive summary data on all backlinks for that page.'
      operationId: DomainPagesSummaryLive
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/BacklinksDomainPagesSummaryLiveRequestInfo'
                nullable: true
              example:
                - target: forbes.com
                  limit: 4
                  order_by:
                    - 'backlinks,desc'
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/BacklinksDomainPagesSummaryLiveResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/backlinks/referring_domains/live:
    post:
      tags:
        - Backlinks
      description: "‌‌\nThis endpoint will provide you with a detailed overview of referring domains pointing to the target you specify."
      operationId: ReferringDomainsLive
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/BacklinksReferringDomainsLiveRequestInfo'
                nullable: true
              example:
                - target: backlinko.com
                  limit: 5
                  order_by:
                    - 'rank,desc'
                  exclude_internal_backlinks: true
                  backlinks_filters:
                    - dofollow
                    - =
                    - true
                  filters:
                    - backlinks
                    - '>'
                    - 100
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/BacklinksReferringDomainsLiveResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/backlinks/referring_networks/live:
    post:
      tags:
        - Backlinks
      description: "‌‌\nThis endpoint will provide you with a detailed overview of referring IPs and subnets pointing to the target you specify."
      operationId: ReferringNetworksLive
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/BacklinksReferringNetworksLiveRequestInfo'
                nullable: true
              example:
                - target: backlinko.com
                  network_address_type: subnet
                  limit: 5
                  order_by:
                    - 'rank,desc'
                  exclude_internal_backlinks: true
                  backlinks_filters:
                    - dofollow
                    - =
                    - true
                  filters:
                    - backlinks
                    - '>'
                    - 100
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/BacklinksReferringNetworksLiveResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/backlinks/competitors/live:
    post:
      tags:
        - Backlinks
      description: "‌‌\nThis endpoint will provide you with a list of competitors that share some part of the backlink profile with a target website, along with a number of backlink intersections and the rank of every competing website."
      operationId: CompetitorsLive
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/BacklinksCompetitorsLiveRequestInfo'
                nullable: true
              example:
                - target: dataforseo.com
                  filters:
                    - rank
                    - '>'
                    - 100
                  order_by:
                    - 'rank,desc'
                  limit: 5
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/BacklinksCompetitorsLiveResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/backlinks/domain_intersection/live:
    post:
      tags:
        - Backlinks
      description: "‌\nThis endpoint will provide you with the list of domains pointing to the specified websites. This endpoint is especially useful for creating a Link Gap feature that shows what domains link to your competitors but do not link out to your website."
      operationId: DomainIntersectionLive
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/BacklinksDomainIntersectionLiveRequestInfo'
                nullable: true
              example:
                - targets:
                    '1': moz.com
                    '2': ahrefs.com
                  include_subdomains: false
                  exclude_targets:
                    - semrush.com
                  limit: 5
                  order_by:
                    - '1.backlinks,desc'
                  exclude_internal_backlinks: true
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/BacklinksDomainIntersectionLiveResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/backlinks/page_intersection/live:
    post:
      tags:
        - Backlinks
      description: "‌\nThis endpoint will provide you with the list of referring pages pointing to the specified targets. It is especially useful for finding the backlinks that point to your competitors but don’t point to your website."
      operationId: PageIntersectionLive
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/BacklinksPageIntersectionLiveRequestInfo'
                nullable: true
              example:
                - targets:
                    '1': football.com
                    '2': fifa.com
                  exclude_targets:
                    - skysports.com
                  limit: 5
                  order_by:
                    - '1.rank,desc'
                  filters:
                    - 
                      - 2.domain_from_rank
                      - '>'
                      - 400
                    - and
                    - 
                      - 1.dofollow
                      - =
                      - true
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/BacklinksPageIntersectionLiveResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/backlinks/timeseries_summary/live:
    post:
      tags:
        - Backlinks
      description: "‌\nThis endpoint will provide you with an overview of backlink data for the target domain available during a period between the two indicated dates. Backlink metrics will be grouped by the time range that you define: day, week, month, or year."
      operationId: TimeseriesSummaryLive
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/BacklinksTimeseriesSummaryLiveRequestInfo'
                nullable: true
              example:
                - target: dataforseo.com
                  date_from: '2021-12-01'
                  date_to: '2022-02-01'
                  group_range: month
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/BacklinksTimeseriesSummaryLiveResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/backlinks/timeseries_new_lost_summary/live:
    post:
      tags:
        - Backlinks
      description: "‌\nThis endpoint will provide you with the number of new and lost backlinks and referring domains for the domain specified in the target field."
      operationId: TimeseriesNewLostSummaryLive
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/BacklinksTimeseriesNewLostSummaryLiveRequestInfo'
                nullable: true
              example:
                - target: dataforseo.com
                  date_from: '2021-12-01'
                  date_to: '2022-02-01'
                  group_range: month
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/BacklinksTimeseriesNewLostSummaryLiveResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/backlinks/bulk_ranks/live:
    post:
      tags:
        - Backlinks
      description: "‌\nThis endpoint will provide you with rank scores of the domains, subdomains, and pages specified in the targets array. The score is based on the number of referring domains pointing to the specified domains, subdomains, or pages. The rank values represent real-time data for the date of the request and range from 0 (no backlinks detected) to 1,000 (highest rank). A similar scoring system is used in Google’s Page Rank algorithm. You can learn more about rank scores in this help center article"
      operationId: BulkRanksLive
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/BacklinksBulkRanksLiveRequestInfo'
                nullable: true
              example:
                - targets:
                    - forbes.com
                    - cnn.com
                    - bbc.com
                    - yelp.com
                    - https://www.apple.com/iphone/
                    - https://ahrefs.com/blog/
                    - ibm.com
                    - https://variety.com/
                    - https://stackoverflow.com/
                    - www.trustpilot.com
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/BacklinksBulkRanksLiveResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/backlinks/bulk_backlinks/live:
    post:
      tags:
        - Backlinks
      description: "‌\nThis endpoint will provide you with the number of backlinks pointing to domains, subdomains, and pages specified in the targets array. The returned numbers correspond to all live backlinks, that is, total number of referring links with all attributes (e.g., nofollow, noreferrer, ugc, sponsored etc) that were found during the latest check."
      operationId: BulkBacklinksLive
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/BacklinksBulkBacklinksLiveRequestInfo'
                nullable: true
              example:
                - targets:
                    - forbes.com
                    - cnn.com
                    - bbc.com
                    - yelp.com
                    - https://www.apple.com/iphone/
                    - https://ahrefs.com/blog/
                    - ibm.com
                    - https://variety.com/
                    - https://stackoverflow.com/
                    - www.trustpilot.com
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/BacklinksBulkBacklinksLiveResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/backlinks/bulk_spam_score/live:
    post:
      tags:
        - Backlinks
      description: "‌\nThis endpoint will provide you with spam scores of the domains, subdomains, and pages you specified in the targets array. Spam Score is DataForSEO’s proprietary metric that indicates how “spammy” your target is on a scale from 0 to 100. You can learn more about Spam Score, how it is calculated, and signals it takes into account in this help center article"
      operationId: BulkSpamScoreLive
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/BacklinksBulkSpamScoreLiveRequestInfo'
                nullable: true
              example:
                - targets:
                    - forbes.com
                    - cnn.com
                    - bbc.com
                    - yelp.com
                    - https://www.apple.com/iphone/
                    - https://ahrefs.com/blog/
                    - ibm.com
                    - https://variety.com/
                    - https://stackoverflow.com/
                    - www.trustpilot.com
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/BacklinksBulkSpamScoreLiveResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/backlinks/bulk_referring_domains/live:
    post:
      tags:
        - Backlinks
      description: "‌\nThis endpoint will provide you with the number of referring domains pointing to domains, subdomains, and pages specified in the targets array. The returned numbers are based on all live referring domains, that is, total number of domains pointing to the target with any type of backlinks (e.g., nofollow, noreferrer, ugc, sponsored etc) that were found during the latest check."
      operationId: BulkReferringDomainsLive
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/BacklinksBulkReferringDomainsLiveRequestInfo'
                nullable: true
              example:
                - targets:
                    - forbes.com
                    - cnn.com
                    - bbc.com
                    - yelp.com
                    - https://www.apple.com/iphone/
                    - https://ahrefs.com/blog/
                    - ibm.com
                    - https://variety.com/
                    - https://stackoverflow.com/
                    - www.trustpilot.com
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/BacklinksBulkReferringDomainsLiveResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/backlinks/bulk_new_lost_backlinks/live:
    post:
      tags:
        - Backlinks
      description: "‌\nThis endpoint will provide you with the number of new and lost backlinks for the domains, subdomains, and pages specified in the targets array."
      operationId: BulkNewLostBacklinksLive
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/BacklinksBulkNewLostBacklinksLiveRequestInfo'
                nullable: true
              example:
                - targets:
                    - forbes.com
                    - cnn.com
                    - bbc.com
                    - yelp.com
                    - https://www.apple.com/iphone/
                    - https://ahrefs.com/blog/
                    - ibm.com
                    - https://variety.com/
                    - https://stackoverflow.com/
                    - www.trustpilot.com
                  date_from: '2026-08-31 11:12:35'
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/BacklinksBulkNewLostBacklinksLiveResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/backlinks/bulk_new_lost_referring_domains/live:
    post:
      tags:
        - Backlinks
      description: "‌\nThis endpoint will provide you with the number of referring domains pointing to the domains, subdomains and pages specified in the targets array."
      operationId: BulkNewLostReferringDomainsLive
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/BacklinksBulkNewLostReferringDomainsLiveRequestInfo'
                nullable: true
              example:
                - targets:
                    - forbes.com
                    - cnn.com
                    - bbc.com
                    - yelp.com
                    - https://www.apple.com/iphone/
                    - https://ahrefs.com/blog/
                    - ibm.com
                    - https://variety.com/
                    - https://stackoverflow.com/
                    - www.trustpilot.com
                  datetime_from: '2026-12-31'
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/BacklinksBulkNewLostReferringDomainsLiveResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/backlinks/bulk_pages_summary/live:
    post:
      tags:
        - Backlinks
      description: 'This endpoint will provide you with a comprehensive overview of backlinks and related data for a bulk of up to 1000 pages, domains, or subdomains. If you indicate a single page as a target, you will get comprehensive summary data on all backlinks for that page.'
      operationId: BulkPagesSummaryLive
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/BacklinksBulkPagesSummaryLiveRequestInfo'
                nullable: true
              example:
                - targets:
                    - https://dataforseo.com/solutions
                    - https://dataforseo.com/about-us
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/BacklinksBulkPagesSummaryLiveResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/ai_optimization/chat_gpt/llm_scraper/locations:
    get:
      tags:
        - AiOptimization
      description: You will receive the list of locations by this API call. You can filter the list of locations by country when setting a task.
      operationId: ChatGptLlmScraperLocations
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AiOptimizationChatGptLlmScraperLocationsResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  '/v3/ai_optimization/chat_gpt/llm_scraper/locations/{country}':
    get:
      tags:
        - AiOptimization
      description: You will receive the list of locations by this API call. You can filter the list of locations by country when setting a task.
      operationId: ChatGptLlmScraperLocationsCountry
      parameters:
        - name: country
          in: path
          description: <em>country ISO code</em><br>optional field<br>specify the ISO code if you want to filter the list of locations by country<br>example:<br><code>us</code>
          required: true
          schema:
            type: string
          example: us
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AiOptimizationChatGptLlmScraperLocationsCountryResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/ai_optimization/chat_gpt/llm_scraper/languages:
    get:
      tags:
        - AiOptimization
      description: You will receive the list of languages by calling this API.
      operationId: ChatGptLlmScraperLanguages
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AiOptimizationChatGptLlmScraperLanguagesResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/ai_optimization/chat_gpt/llm_scraper/task_post:
    post:
      tags:
        - AiOptimization
      description: "‌‌\nChatGPT LLM Scraper API provides results from ChatGPT searches. The results are specific to the selected location (see the List of Locations) and language (see the List of Languages) parameters."
      operationId: ChatGptLlmScraperTaskPost
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AiOptimizationChatGptLlmScraperTaskPostRequestInfo'
                nullable: true
              example:
                - language_code: en
                  location_code: 2840
                  keyword: what is chatgpt
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AiOptimizationChatGptLlmScraperTaskPostResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/ai_optimization/chat_gpt/llm_scraper/tasks_ready:
    get:
      tags:
        - AiOptimization
      description: "‌\nThe ‘Tasks Ready’ endpoint is designed to provide you with the list of completed tasks, which haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed tasks using this endpoint. Then, you can collect the results using the ‘Task GET’ endpoint.\nLearn more about task completion and obtaining a list of completed tasks in this help center article."
      operationId: ChatGptLlmScraperTasksReady
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AiOptimizationChatGptLlmScraperTasksReadyResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  '/v3/ai_optimization/chat_gpt/llm_scraper/task_get/advanced/{id}':
    get:
      tags:
        - AiOptimization
      description: 'Description of the fields for sending a request:'
      operationId: ChatGptLlmScraperTaskGetAdvanced
      parameters:
        - name: id
          in: path
          description: <em>task identifier</em><br><a href="https://en.wikipedia.org/wiki/Universally_unique_identifier">a universally unique identifier (UUID)</a><br><strong>unique task identifier in our system</strong><br>you will be able to use it within <strong>30 days</strong> to request the results of the task at any time
          required: true
          schema:
            type: string
          example: 00000000-0000-0000-0000-000000000000
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AiOptimizationChatGptLlmScraperTaskGetAdvancedResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  '/v3/ai_optimization/chat_gpt/llm_scraper/task_get/html/{id}':
    get:
      tags:
        - AiOptimization
      description: 'Description of the fields for sending a request:'
      operationId: ChatGptLlmScraperTaskGetHtml
      parameters:
        - name: id
          in: path
          description: <em>task identifier</em><br><strong>unique task identifier in our system in the <a href="https://en.wikipedia.org/wiki/Universally_unique_identifier">UUID</a> format</strong><br>you will be able to use it within <strong>7 days</strong> to request the results of the task at any time
          required: true
          schema:
            type: string
          example: 00000000-0000-0000-0000-000000000000
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AiOptimizationChatGptLlmScraperTaskGetHtmlResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/ai_optimization/chat_gpt/llm_scraper/live/advanced:
    post:
      tags:
        - AiOptimization
      description: "‌‌\nLive ChatGPT LLM Scraper endpoint provides results from ChatGPT searches. The results are specific to the selected location (see the List of Locations) and language (see the List of Languages) parameters."
      operationId: ChatGptLlmScraperLiveAdvanced
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AiOptimizationChatGptLlmScraperLiveAdvancedRequestInfo'
                nullable: true
              example:
                - language_code: en
                  location_code: 2840
                  keyword: albert einstein
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AiOptimizationChatGptLlmScraperLiveAdvancedResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/ai_optimization/chat_gpt/llm_scraper/live/html:
    post:
      tags:
        - AiOptimization
      description: "‌\nLive ChatGPT LLM Scraper API HTML provides a raw HTML page of the results for the specified keyword, language, and location."
      operationId: ChatGptLlmScraperLiveHtml
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AiOptimizationChatGptLlmScraperLiveHtmlRequestInfo'
                nullable: true
              example:
                - language_code: en
                  location_code: 2840
                  keyword: albert einstein
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AiOptimizationChatGptLlmScraperLiveHtmlResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/ai_optimization/chat_gpt/llm_responses/models:
    get:
      tags:
        - AiOptimization
      description: "You will receive the list of available Chat GPT AI models by calling this API.\n \nAs a response of the API server, you will receive JSON-encoded data containing a tasks array with the information specific to the set tasks."
      operationId: ChatGptLlmResponsesModels
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AiOptimizationChatGptLlmResponsesModelsResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/ai_optimization/chat_gpt/llm_responses/live:
    post:
      tags:
        - AiOptimization
      description: "‌‌\nLive ChatGPT LLM Responses endpoint allows you to retrieve structured responses from a specific ChatGPT AI model, based on the input parameters."
      operationId: ChatGptLlmResponsesLive
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AiOptimizationChatGptLlmResponsesLiveRequestInfo'
                nullable: true
              example:
                - system_message: communicate as if we are in a business meeting
                  message_chain:
                    - role: user
                      message: 'Hello, what’s up?'
                    - role: ai
                      message: 'Hello! I’m doing well, thank you. How can I assist you today? Are there any specific topics or projects you’d like to discuss in our meeting?'
                  max_output_tokens: 200
                  temperature: 0.3
                  top_p: 0.5
                  model_name: gpt-4.1-mini
                  web_search: true
                  web_search_country_iso_code: FR
                  web_search_city: Paris
                  user_prompt: provide information on how relevant the amusement park business is in France now
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AiOptimizationChatGptLlmResponsesLiveResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/ai_optimization/chat_gpt/llm_responses/task_post:
    post:
      tags:
        - AiOptimization
      description: "‌\nChatGPT LLM Responses endpoint allows you to retrieve structured responses from a specific ChatGPT model, based on the input parameters."
      operationId: ChatGptLlmResponsesTaskPost
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AiOptimizationChatGptLlmResponsesTaskPostRequestInfo'
                nullable: true
              example:
                - system_message: communicate as if we are in a business meeting
                  message_chain:
                    - role: user
                      message: 'Hello, what’s up?'
                    - role: ai
                      message: 'Hello! I’m doing well, thank you. How can I assist you today? Are there any specific topics or projects you’d like to discuss in our meeting?'
                  model_name: gpt-4.1-mini
                  user_prompt: provide information on how relevant the amusement park business is in France now
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AiOptimizationChatGptLlmResponsesTaskPostResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/ai_optimization/chat_gpt/llm_responses/tasks_ready:
    get:
      tags:
        - AiOptimization
      description: "‌\nThis endpoint is designed to provide you with a list of completed tasks, which haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed tasks using this endpoint. Then, you can collect the results using the ‘Task GET’ endpoint."
      operationId: ChatGptLlmResponsesTasksReady
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AiOptimizationChatGptLlmResponsesTasksReadyResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  '/v3/ai_optimization/chat_gpt/llm_responses/task_get/{id}':
    get:
      tags:
        - AiOptimization
      description: "‌\nChat GPT LLM Responses endpoint allows you to retrieve structured responses from a specific Chat GPT model, based on the input parameters."
      operationId: ChatGptLlmResponsesTaskGet
      parameters:
        - name: id
          in: path
          description: <em>task identifier</em><br><strong>unique task identifier in our system in the <a href="https://en.wikipedia.org/wiki/Universally_unique_identifier">UUID</a> format</strong><br>you will be able to use it within <strong>30 days</strong> to request the results of the task at any time
          required: true
          schema:
            type: string
          example: 00000000-0000-0000-0000-000000000000
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AiOptimizationChatGptLlmResponsesTaskGetResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/ai_optimization/claude/llm_responses/models:
    get:
      tags:
        - AiOptimization
      description: "You will receive the list of available Claude AI models by calling this API.\n \nAs a response of the API server, you will receive JSON-encoded data containing a tasks array with the information specific to the set tasks."
      operationId: ClaudeLlmResponsesModels
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AiOptimizationClaudeLlmResponsesModelsResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/ai_optimization/claude/llm_responses/live:
    post:
      tags:
        - AiOptimization
      description: "‌‌\nLive Claude LLM Responses endpoint allows you to retrieve structured responses from a specific Claude model, based on the input parameters."
      operationId: ClaudeLlmResponsesLive
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AiOptimizationClaudeLlmResponsesLiveRequestInfo'
                nullable: true
              example:
                - system_message: communicate as if we are in a business meeting
                  message_chain:
                    - role: user
                      message: 'Hello, what’s up?'
                    - role: ai
                      message: 'Hello! I’m doing well, thank you. How can I assist you today? Are there any specific topics or projects you’d like to discuss in our meeting?'
                  max_output_tokens: 200
                  model_name: claude-opus-4-0
                  temperature: 0.3
                  web_search: true
                  web_search_country_iso_code: FR
                  user_prompt: provide information on how relevant the amusement park business is in France now
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AiOptimizationClaudeLlmResponsesLiveResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/ai_optimization/claude/llm_responses/task_post:
    post:
      tags:
        - AiOptimization
      description: "‌\nClaude LLM Responses endpoint allows you to retrieve structured responses from a specific Claude model, based on the input parameters."
      operationId: ClaudeLlmResponsesTaskPost
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AiOptimizationClaudeLlmResponsesTaskPostRequestInfo'
                nullable: true
              example:
                - system_message: communicate as if we are in a business meeting
                  message_chain:
                    - role: user
                      message: 'Hello, what’s up?'
                    - role: ai
                      message: 'Hello! I’m doing well, thank you. How can I assist you today? Are there any specific topics or projects you’d like to discuss in our meeting?'
                  max_output_tokens: 1024
                  temperature: 0.3
                  web_search_country_iso_code: FR
                  model_name: claude-sonnet-4-0
                  web_search: true
                  user_prompt: provide information on how relevant the amusement park business is in France now
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AiOptimizationClaudeLlmResponsesTaskPostResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/ai_optimization/claude/llm_responses/tasks_ready:
    get:
      tags:
        - AiOptimization
      description: "‌\nThis endpoint is designed to provide you with a list of completed tasks, which haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed tasks using this endpoint. Then, you can collect the results using the ‘Task GET’ endpoint."
      operationId: ClaudeLlmResponsesTasksReady
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AiOptimizationClaudeLlmResponsesTasksReadyResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  '/v3/ai_optimization/claude/llm_responses/task_get/{id}':
    get:
      tags:
        - AiOptimization
      description: "‌\nClaude LLM Responses endpoint allows you to retrieve structured responses from a specific Claude model, based on the input parameters."
      operationId: ClaudeLlmResponsesTaskGet
      parameters:
        - name: id
          in: path
          description: <em>task identifier</em><br><strong>unique task identifier in our system in the <a href="https://en.wikipedia.org/wiki/Universally_unique_identifier">UUID</a> format</strong><br>you will be able to use it within <strong>30 days</strong> to request the results of the task at any time
          required: true
          schema:
            type: string
          example: 00000000-0000-0000-0000-000000000000
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AiOptimizationClaudeLlmResponsesTaskGetResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/ai_optimization/gemini/llm_responses/models:
    get:
      tags:
        - AiOptimization
      description: "You will receive the list of available Gemini AI models by calling this API.\n \nAs a response of the API server, you will receive JSON-encoded data containing a tasks array with the information specific to the set tasks."
      operationId: GeminiLlmResponsesModels
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AiOptimizationGeminiLlmResponsesModelsResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/ai_optimization/gemini/llm_responses/task_post:
    post:
      tags:
        - AiOptimization
      description: "‌\nGemini LLM Responses endpoint allows you to retrieve structured responses from a specific Gemini model, based on the input parameters."
      operationId: GeminiLlmResponsesTaskPost
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AiOptimizationGeminiLlmResponsesTaskPostRequestInfo'
                nullable: true
              example:
                - system_message: communicate as if we are in a business meeting
                  message_chain:
                    - role: user
                      message: 'Hello, what’s up?'
                    - role: ai
                      message: 'Hello! I’m doing well, thank you. How can I assist you today? Are there any specific topics or projects you’d like to discuss in our meeting?'
                  model_name: gemini-2.5-flash
                  user_prompt: provide information on how relevant the amusement park business is in France now
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AiOptimizationGeminiLlmResponsesTaskPostResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/ai_optimization/gemini/llm_responses/tasks_ready:
    get:
      tags:
        - AiOptimization
      description: "‌\nThis endpoint is designed to provide you with a list of completed tasks, which haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed tasks using this endpoint. Then, you can collect the results using the ‘Task GET’ endpoint."
      operationId: GeminiLlmResponsesTasksReady
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AiOptimizationGeminiLlmResponsesTasksReadyResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  '/v3/ai_optimization/gemini/llm_responses/task_get/{id}':
    get:
      tags:
        - AiOptimization
      description: "‌\nGemini LLM Responses endpoint allows you to retrieve structured responses from a specific Gemini model, based on the input parameters."
      operationId: GeminiLlmResponsesTaskGet
      parameters:
        - name: id
          in: path
          description: <em>task identifier</em><br><strong>unique task identifier in our system in the <a href="https://en.wikipedia.org/wiki/Universally_unique_identifier">UUID</a> format</strong><br>you will be able to use it within <strong>30 days</strong> to request the results of the task at any time
          required: true
          schema:
            type: string
          example: 00000000-0000-0000-0000-000000000000
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AiOptimizationGeminiLlmResponsesTaskGetResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/ai_optimization/gemini/llm_responses/live:
    post:
      tags:
        - AiOptimization
      description: "‌‌\nLive Gemini LLM Responses endpoint allows you to retrieve structured responses from a specific Gemini AI model, based on the input parameters."
      operationId: GeminiLlmResponsesLive
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AiOptimizationGeminiLlmResponsesLiveRequestInfo'
                nullable: true
              example:
                - system_message: communicate as if we are in a business meeting
                  message_chain:
                    - role: user
                      message: 'Hello, what’s up?'
                    - role: ai
                      message: 'Hello! I’m doing well, thank you. How can I assist you today? Are there any specific topics or projects you’d like to discuss in our meeting?'
                  max_output_tokens: 200
                  temperature: 0.3
                  top_p: 0.5
                  model_name: gemini-2.5-flash
                  web_search: true
                  user_prompt: provide information on how relevant the amusement park business is in France now
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AiOptimizationGeminiLlmResponsesLiveResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/ai_optimization/perplexity/llm_responses/models:
    get:
      tags:
        - AiOptimization
      description: "You will receive the list of available Perplexity AI models by calling this API.\n \nAs a response of the API server, you will receive JSON-encoded data containing a tasks array with the information specific to the set tasks."
      operationId: PerplexityLlmResponsesModels
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AiOptimizationPerplexityLlmResponsesModelsResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/ai_optimization/perplexity/llm_responses/live:
    post:
      tags:
        - AiOptimization
      description: "‌‌\nLive Perplexity LLM Responses endpoint allows you to retrieve structured responses from a specific Perplexity AI model, based on the input parameters."
      operationId: PerplexityLlmResponsesLive
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AiOptimizationPerplexityLlmResponsesLiveRequestInfo'
                nullable: true
              example:
                - system_message: communicate as if we are in a business meeting
                  message_chain:
                    - role: user
                      message: 'Hello, what’s up?'
                    - role: ai
                      message: 'Hello! I’m doing well, thank you. How can I assist you today? Are there any specific topics or projects you’d like to discuss in our meeting?'
                  max_output_tokens: 200
                  temperature: 0.3
                  top_p: 0.5
                  web_search_country_iso_code: FR
                  model_name: sonar
                  user_prompt: provide information on how relevant the amusement park business is in France now
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AiOptimizationPerplexityLlmResponsesLiveResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/ai_optimization/gemini/llm_scraper/locations:
    get:
      tags:
        - AiOptimization
      description: You will receive the list of locations by this API call. You can filter the list of locations by country when setting a task.
      operationId: GeminiLlmScraperLocations
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AiOptimizationGeminiLlmScraperLocationsResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/ai_optimization/gemini/llm_scraper/languages:
    get:
      tags:
        - AiOptimization
      description: You will receive the list of languages by calling this API.
      operationId: GeminiLlmScraperLanguages
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AiOptimizationGeminiLlmScraperLanguagesResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/ai_optimization/gemini/llm_scraper/task_post:
    post:
      tags:
        - AiOptimization
      description: "‌‌\nGemini LLM Scraper API provides structured results from Gemini. The results are specific to the selected location (see the List of Locations) and language (see the List of Languages), and keyword."
      operationId: GeminiLlmScraperTaskPost
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AiOptimizationGeminiLlmScraperTaskPostRequestInfo'
                nullable: true
              example:
                - language_code: en
                  location_code: 2840
                  keyword: albert einstein
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AiOptimizationGeminiLlmScraperTaskPostResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/ai_optimization/gemini/llm_scraper/tasks_ready:
    get:
      tags:
        - AiOptimization
      description: "‌\nThe ‘Tasks Ready’ endpoint is designed to provide you with the list of completed tasks, which haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed tasks using this endpoint. Then, you can collect the results using the ‘Task GET’ endpoint.\nLearn more about task completion and obtaining a list of completed tasks in this help center article."
      operationId: GeminiLlmScraperTasksReady
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AiOptimizationGeminiLlmScraperTasksReadyResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  '/v3/ai_optimization/gemini/llm_scraper/task_get/advanced/{id}':
    get:
      tags:
        - AiOptimization
      description: 'Description of the fields for sending a request:'
      operationId: GeminiLlmScraperTaskGetAdvanced
      parameters:
        - name: id
          in: path
          description: <em>task identifier</em><br><a href="https://en.wikipedia.org/wiki/Universally_unique_identifier">a universally unique identifier (UUID)</a><br><strong>unique task identifier in our system</strong><br>you will be able to use it within <strong>30 days</strong> to request the results of the task at any time
          required: true
          schema:
            type: string
          example: 00000000-0000-0000-0000-000000000000
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AiOptimizationGeminiLlmScraperTaskGetAdvancedResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  '/v3/ai_optimization/gemini/llm_scraper/task_get/html/{id}':
    get:
      tags:
        - AiOptimization
      description: 'Description of the fields for sending a request:'
      operationId: GeminiLlmScraperTaskGetHtml
      parameters:
        - name: id
          in: path
          description: <em>task identifier</em><br><strong>unique task identifier in our system in the <a href="https://en.wikipedia.org/wiki/Universally_unique_identifier">UUID</a> format</strong><br>you will be able to use it within <strong>7 days</strong> to request the results of the task at any time
          required: true
          schema:
            type: string
          example: 00000000-0000-0000-0000-000000000000
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AiOptimizationGeminiLlmScraperTaskGetHtmlResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/ai_optimization/gemini/llm_scraper/live/advanced:
    post:
      tags:
        - AiOptimization
      description: "‌‌\nLive Gemini LLM Scraper endpoint provides structured results from Gemini. The results are specific to the selected location (see the List of Locations), language (see the List of Languages), and keyword."
      operationId: GeminiLlmScraperLiveAdvanced
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AiOptimizationGeminiLlmScraperLiveAdvancedRequestInfo'
                nullable: true
              example:
                - language_code: en
                  location_code: 2840
                  keyword: albert einstein
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AiOptimizationGeminiLlmScraperLiveAdvancedResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/ai_optimization/gemini/llm_scraper/live/html:
    post:
      tags:
        - AiOptimization
      description: "‌\nLive Gemini LLM Scraper API HTML provides a raw HTML page of the results for the specified keyword, language (see the List of Languages), and location (see the List of Locations)."
      operationId: GeminiLlmScraperLiveHtml
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AiOptimizationGeminiLlmScraperLiveHtmlRequestInfo'
                nullable: true
              example:
                - language_code: en
                  location_code: 2840
                  keyword: albert einstein
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AiOptimizationGeminiLlmScraperLiveHtmlResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/ai_optimization/ai_keyword_data/available_filters:
    get:
      tags:
        - AiOptimization
      description: "‌‌\nHere you will find all the necessary information about filters that can be used with AI Keyword Data API endpoints."
      operationId: AiKeywordDataAvailableFilters
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AiOptimizationAiKeywordDataAvailableFiltersResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/ai_optimization/ai_keyword_data/locations_and_languages:
    get:
      tags:
        - AiOptimization
      description: "‌\nUsing this endpoint you can get the full list of locations and languages supported in AI Keyword Data API."
      operationId: AiKeywordDataLocationsAndLanguages
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AiOptimizationAiKeywordDataLocationsAndLanguagesResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/ai_optimization/ai_keyword_data/keywords_search_volume/live:
    post:
      tags:
        - AiOptimization
      description: "‌\nThis endpoint provides search volume data for your target keywords, reflecting their estimated usage in AI tools."
      operationId: AiKeywordDataKeywordsSearchVolumeLive
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AiOptimizationAiKeywordDataKeywordsSearchVolumeLiveRequestInfo'
                nullable: true
              example:
                - language_name: English
                  location_code: 2840
                  keywords:
                    - iphone
                    - seo
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AiOptimizationAiKeywordDataKeywordsSearchVolumeLiveResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/ai_optimization/llm_mentions/available_filters:
    get:
      tags:
        - AiOptimization
      description: "‌‌\nHere you will find all the necessary information about filters that can be used with AI Optimization LLM Mentions API endpoints."
      operationId: LlmMentionsAvailableFilters
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AiOptimizationLlmMentionsAvailableFiltersResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/ai_optimization/llm_mentions/locations_and_languages:
    get:
      tags:
        - AiOptimization
      description: "‌\nUsing this endpoint you can get the full list of locations and languages supported in AI Optimization LLM Mentions API."
      operationId: LlmMentionsLocationsAndLanguages
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AiOptimizationLlmMentionsLocationsAndLanguagesResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/ai_optimization/llm_mentions/search_mentions/live:
    post:
      tags:
        - AiOptimization
      description: "‌‌\nLive LLM Mentions Search endpoint provides mention data and related metrics from AI searches. The results are specific to the selected platform (google for Google’s  AI Overview or chat_gpt for ChatGPT), as well as location and language parameters (see the List of Locations & Languages)."
      operationId: LlmMentionsSearchMentionsLive
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AiOptimizationLlmMentionsSearchMentionsLiveRequestInfo'
                nullable: true
              example:
                - language_name: English
                  location_code: 2840
                  target:
                    - domain: dataforseo.com
                      search_filter: exclude
                    - keyword: bmw
                      search_scope:
                        - answer
                  platform: google
                  filters:
                    - 
                      - ai_search_volume
                      - '>'
                      - 1000
                  order_by:
                    - 'ai_search_volume,desc'
                  offset: 0
                  limit: 3
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AiOptimizationLlmMentionsSearchMentionsLiveResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/ai_optimization/llm_mentions/target_metrics/live:
    post:
      tags:
        - AiOptimization
      description: "‌‌\nLive LLM Mentions Target Metrics endpoint provides aggregated metrics for mentions of the keywords or domains specified in the target array of the request. The results are specific to the selected platform (google for Google’s  AI Overview or chat_gpt for ChatGPT), location and language parameters (see the List of Locations & Languages)."
      operationId: LlmMentionsTargetMetricsLive
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AiOptimizationLlmMentionsTargetMetricsLiveRequestInfo'
                nullable: true
              example:
                - language_code: en
                  location_code: 2840
                  platform: chat_gpt
                  target:
                    - domain: en.wikipedia.org
                      search_filter: exclude
                    - keyword: bmw
                      search_scope:
                        - answer
                  initial_dataset_filters:
                    - 
                      - ai_search_volume
                      - '>'
                      - 10
                  internal_list_limit: 10
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AiOptimizationLlmMentionsTargetMetricsLiveResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/ai_optimization/llm_mentions/multi_target_metrics/live:
    post:
      tags:
        - AiOptimization
      description: "‌‌\nLive LLM Mentions Multi-Target Metrics endpoint provides aggregated metrics grouped by custom keys for mentions of the keywords or domains specified in the target array of the request. Each item in the results array corresponds to the specified target. The results are specific to the selected platform (google for Google’s  AI Overview or chat_gpt for ChatGPT), location and language parameters (see the List of Locations & Languages)."
      operationId: LlmMentionsMultiTargetMetricsLive
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AiOptimizationLlmMentionsMultiTargetMetricsLiveRequestInfo'
                nullable: true
              example:
                - language_code: en
                  location_code: 2840
                  platform: google
                  targets:
                    - key: chat_gpt
                      target:
                        - keyword: chat gpt
                    - key: claude
                      target:
                        - keyword: claude
                    - key: gemini
                      target:
                        - keyword: gemini
                    - key: perplexity
                      target:
                        - keyword: perplexity
                          search_filter: include
                  initial_dataset_filters:
                    - 
                      - ai_search_volume
                      - '>'
                      - 10
                  internal_list_limit: 5
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AiOptimizationLlmMentionsMultiTargetMetricsLiveResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/ai_optimization/llm_mentions/top_mentioned_domains/live:
    post:
      tags:
        - AiOptimization
      description: "‌‌\nLive LLM Mentions Top Mentioned Domains endpoint provides aggregated LLM mentions metrics grouped by the most frequently mentioned domains for the specified target. The results are specific to the selected platform (google for Google’s  AI Overview or chat_gpt for ChatGPT), location and language parameters (see the List of Locations & Languages)."
      operationId: LlmMentionsTopMentionedDomainsLive
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AiOptimizationLlmMentionsTopMentionedDomainsLiveRequestInfo'
                nullable: true
              example:
                - language_code: en
                  location_code: 2840
                  platform: chat_gpt
                  target:
                    - keyword: bmw
                      search_scope:
                        - answer
                    - keyword: auto
                      search_scope:
                        - question
                      match_type: partial_match
                  links_scope: sources
                  initial_dataset_filters:
                    - 
                      - ai_search_volume
                      - '>'
                      - 10
                  limit: 3
                  internal_list_limit: 2
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AiOptimizationLlmMentionsTopMentionedDomainsLiveResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/ai_optimization/llm_mentions/top_mentioned_pages/live:
    post:
      tags:
        - AiOptimization
      description: "‌‌\nLive LLM Mentions Top Mentioned Pages endpoint provides aggregated LLM mentions metrics grouped by the most frequently mentioned pages for the specified target. The results are specific to the selected platform (google for Google’s  AI Overview or chat_gpt for ChatGPT), location and language parameters (see the List of Locations & Languages)."
      operationId: LlmMentionsTopMentionedPagesLive
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AiOptimizationLlmMentionsTopMentionedPagesLiveRequestInfo'
                nullable: true
              example:
                - language_code: en
                  location_code: 2840
                  platform: chat_gpt
                  target:
                    - keyword: bmw
                      search_scope:
                        - answer
                    - keyword: auto
                      search_scope:
                        - question
                      match_type: partial_match
                  links_scope: sources
                  initial_dataset_filters:
                    - 
                      - ai_search_volume
                      - '>'
                      - 10
                  limit: 3
                  internal_list_limit: 2
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AiOptimizationLlmMentionsTopMentionedPagesLiveResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/ai_optimization/llm_mentions/top_mentioned_brands/live:
    post:
      tags:
        - AiOptimization
      description: "‌‌\nLive LLM Mentions Top Mentioned Brands endpoint provides aggregated LLM mentions metrics grouped by the most frequently mentioned brands for the specified target. The results are specific to the selected platform, location and language parameters (see the List of Locations & Languages)."
      operationId: LlmMentionsTopMentionedBrandsLive
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AiOptimizationLlmMentionsTopMentionedBrandsLiveRequestInfo'
                nullable: true
              example:
                - language_code: en
                  location_code: 2840
                  platform: chat_gpt
                  target:
                    - keyword: bmw
                      search_scope:
                        - answer
                    - keyword: auto
                      search_scope:
                        - question
                      match_type: partial_match
                  initial_dataset_filters:
                    - 
                      - ai_search_volume
                      - '>'
                      - 10
                  limit: 3
                  internal_list_limit: 2
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AiOptimizationLlmMentionsTopMentionedBrandsLiveResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/ai_optimization/llm_mentions/top_mentioned_brand_categories/live:
    post:
      tags:
        - AiOptimization
      description: "‌‌\nLive LLM Mentions Top Mentioned Brand Categories endpoint provides aggregated LLM mentions metrics grouped by the most frequently mentioned brand categories for the specified target. The results are specific to the selected platform, location and language parameters (see the List of Locations & Languages)."
      operationId: LlmMentionsTopMentionedBrandCategoriesLive
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AiOptimizationLlmMentionsTopMentionedBrandCategoriesLiveRequestInfo'
                nullable: true
              example:
                - language_code: en
                  location_code: 2840
                  platform: chat_gpt
                  target:
                    - keyword: bmw
                      search_scope:
                        - answer
                    - keyword: auto
                      search_scope:
                        - question
                      match_type: partial_match
                  initial_dataset_filters:
                    - 
                      - ai_search_volume
                      - '>'
                      - 10
                  limit: 3
                  internal_list_limit: 2
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AiOptimizationLlmMentionsTopMentionedBrandCategoriesLiveResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/ai_optimization/llm_mentions/target_metrics_lite/live:
    post:
      tags:
        - AiOptimization
      description: 'Live LLM Mentions Target Metrics Lite endpoint is the simplified version of the Target Metrics endpoint and provides a simplified view of aggregated LLM mentions for keywords and domains specified in the target array of the request. The results are specific to the selected platform (google for Google’s  AI Overview or chat_gpt for ChatGPT), location and language parameters (see the List of Locations & Languages).'
      operationId: LlmMentionsTargetMetricsLiteLive
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AiOptimizationLlmMentionsTargetMetricsLiteLiveRequestInfo'
                nullable: true
              example:
                - language_code: es
                  location_code: 2840
                  platform: google
                  target:
                    - domain: en.wikipedia.org
                      search_filter: exclude
                    - keyword: bmw
                      search_scope:
                        - answer
                  initial_dataset_filters:
                    - 
                      - ai_search_volume
                      - '>'
                      - 10
                  limit: 6
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AiOptimizationLlmMentionsTargetMetricsLiteLiveResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/ai_optimization/llm_mentions/top_mentioned_domains_lite/live:
    post:
      tags:
        - AiOptimization
      description: "‌‌\nLive LLM Mentions Top Mentioned Domains Lite endpoint is the simplified version of the Top Mentioned Domains endpoint and provides a simplified view of aggregated LLM mentions metrics grouped by the most frequently mentioned domains for the specified target. The results are specific to the selected platform (google for Google’s  AI Overview or chat_gpt for ChatGPT), location and language parameters (see the List of Locations & Languages)."
      operationId: LlmMentionsTopMentionedDomainsLiteLive
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AiOptimizationLlmMentionsTopMentionedDomainsLiteLiveRequestInfo'
                nullable: true
              example:
                - language_code: en
                  location_code: 2840
                  platform: chat_gpt
                  target:
                    - keyword: bmw
                      search_scope:
                        - answer
                    - keyword: auto
                      search_scope:
                        - question
                      match_type: partial_match
                  links_scope: sources
                  initial_dataset_filters:
                    - 
                      - ai_search_volume
                      - '>'
                      - 10
                  limit: 3
                  internal_list_limit: 2
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AiOptimizationLlmMentionsTopMentionedDomainsLiteLiveResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/ai_optimization/llm_mentions/top_mentioned_pages_lite/live:
    post:
      tags:
        - AiOptimization
      description: "‌‌\nLive LLM Mentions Top Mentioned Pages Lite endpoint is a simplified version of the Top Mentioned Pages that provides a simplified view of aggregated LLM mentions metrics grouped by the most frequently mentioned pages for the specified target. The results are specific to the selected platform (google for Google’s  AI Overview or chat_gpt for ChatGPT), location and language parameters (see the List of Locations & Languages)."
      operationId: LlmMentionsTopMentionedPagesLiteLive
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AiOptimizationLlmMentionsTopMentionedPagesLiteLiveRequestInfo'
                nullable: true
              example:
                - language_code: en
                  location_code: 2840
                  platform: chat_gpt
                  target:
                    - keyword: bmw
                      search_scope:
                        - answer
                    - keyword: auto
                      search_scope:
                        - question
                      match_type: partial_match
                  links_scope: sources
                  initial_dataset_filters:
                    - 
                      - ai_search_volume
                      - '>'
                      - 10
                  limit: 3
                  internal_list_limit: 2
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AiOptimizationLlmMentionsTopMentionedPagesLiteLiveResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/ai_optimization/llm_mentions/top_mentioned_brands_lite/live:
    post:
      tags:
        - AiOptimization
      description: "‌‌\nLive LLM Mentions Top Mentioned Brands Lite endpoint is the simplified version of the Top Mentioned Brands endpoint and provides a simplified view of aggregated LLM mentions metrics grouped by the most frequently mentioned brands for the specified target. The results are specific to the selected platform, location and language parameters (see the List of Locations & Languages)."
      operationId: LlmMentionsTopMentionedBrandsLiteLive
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AiOptimizationLlmMentionsTopMentionedBrandsLiteLiveRequestInfo'
                nullable: true
              example:
                - language_code: en
                  location_code: 2840
                  platform: chat_gpt
                  target:
                    - keyword: bmw
                      search_scope:
                        - answer
                    - keyword: auto
                      search_scope:
                        - question
                      match_type: partial_match
                  initial_dataset_filters:
                    - 
                      - ai_search_volume
                      - '>'
                      - 10
                  limit: 3
                  internal_list_limit: 2
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AiOptimizationLlmMentionsTopMentionedBrandsLiteLiveResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/ai_optimization/llm_mentions/top_mentioned_brand_categories_lite/live:
    post:
      tags:
        - AiOptimization
      description: "‌‌\nLive LLM Mentions Top Mentioned Brand Categories Lite endpoint is the simplified version of the Top Mentioned Brand Categories endpoint and provides a simplified view of aggregated LLM mentions metrics grouped by the most frequently mentioned brand categories for the specified target. The results are specific to the selected platform, location and language parameters (see the List of Locations & Languages)."
      operationId: LlmMentionsTopMentionedBrandCategoriesLiteLive
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AiOptimizationLlmMentionsTopMentionedBrandCategoriesLiteLiveRequestInfo'
                nullable: true
              example:
                - language_code: en
                  location_code: 2840
                  platform: chat_gpt
                  target:
                    - keyword: bmw
                      search_scope:
                        - answer
                    - keyword: auto
                      search_scope:
                        - question
                      match_type: partial_match
                  initial_dataset_filters:
                    - 
                      - ai_search_volume
                      - '>'
                      - 10
                  limit: 3
                  internal_list_limit: 2
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AiOptimizationLlmMentionsTopMentionedBrandCategoriesLiteLiveResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/ai_optimization/llm_mentions/historical/live:
    post:
      tags:
        - AiOptimization
      description: "‌‌\nLive LLM Mentions Historical endpoint provides month-by-month historical metrics for mentions of the keywords or domains specified in the target array of the request. For each month, the response returns the total mentions count and ai_search_volume rate. The results are specific to the selected platform (google for Google’s  AI Overview or chat_gpt for ChatGPT), location and language parameters (see the List of Locations & Languages)."
      operationId: LlmMentionsHistoricalLive
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AiOptimizationLlmMentionsHistoricalLiveRequestInfo'
                nullable: true
              example:
                - language_code: es
                  location_code: 2840
                  platform: google
                  target:
                    - domain: en.wikipedia.org
                      search_filter: exclude
                    - keyword: bmw
                      search_scope:
                        - answer
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AiOptimizationLlmMentionsHistoricalLiveResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/ai_optimization/llm_mentions/timeseries_delta/live:
    post:
      tags:
        - AiOptimization
      description: "‌‌\nThe Live LLM Mentions Timeseries Delta endpoint provides the difference in historical mentions and AI search volume data between two specified dates. The results are specific to the specified target (keyword or domain), selected platform (google for Google’s  AI Overview or chat_gpt for ChatGPT), as well as location and language parameters (see the List of Locations & Languages)."
      operationId: LlmMentionsTimeseriesDeltaLive
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AiOptimizationLlmMentionsTimeseriesDeltaLiveRequestInfo'
                nullable: true
              example:
                - language_name: English
                  location_code: 2840
                  target:
                    - domain: dataforseo.com
                      search_filter: exclude
                    - keyword: bmw
                      search_scope:
                        - answer
                  platform: google
                  date_from: '2025-08-01'
                  date_to: '2025-12-01'
                  group_range: month
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AiOptimizationLlmMentionsTimeseriesDeltaLiveResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/ai_optimization/llm_mentions/timeseries_new_lost/live:
    post:
      tags:
        - AiOptimization
      description: "‌‌\nThis endpoint will provide you with the number of new and lost LLM mentions, as well as ai_search_volume for the domain or keyword specified in the target field."
      operationId: LlmMentionsTimeseriesNewLostLive
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AiOptimizationLlmMentionsTimeseriesNewLostLiveRequestInfo'
                nullable: true
              example:
                - language_name: English
                  location_code: 2840
                  target:
                    - domain: dataforseo.com
                      search_filter: exclude
                    - keyword: serp
                      search_scope:
                        - answer
                  platform: google
                  date_from: '2025-08-01'
                  date_to: '2025-12-01'
                  group_range: month
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AiOptimizationLlmMentionsTimeseriesNewLostLiveResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/on_page/id_list:
    post:
      tags:
        - OnPage
      description: 'This endpoint is designed to provide you with a list of IDs and metadata for all On-Page tasks created within the specified time period, including both successful and uncompleted tasks.'
      operationId: OnPageIdList
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/OnPageIdListRequestInfo'
                nullable: true
              example:
                - datetime_from: '2026-09-10 11:12:35'
                  datetime_to: '2026-09-20 11:12:35'
                  limit: 10
                  include_metadata: true
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/OnPageIdListResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/on_page/errors:
    post:
      tags:
        - OnPage
      description: By calling this endpoint you will receive information about the OnPage API tasks that returned an error within the past 7 days.
      operationId: OnPageErrors
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/OnPageErrorsRequestInfo'
                nullable: true
              example:
                - limit: 10
                  offset: 0
                  filtered_function: pingback_url
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/OnPageErrorsResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/on_page/force_stop:
    post:
      tags:
        - OnPage
      description: "‌‌\nThis endpoint is designed to force stop the crawl process of websites you specified in a task. The execution of all the tasks associated with the IDs indicated in your request to this endpoint will be stopped. You will still be able to obtain the data on pages that have been scanned until the crawling process was stopped."
      operationId: ForceStop
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/OnPageForceStopRequestInfo'
                nullable: true
              example:
                - id: 08121600-1535-0216-0000-37b4c7a34453
                - id: 08121600-1535-0216-0000-d6a5000b6897
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/OnPageForceStopResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/on_page/available_filters:
    get:
      tags:
        - OnPage
      description: "OnPage API supports plenty of customizable crawling parameters that allow you to adapt the extraction of website data to your requirements and modify the thresholds for various performance indicators.\n‌‌\nHere you will find all the necessary information about filters and thresholds that can be used with DataForSEO OnPage API endpoints."
      operationId: OnPageAvailableFilters
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/OnPageAvailableFiltersResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/on_page/task_post:
    post:
      tags:
        - OnPage
      description: "‌\nOnPage API checks websites for 60+ customizable on-page parameters defines and displays all found flaws and opportunities for optimization so that you can easily fix them. It checks meta tags, duplicate content, image tags, response codes, and other parameters on every page. You can find the full list of OnPage API check-up parameters in the Pages section."
      operationId: TaskPost
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/OnPageTaskPostRequestInfo'
                nullable: true
              example:
                - target: dataforseo.com
                  max_crawl_pages: 10
                  load_resources: true
                  enable_javascript: true
                  custom_js: 'meta = {}; meta.url = document.URL; meta;'
                  tag: some_string_123
                  pingback_url: https://your-server.com/pingscript?id=$id&tag=$tag
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/OnPageTaskPostResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/on_page/tasks_ready:
    get:
      tags:
        - OnPage
      description: "‌\nThe ‘Tasks Ready’ endpoint is designed to provide you with a list of completed tasks, which results haven’t been collected yet."
      operationId: OnPageTasksReady
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/OnPageTasksReadyResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  '/v3/on_page/summary/{id}':
    get:
      tags:
        - OnPage
      description: "‌\nUsing this function, you can get the overall information on a website as well as drill down into exact on-page issues of a website that has been scanned. As a result, you will know what functions to use for receiving detailed data for each of the found issues."
      operationId: Summary
      parameters:
        - name: id
          in: path
          description: <em>task identifier</em><br><strong>required field</strong><br>you can get this ID in the response of the <a href="/v3/on_page/task_post/" target="_blank" rel="noopener noreferrer">Task POST</a> endpoint<br>example:<br>“07131248-1535-0216-1000-17384017ad04”
          required: true
          schema:
            type: string
          example: 00000000-0000-0000-0000-000000000000
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/OnPageSummaryResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/on_page/pages:
    post:
      tags:
        - OnPage
      description: "This endpoint returns a list of crawled pages with on-page check-ups and other metrics related to the page performance.\nUsing this function you will get page-specific data with detailed information on how well your pages are optimized for search.\nfor more info please visit 'https://docs.dataforseo.com/v3/on_page/pages/?bash'"
      operationId: Pages
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/OnPagePagesRequestInfo'
                nullable: true
              example:
                - id: 07281559-0695-0216-0000-c269be8b7592
                  filters:
                    - 
                      - resource_type
                      - =
                      - html
                    - and
                    - 
                      - meta.scripts_count
                      - '>'
                      - 40
                  order_by:
                    - 'meta.content.plain_text_word_count,desc'
                  limit: 10
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/OnPagePagesResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/on_page/pages_by_resource:
    post:
      tags:
        - OnPage
      description: "‌‌\nThis endpoint will return the list of pages where a specific resource is located. Using this function you will also get the data related to the pages that contain a specified resource.\nYou can get the URL of a resource using the Resources endpoint."
      operationId: PagesByResource
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/OnPagePagesByResourceRequestInfo'
                nullable: true
              example:
                - id: 02241700-1535-0216-0000-034137259bc1
                  url: https://www.etsy.com/about/jobs.workco2018.js?
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/OnPagePagesByResourceResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/on_page/resources:
    post:
      tags:
        - OnPage
      description: "‌‌\nThis endpoint will provide you with a list of resources, including images, scripts, stylesheets, and broken elements.\nYou will get a detailed overview of every resource found on the crawled pages."
      operationId: Resources
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/OnPageResourcesRequestInfo'
                nullable: true
              example:
                - id: 07281559-0695-0216-0000-c269be8b7592
                  filters:
                    - 
                      - resource_type
                      - =
                      - image
                    - and
                    - 
                      - size
                      - '>'
                      - 100000
                  order_by:
                    - 'size,desc'
                  limit: 10
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/OnPageResourcesResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/on_page/duplicate_tags:
    post:
      tags:
        - OnPage
      description: "‌‌\nThis endpoint returns a list of pages that contain duplicate title or description tags. The response also contains data related to page performance."
      operationId: DuplicateTags
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/OnPageDuplicateTagsRequestInfo'
                nullable: true
              example:
                - id: 07281559-0695-0216-0000-c269be8b7592
                  type: duplicate_description
                  limit: 10
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/OnPageDuplicateTagsResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/on_page/duplicate_content:
    post:
      tags:
        - OnPage
      description: "‌‌\nThis endpoint returns a list of pages that have content similar to the page specified in the request. The response also contains data related to page performance and the similarity index that indicates how similar the compared pages are."
      operationId: DuplicateContent
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/OnPageDuplicateContentRequestInfo'
                nullable: true
              example:
                - id: 07281559-0695-0216-0000-c269be8b7592
                  url: https://www.etsy.com/
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/OnPageDuplicateContentResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/on_page/links:
    post:
      tags:
        - OnPage
      description: "‌‌\nThis endpoint will provide you with a list of internal and external links detected on a target website.\nThe following link types are supported:\nanchor – links that point to a specific portion of a webpage;\nimage – links that point to an image;\ncanonical – links that point to a canonical page;\nmeta – links with meta http-equiv=refresh ;\nalternate – links with link rel=\"alternate\" pointing to an alternative version of a webpage ;\nredirect – links with redirect status."
      operationId: Links
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/OnPageLinksRequestInfo'
                nullable: true
              example:
                - id: 07281559-0695-0216-0000-c269be8b7592
                  page_from: /apis/google-trends-api
                  filters:
                    - 
                      - dofollow
                      - =
                      - true
                    - and
                    - 
                      - direction
                      - =
                      - external
                  limit: 10
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/OnPageLinksResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/on_page/redirect_chains:
    post:
      tags:
        - OnPage
      description: "‌‌\nRedirect chains occur when there are at least two redirects between the initial URL and the destination URL. For example, if page A redirects to page B which redirects to page C, such a series of redirects is considered a redirect chain. Sometimes, if page B redirects back to page A, the redirect chain becomes closed and is considered a redirect loop."
      operationId: RedirectChains
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/OnPageRedirectChainsRequestInfo'
                nullable: true
              example:
                - id: 03051327-4536-0216-1000-3b458a2cfcca
                  url: https://test_rdr.dataforseo.com/a/
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/OnPageRedirectChainsResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/on_page/non_indexable:
    post:
      tags:
        - OnPage
      description: "‌‌\nThis endpoint returns a list of pages that are blocked from being indexed by Google and other search engines through robots.txt, HTTP headers, or meta tags settings."
      operationId: NonIndexable
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/OnPageNonIndexableRequestInfo'
                nullable: true
              example:
                - id: 07281559-0695-0216-0000-c269be8b7592
                  filters:
                    - 
                      - reason
                      - =
                      - robots_txt
                    - and
                    - 
                      - url
                      - like
                      - '%go%'
                  limit: 10
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/OnPageNonIndexableResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/on_page/waterfall:
    post:
      tags:
        - OnPage
      description: "‌‌\nThis endpoint is designed to provide you with the page speed insights. Using this function you can get detailed information about the page loading time, time to secure connection, the time it takes to load page resources, and so on."
      operationId: Waterfall
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/OnPageWaterfallRequestInfo'
                nullable: true
              example:
                - id: 08101204-0696-0216-0000-644a7b21a48a
                  url: https://dataforseo.com/tag/broken-links
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/OnPageWaterfallResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/on_page/keyword_density:
    post:
      tags:
        - OnPage
      description: "‌‌\nThis endpoint will provide you with keyword density and keyword frequency data for terms appearing on the specified website or web page. You can filter and sort the data that will be retrieved with this API call."
      operationId: KeywordDensity
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/OnPageKeywordDensityRequestInfo'
                nullable: true
              example:
                - id: 09101923-1535-0216-0000-2389a8854b70
                  url: https://dataforseo.com/
                  keyword_length: 2
                  filters:
                    - frequency
                    - '>'
                    - 5
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/OnPageKeywordDensityResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/on_page/microdata:
    post:
      tags:
        - OnPage
      description: "‌‌\nThis endpoint is designed to validate structured JSON-LD data and Microdata. Using this function you will obtain microdata available on the specified page of the target website and detailed results of its validation.\nTo use this endpoint, set the validate_micromarkup parameter to true in the POST request to OnPage API."
      operationId: Microdata
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/OnPageMicrodataRequestInfo'
                nullable: true
              example:
                - id: 02241700-1535-0216-0000-034137259bc1
                  url: https://dataforseo.com/apis
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/OnPageMicrodataResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/on_page/uncrawlable_resources:
    post:
      tags:
        - OnPage
      description: ‌‌This endpoint returns a list of resources detected on the target website that could not be crawled due to a content type inconsistency. A resource is considered uncrawlable when the content type returned in the server response does not match the content type expected based on how the resource is referenced in the page HTML.
      operationId: UncrawlableResources
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/OnPageUncrawlableResourcesRequestInfo'
                nullable: true
              example:
                - id: 07281559-0695-0216-0000-c269be8b7592
                  filters:
                    - 
                      - meta.content_type
                      - =
                      - image/jpeg
                    - and
                    - 
                      - url
                      - like
                      - '%go%'
                  limit: 10
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/OnPageUncrawlableResourcesResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/on_page/raw_html:
    post:
      tags:
        - OnPage
      description: "‌‌\nThis endpoint returns the HTML of a page you indicate in the request."
      operationId: RawHtml
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/OnPageRawHtmlRequestInfo'
                nullable: true
              example:
                - id: 07281559-0695-0216-0000-c269be8b7592
                  url: https://dataforseo.com/apis
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/OnPageRawHtmlResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/on_page/page_screenshot:
    post:
      tags:
        - OnPage
      description: "‌‌\nUsing this endpoint, you can capture a full high-quality screenshot of any webpage. In this way, you can review the target page as the DataForSEO crawler and Googlebot see it."
      operationId: PageScreenshot
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/OnPagePageScreenshotRequestInfo'
                nullable: true
              example:
                - url: https://dataforseo.com/apis
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/OnPagePageScreenshotResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/on_page/content_parsing:
    post:
      tags:
        - OnPage
      description: "‌‌\nThis endpoint allows parsing the content on any page you specify and will return the structured content of the target page, including link URLs, anchors, headings, and textual content."
      operationId: ContentParsing
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/OnPageContentParsingRequestInfo'
                nullable: true
              example:
                - url: https://dataforseo.com/blog/a-versatile-alternative-to-google-trends-exploring-the-power-of-dataforseo-trends-api
                  id: 11161551-1535-0216-0000-500b3f307f92
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/OnPageContentParsingResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/on_page/content_parsing/live:
    post:
      tags:
        - OnPage
      description: "‌‌\nThis endpoint allows parsing the content on any page you specify and will return the structured content of the target page, including link URLs, anchors, headings, and textual content."
      operationId: ContentParsingLive
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/OnPageContentParsingLiveRequestInfo'
                nullable: true
              example:
                - url: https://dataforseo.com/blog/a-versatile-alternative-to-google-trends-exploring-the-power-of-dataforseo-trends-api
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/OnPageContentParsingLiveResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/on_page/instant_pages:
    post:
      tags:
        - OnPage
      description: "Using this function you will get page-specific data with detailed information on how well a particular page is optimized for organic search.\nfor more info please visit 'https://docs.dataforseo.com/v3/on_page/instant_pages/?bash'"
      operationId: InstantPages
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/OnPageInstantPagesRequestInfo'
                nullable: true
              example:
                - url: https://dataforseo.com/blog
                  enable_javascript: true
                  custom_js: 'meta = {}; meta.url = document.URL; meta;'
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/OnPageInstantPagesResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/on_page/lighthouse/languages:
    get:
      tags:
        - OnPage
      description: "You will receive the list of languages by calling this API.\n \nAs a response of the API server, you will receive JSON-encoded data containing a tasks array with the information specific to the set tasks."
      operationId: LighthouseLanguages
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/OnPageLighthouseLanguagesResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/on_page/lighthouse/audits:
    get:
      tags:
        - OnPage
      description: The OnPage Lighthouse API is based on Google’s open-source Lighthouse project and provides data on the quality of web pages.
      operationId: LighthouseAudits
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/OnPageLighthouseAuditsResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/on_page/lighthouse/versions:
    get:
      tags:
        - OnPage
      description: OnPage Lighthouse API is based on Google’s open-source Lighthouse project and provides data on the quality of web pages.
      operationId: LighthouseVersions
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/OnPageLighthouseVersionsResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/on_page/lighthouse/task_post:
    post:
      tags:
        - OnPage
      description: ‌The OnPage Lighthouse API is based on Google’s open-source Lighthouse project for measuring the quality of web pages and web apps.
      operationId: LighthouseTaskPost
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/OnPageLighthouseTaskPostRequestInfo'
                nullable: true
              example:
                - url: https://dataforseo.com
                  for_mobile: true
                  tag: some_string_123
                  pingback_url: https://your-server.com/pingscript?id=$id&tag=$tag
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/OnPageLighthouseTaskPostResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/on_page/lighthouse/tasks_ready:
    get:
      tags:
        - OnPage
      description: "‌\nThe ‘Tasks Ready’ endpoint is designed to provide you with the list of completed tasks, which haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed tasks using this endpoint. Then, you can collect the results using the ‘Task GET’ endpoint."
      operationId: LighthouseTasksReady
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/OnPageLighthouseTasksReadyResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  '/v3/on_page/lighthouse/task_get/json/{id}':
    get:
      tags:
        - OnPage
      description: "‌\nThe OnPage Lighthouse API is based on Google’s open-source Lighthouse project for measuring the quality of web pages and web apps. This endpoint will provide you with the results of Lighthouse Audit. Use the id received in the response of your Task POST request to get the results. The response will include data about all categories and audits specified in the Task POST. By default, the response will include all available data about the webpage including its performance, accessibility, progressive web apps, SEO, and compliance with best practices."
      operationId: LighthouseTaskGetJson
      parameters:
        - name: id
          in: path
          description: <em>task identifier</em><br><strong>required field</strong><br>you can get this ID in the response of the Task POST endpoint<br>example:<br>“07131248-1535-0216-1000-17384017ad04”
          required: true
          schema:
            type: string
          example: 00000000-0000-0000-0000-000000000000
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/OnPageLighthouseTaskGetJsonResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/on_page/lighthouse/live/json:
    post:
      tags:
        - OnPage
      description: ‌The OnPage Lighthouse API is based on Google’s open-source Lighthouse project for measuring the quality of web pages and web apps.
      operationId: LighthouseLiveJson
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/OnPageLighthouseLiveJsonRequestInfo'
                nullable: true
              example:
                - url: https://dataforseo.com
                  for_mobile: true
                  tag: some_string_123
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/OnPageLighthouseLiveJsonResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/content_analysis/id_list:
    post:
      tags:
        - ContentAnalysis
      description: 'This endpoint is designed to provide you with a list of IDs and metadata for all Content Analysis tasks created within the specified time period, including both successful and uncompleted tasks.'
      operationId: ContentAnalysisIdList
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/ContentAnalysisIdListRequestInfo'
                nullable: true
              example:
                - datetime_from: '2026-09-10 11:12:35'
                  datetime_to: '2026-09-20 11:12:35'
                  limit: 10
                  include_metadata: true
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/ContentAnalysisIdListResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/content_analysis/available_filters:
    get:
      tags:
        - ContentAnalysis
      description: "‌‌\nHere you will find all the necessary information about filters that can be used with Content Analysis API endpoints."
      operationId: ContentAnalysisAvailableFilters
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/ContentAnalysisAvailableFiltersResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/content_analysis/locations:
    get:
      tags:
        - ContentAnalysis
      description: You will receive the list of locations by this API call.
      operationId: Locations
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/ContentAnalysisLocationsResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/content_analysis/languages:
    get:
      tags:
        - ContentAnalysis
      description: "You will receive the list of languages by calling this API.\n \nAs a response of the API server, you will receive JSON-encoded data containing a tasks array with the information specific to the set tasks."
      operationId: Languages
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/ContentAnalysisLanguagesResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/content_analysis/categories:
    get:
      tags:
        - ContentAnalysis
      description: "We use Google product and service categories. This endpoint will provide you with the full list of available categories.\nYou can also download the CSV file by this link."
      operationId: ContentAnalysisCategories
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/ContentAnalysisCategoriesResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/content_analysis/search/live:
    post:
      tags:
        - ContentAnalysis
      description: "‌\nThis endpoint will provide you with detailed citation data available for the target keyword."
      operationId: SearchLive
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/ContentAnalysisSearchLiveRequestInfo'
                nullable: true
              example:
                - keyword_fields:
                    snippet: logitech
                  keyword: logitech
                  page_type:
                    - ecommerce
                    - news
                    - blogs
                    - message-boards
                    - organization
                  search_mode: as_is
                  filters:
                    - main_domain
                    - =
                    - reviewfinder.ca
                  order_by:
                    - 'content_info.sentiment_connotations.anger,desc'
                  limit: 10
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/ContentAnalysisSearchLiveResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/content_analysis/summary/live:
    post:
      tags:
        - ContentAnalysis
      description: "‌\nThis endpoint will provide you with an overview of citation data available for the target keyword."
      operationId: ContentAnalysisSummaryLive
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/ContentAnalysisSummaryLiveRequestInfo'
                nullable: true
              example:
                - keyword: logitech
                  page_type:
                    - ecommerce
                    - news
                    - blogs
                    - message-boards
                    - organization
                  internal_list_limit: 8
                  positive_connotation_threshold: 0.5
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/ContentAnalysisSummaryLiveResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/content_analysis/sentiment_analysis/live:
    post:
      tags:
        - ContentAnalysis
      description: "This endpoint will provide you with sentiment analysis data for the citations available for the target keyword.\nfor more info please visit 'https://docs.dataforseo.com/v3/content_analysis/sentiment_analysis/live/?bash'"
      operationId: SentimentAnalysisLive
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/ContentAnalysisSentimentAnalysisLiveRequestInfo'
                nullable: true
              example:
                - keyword: logitech
                  internal_list_limit: 1
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/ContentAnalysisSentimentAnalysisLiveResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/content_analysis/rating_distribution/live:
    post:
      tags:
        - ContentAnalysis
      description: "‌\nThis endpoint will provide you with rating distribution data for the keyword and other parameters specified in the request."
      operationId: RatingDistributionLive
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/ContentAnalysisRatingDistributionLiveRequestInfo'
                nullable: true
              example:
                - keyword: logitech
                  search_mode: as_is
                  internal_list_limit: 10
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/ContentAnalysisRatingDistributionLiveResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/content_analysis/phrase_trends/live:
    post:
      tags:
        - ContentAnalysis
      description: "‌\nThis endpoint will provide you with data on all citations of the target keyword for the indicated date range."
      operationId: PhraseTrendsLive
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/ContentAnalysisPhraseTrendsLiveRequestInfo'
                nullable: true
              example:
                - keyword: logitech
                  search_mode: as_is
                  date_from: '2022-09-01'
                  date_group: month
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/ContentAnalysisPhraseTrendsLiveResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/content_analysis/category_trends/live:
    post:
      tags:
        - ContentAnalysis
      description: "‌\nThis endpoint will provide you with data on all citations in the target category for the indicated date range."
      operationId: CategoryTrendsLive
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/ContentAnalysisCategoryTrendsLiveRequestInfo'
                nullable: true
              example:
                - category_code: 10994
                  search_mode: as_is
                  date_from: '2022-09-01'
                  date_group: month
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/ContentAnalysisCategoryTrendsLiveResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/merchant/id_list:
    post:
      tags:
        - Merchant
      description: 'This endpoint is designed to provide you with a list of IDs and metadata for all Merchant tasks created within the specified time period, including both successful and uncompleted tasks.'
      operationId: MerchantIdList
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/MerchantIdListRequestInfo'
                nullable: true
              example:
                - datetime_from: '2026-09-10 11:12:35'
                  datetime_to: '2026-09-20 11:12:35'
                  limit: 10
                  include_metadata: true
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/MerchantIdListResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/merchant/errors:
    post:
      tags:
        - Merchant
      description: By calling this endpoint you will receive information about the Merchant API tasks that returned an error within the past 7 days.
      operationId: MerchantErrors
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/MerchantErrorsRequestInfo'
                nullable: true
              example:
                - limit: 10
                  offset: 0
                  filtered_function: pingback_url
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/MerchantErrorsResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/merchant/google/languages:
    get:
      tags:
        - Merchant
      description: You will receive the list of supported Google Shopping languages by calling this API.
      operationId: MerchantGoogleLanguages
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/MerchantGoogleLanguagesResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/merchant/google/locations:
    get:
      tags:
        - Merchant
      description: ''
      operationId: MerchantGoogleLocations
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/MerchantGoogleLocationsResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  '/v3/merchant/google/locations/{country}':
    get:
      tags:
        - Merchant
      description: ''
      operationId: MerchantGoogleLocationsCountry
      parameters:
        - name: country
          in: path
          description: <em>country ISO code</em><br>optional field<br>specify the ISO code if you want to filter the list of locations by country<br>example:<br><code>us</code>
          required: true
          schema:
            type: string
          example: us
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/MerchantGoogleLocationsCountryResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/merchant/google/products/task_post:
    post:
      tags:
        - Merchant
      description: "‌‌\nGoogle Shopping Products endpoint will provide you with the list of products found on Google Shopping for the specified query. The results include product title, description in Google Shopping SERP, product rank, price, reviews and rating as well as the related domain."
      operationId: GoogleProductsTaskPost
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/MerchantGoogleProductsTaskPostRequestInfo'
                nullable: true
              example:
                - language_code: en
                  location_code: 2840
                  keyword: iphone
                  price_min: 5
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/MerchantGoogleProductsTaskPostResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/merchant/google/products/tasks_ready:
    get:
      tags:
        - Merchant
      description: "‌\nThe ‘Tasks Ready’ endpoint is designed to provide you with the list of completed tasks, which haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed tasks using this endpoint. Then, you can collect the results using the ‘Task GET’ endpoint."
      operationId: GoogleProductsTasksReady
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/MerchantGoogleProductsTasksReadyResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/merchant/tasks_ready:
    get:
      tags:
        - Merchant
      description: "‌\nThe ‘Tasks Ready’ endpoint is designed to provide you with the list of completed tasks, which haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed tasks using this endpoint. Then, you can collect the results using the ‘Task GET’ endpoint."
      operationId: MerchantTasksReady
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/MerchantTasksReadyResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  '/v3/merchant/google/products/task_get/advanced/{id}':
    get:
      tags:
        - Merchant
      description: 'Description of the fields for sending a request:'
      operationId: GoogleProductsTaskGetAdvanced
      parameters:
        - name: id
          in: path
          description: <em>task identifier</em><br><strong>unique task identifier in our system in the <a href="https://en.wikipedia.org/wiki/Universally_unique_identifier">UUID</a> format</strong><br>you will be able to use it within <strong>30 days</strong> to request the results of the task at any time
          required: true
          schema:
            type: string
          example: 00000000-0000-0000-0000-000000000000
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/MerchantGoogleProductsTaskGetAdvancedResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  '/v3/merchant/google/products/task_get/html/{id}':
    get:
      tags:
        - Merchant
      description: 'Description of the fields for sending a request:'
      operationId: GoogleProductsTaskGetHtml
      parameters:
        - name: id
          in: path
          description: <em>task identifier</em><br><strong>unique task identifier in our system in the <a href="https://en.wikipedia.org/wiki/Universally_unique_identifier">UUID</a> format</strong><br>you will be able to use it within <strong>7 days</strong> to request the results of the task at any time
          required: true
          schema:
            type: string
          example: 00000000-0000-0000-0000-000000000000
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/MerchantGoogleProductsTaskGetHtmlResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/merchant/google/sellers/task_post:
    post:
      tags:
        - Merchant
      description: "‌‌\nGoogle Shopping Sellers endpoint will provide you with the list of top 10 sellers that listed the specified product on Google Shopping. The provided data for each seller includes related product base and total price, shipment and purchase details and special offers. The results are specific to the selected location (see the List of Locations) and language (see the List of Languages) settings."
      operationId: GoogleSellersTaskPost
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/MerchantGoogleSellersTaskPostRequestInfo'
                nullable: true
              example:
                - language_code: en
                  location_code: 2840
                  product_id: '1113158713975221117'
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/MerchantGoogleSellersTaskPostResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/merchant/google/sellers/tasks_ready:
    get:
      tags:
        - Merchant
      description: "‌\nThe ‘Tasks Ready’ endpoint is designed to provide you with the list of completed tasks, which haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed tasks using this endpoint. Then, you can collect the results using the ‘Task GET’ endpoint."
      operationId: GoogleSellersTasksReady
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/MerchantGoogleSellersTasksReadyResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  '/v3/merchant/google/sellers/task_get/advanced/{id}':
    get:
      tags:
        - Merchant
      description: 'Description of the fields for sending a request:'
      operationId: GoogleSellersTaskGetAdvanced
      parameters:
        - name: id
          in: path
          description: <em>task identifier</em><br><strong>unique task identifier in our system in the <a href="https://en.wikipedia.org/wiki/Universally_unique_identifier">UUID</a> format</strong><br>you will be able to use it within <strong>30 days</strong> to request the results of the task at any time
          required: true
          schema:
            type: string
          example: 00000000-0000-0000-0000-000000000000
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/MerchantGoogleSellersTaskGetAdvancedResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/merchant/google/product_info/task_post:
    post:
      tags:
        - Merchant
      description: "‌‌\nThis endpoint provides data on a product listed on Google Shopping, including product description, images, rating, variations, specifications and sellers. In order to set a task, you have to specify one of the following fields:  product_id, data_docid, or gid."
      operationId: GoogleProductInfoTaskPost
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/MerchantGoogleProductInfoTaskPostRequestInfo'
                nullable: true
              example:
                - language_code: en
                  location_code: 2840
                  product_id: '1113158713975221117'
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/MerchantGoogleProductInfoTaskPostResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/merchant/google/product_info/tasks_ready:
    get:
      tags:
        - Merchant
      description: "‌\nThe ‘Tasks Ready’ endpoint is designed to provide you with the list of completed tasks, which haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed tasks using this endpoint. Then, you can collect the results using the ‘Task GET’ endpoint."
      operationId: GoogleProductInfoTasksReady
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/MerchantGoogleProductInfoTasksReadyResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  '/v3/merchant/google/product_info/task_get/advanced/{id}':
    get:
      tags:
        - Merchant
      description: 'Description of the fields for sending a request:'
      operationId: GoogleProductInfoTaskGetAdvanced
      parameters:
        - name: id
          in: path
          description: <em>task identifier</em><br><strong>unique task identifier in our system in the <a href="https://en.wikipedia.org/wiki/Universally_unique_identifier">UUID</a> format</strong><br>you will be able to use it within <strong>30 days</strong> to request the results of the task at any time
          required: true
          schema:
            type: string
          example: 00000000-0000-0000-0000-000000000000
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/MerchantGoogleProductInfoTaskGetAdvancedResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  '/v3/merchant/google/sellers/ad_url/{shop_ad_aclk}':
    get:
      tags:
        - Merchant
      description: Google Shopping Sellers Ad URL is designed to provide you with a full URL of the advertisement containing all additional parameters set by the seller.
      operationId: GoogleSellersAdUrl
      parameters:
        - name: shop_ad_aclk
          in: path
          description: <em>unique ad click referral parameter</em><br>you can obtain this parameter with <a href="/v3/merchant/google/products/task_post/" target="_blank" rel="noopener noreferrer">Google Shopping Products</a> or <a href="/v3/merchant/google/sellers/task_post/" target="_blank" rel="noopener noreferrer">Google Shopping Sellers</a>
          required: true
          schema:
            type: string
          example: DChcSEwiSl5TKpbPoAhVFmdUKHfa_B_wYABADGgJ3cw&sig
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/MerchantGoogleSellersAdUrlResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/merchant/amazon/locations:
    get:
      tags:
        - Merchant
      description: You will receive the list of supported Amazon locations by this API call. You can filter the list of locations by country when setting a task.
      operationId: AmazonLocations
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/MerchantAmazonLocationsResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  '/v3/merchant/amazon/locations/{country}':
    get:
      tags:
        - Merchant
      description: You will receive the list of supported Amazon locations by this API call. You can filter the list of locations by country when setting a task.
      operationId: AmazonLocationsCountry
      parameters:
        - name: country
          in: path
          description: <em>country ISO code</em><br>optional field<br>specify the ISO code if you want to filter the list of locations by country<br>example:<br><code>us</code>
          required: true
          schema:
            type: string
          example: us
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/MerchantAmazonLocationsCountryResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/merchant/amazon/languages:
    get:
      tags:
        - Merchant
      description: You will receive the list of supported Amazon languages by calling this API.
      operationId: AmazonLanguages
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/MerchantAmazonLanguagesResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/merchant/amazon/products/task_post:
    post:
      tags:
        - Merchant
      description: "‌‌\nThis endpoint provides results from Amazon product listings according to the specified keyword (product name), location, and language parameters."
      operationId: AmazonProductsTaskPost
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/MerchantAmazonProductsTaskPostRequestInfo'
                nullable: true
              example:
                - language_code: en_US
                  location_code: 2840
                  keyword: shoes
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/MerchantAmazonProductsTaskPostResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/merchant/amazon/products/tasks_ready:
    get:
      tags:
        - Merchant
      description: "‌\nThe ‘Tasks Ready’ endpoint is designed to provide you with the list of completed tasks, which haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed tasks using this endpoint. Then, you can collect the results using the ‘Task GET’ endpoint."
      operationId: AmazonProductsTasksReady
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/MerchantAmazonProductsTasksReadyResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  '/v3/merchant/amazon/products/task_get/advanced/{id}':
    get:
      tags:
        - Merchant
      description: 'Description of the fields for sending a request:'
      operationId: AmazonProductsTaskGetAdvanced
      parameters:
        - name: id
          in: path
          description: <em>task identifier</em><br><strong>unique task identifier in our system in the <a href="https://en.wikipedia.org/wiki/Universally_unique_identifier">UUID</a> format</strong><br>you will be able to use it within <strong>30 days</strong> to request the results of the task at any time
          required: true
          schema:
            type: string
          example: 00000000-0000-0000-0000-000000000000
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/MerchantAmazonProductsTaskGetAdvancedResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/merchant/amazon/products/live/advanced:
    post:
      tags:
        - Merchant
      description: "‌‌\nThis endpoint provides results from Amazon product listings according to the specified keyword (product name), location, and language parameters."
      operationId: AmazonProductsLiveAdvanced
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/MerchantAmazonProductsLiveAdvancedRequestInfo'
                nullable: true
              example:
                - language_code: en_US
                  location_code: 2840
                  keyword: shoes
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/MerchantAmazonProductsLiveAdvancedResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  '/v3/merchant/amazon/products/task_get/html/{id}':
    get:
      tags:
        - Merchant
      description: 'Description of the fields for sending a request:'
      operationId: AmazonProductsTaskGetHtml
      parameters:
        - name: id
          in: path
          description: <em>task identifier</em><br><strong>unique task identifier in our system in the <a href="https://en.wikipedia.org/wiki/Universally_unique_identifier">UUID</a> format</strong><br>you will be able to use it within <strong>7 days</strong> to request the results of the task at any time
          required: true
          schema:
            type: string
          example: 00000000-0000-0000-0000-000000000000
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/MerchantAmazonProductsTaskGetHtmlResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/merchant/amazon/products/live/html:
    post:
      tags:
        - Merchant
      description: "‌‌\nThis endpoint provides results in the HTML format."
      operationId: AmazonProductsLiveHtml
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/MerchantAmazonProductsLiveHtmlRequestInfo'
                nullable: true
              example:
                - language_code: en_US
                  location_code: 2840
                  keyword: shoes
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/MerchantAmazonProductsLiveHtmlResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/merchant/amazon/asin/task_post:
    post:
      tags:
        - Merchant
      description: "‌‌\nThis endpoint will provide you with a full list of ASINs assigned to different modifications of a product."
      operationId: AmazonAsinTaskPost
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/MerchantAmazonAsinTaskPostRequestInfo'
                nullable: true
              example:
                - language_code: en_US
                  location_code: 2840
                  asin: B0756FCPPN
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/MerchantAmazonAsinTaskPostResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/merchant/amazon/asin/tasks_ready:
    get:
      tags:
        - Merchant
      description: "‌\nThe ‘Tasks Ready’ endpoint is designed to provide you with the list of completed tasks, which haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed tasks using this endpoint. Then, you can collect the results using the ‘Task GET’ endpoints."
      operationId: AmazonAsinTasksReady
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/MerchantAmazonAsinTasksReadyResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  '/v3/merchant/amazon/asin/task_get/advanced/{id}':
    get:
      tags:
        - Merchant
      description: This endpoint will provide you with information about the product and ASINs of all its modifications listed on Amazon.
      operationId: AmazonAsinTaskGetAdvanced
      parameters:
        - name: id
          in: path
          description: <em>task identifier</em><br><strong>unique task identifier in our system in the <a href="https://en.wikipedia.org/wiki/Universally_unique_identifier">UUID</a> format</strong><br>you will be able to use it within <strong>30 days</strong> to request the results of the task at any time
          required: true
          schema:
            type: string
          example: 00000000-0000-0000-0000-000000000000
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/MerchantAmazonAsinTaskGetAdvancedResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/merchant/amazon/asin/live/advanced:
    post:
      tags:
        - Merchant
      description: "‌‌\nThis endpoint will provide you with a full list of ASINs assigned to different modifications of a product."
      operationId: AmazonAsinLiveAdvanced
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/MerchantAmazonAsinLiveAdvancedRequestInfo'
                nullable: true
              example:
                - language_code: en_US
                  location_code: 2840
                  asin: B0756FCPPN
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/MerchantAmazonAsinLiveAdvancedResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  '/v3/merchant/amazon/asin/task_get/html/{id}':
    get:
      tags:
        - Merchant
      description: 'Description of the fields for sending a request:'
      operationId: AmazonAsinTaskGetHtml
      parameters:
        - name: id
          in: path
          description: <em>task identifier</em><br><strong>unique task identifier in our system in the <a href="https://en.wikipedia.org/wiki/Universally_unique_identifier">UUID</a> format</strong><br>you will be able to use it within <strong>7 days</strong> to request the results of the task at any time
          required: true
          schema:
            type: string
          example: 00000000-0000-0000-0000-000000000000
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/MerchantAmazonAsinTaskGetHtmlResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/merchant/amazon/asin/live/html:
    post:
      tags:
        - Merchant
      description: "‌‌\nThis endpoint will provide you with the results in the HTML format."
      operationId: AmazonAsinLiveHtml
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/MerchantAmazonAsinLiveHtmlRequestInfo'
                nullable: true
              example:
                - language_code: en_US
                  location_code: 2840
                  asin: B0756FCPPN
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/MerchantAmazonAsinLiveHtmlResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/merchant/amazon/sellers/task_post:
    post:
      tags:
        - Merchant
      description: "‌‌\nThis endpoint provides a list of sellers of the specified product on Amazon. The data provided for each seller includes related product condition, pricing, shipment, and rating details.\nThe results are specific to the selected location (see the List of Locations) and language (see the List of Languages) settings."
      operationId: AmazonSellersTaskPost
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/MerchantAmazonSellersTaskPostRequestInfo'
                nullable: true
              example:
                - language_code: en
                  location_code: 2840
                  asin: B085RFFC9Q
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/MerchantAmazonSellersTaskPostResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/merchant/amazon/sellers/tasks_ready:
    get:
      tags:
        - Merchant
      description: "‌\nThe ‘Tasks Ready’ endpoint is designed to provide you with the list of completed tasks, which haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed tasks using this endpoint. Then, you can collect the results using the ‘Task GET’ endpoint."
      operationId: AmazonSellersTasksReady
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/MerchantAmazonSellersTasksReadyResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  '/v3/merchant/amazon/sellers/task_get/advanced/{id}':
    get:
      tags:
        - Merchant
      description: 'This endpoint provides a list of sellers of the specified product on Amazon. The data provided for each seller includes related product condition, pricing, shipment, and rating details.'
      operationId: AmazonSellersTaskGetAdvanced
      parameters:
        - name: id
          in: path
          description: <em>task identifier</em><br><strong>unique task identifier in our system in the <a href="https://en.wikipedia.org/wiki/Universally_unique_identifier">UUID</a> format</strong><br>you will be able to use it within <strong>30 days</strong> to request the results of the task at any time
          required: true
          schema:
            type: string
          example: 00000000-0000-0000-0000-000000000000
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/MerchantAmazonSellersTaskGetAdvancedResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/merchant/amazon/sellers/live/advanced:
    post:
      tags:
        - Merchant
      description: "‌‌\nThis endpoint provides a list of sellers of the specified product on Amazon. The data provided for each seller includes related product condition, pricing, shipment, and rating details.\nThe results are specific to the selected location (see the List of Locations) and language (see the List of Languages) settings."
      operationId: AmazonSellersLiveAdvanced
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/MerchantAmazonSellersLiveAdvancedRequestInfo'
                nullable: true
              example:
                - language_code: en_US
                  location_code: 2840
                  asin: B07D528W98
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/MerchantAmazonSellersLiveAdvancedResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  '/v3/merchant/amazon/sellers/task_get/html/{id}':
    get:
      tags:
        - Merchant
      description: 'Description of the fields for sending a request:'
      operationId: AmazonSellersTaskGetHtml
      parameters:
        - name: id
          in: path
          description: <em>task identifier</em><br><strong>unique task identifier in our system in the <a href="https://en.wikipedia.org/wiki/Universally_unique_identifier">UUID</a> format</strong><br>you will be able to use it within <strong>7 days</strong> to request the results of the task at any time
          required: true
          schema:
            type: string
          example: 00000000-0000-0000-0000-000000000000
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/MerchantAmazonSellersTaskGetHtmlResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/merchant/amazon/sellers/live/html:
    post:
      tags:
        - Merchant
      description: "‌‌\nThis endpoint provides results in the HTML format."
      operationId: AmazonSellersLiveHtml
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/MerchantAmazonSellersLiveHtmlRequestInfo'
                nullable: true
              example:
                - language_code: en_US
                  location_code: 2840
                  asin: B085RFFC9Q
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/MerchantAmazonSellersLiveHtmlResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/app_data/id_list:
    post:
      tags:
        - AppData
      description: 'This endpoint is designed to provide you with a list of IDs and metadata for all App Data tasks created within the specified time period, including both successful and uncompleted tasks.'
      operationId: AppDataIdList
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AppDataIdListRequestInfo'
                nullable: true
              example:
                - datetime_from: '2026-09-10 11:12:35'
                  datetime_to: '2026-09-20 11:12:35'
                  limit: 10
                  include_metadata: true
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AppDataIdListResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/app_data/errors:
    post:
      tags:
        - AppData
      description: By calling this endpoint you will receive information about the App Data API tasks that returned an error within the past 7 days.
      operationId: AppDataErrors
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AppDataErrorsRequestInfo'
                nullable: true
              example:
                - limit: 10
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AppDataErrorsResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/app_data/google/categories:
    get:
      tags:
        - AppData
      description: This endpoint will provide you with a full list of app categories available on Google Play.
      operationId: GoogleCategories
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AppDataGoogleCategoriesResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/app_data/google/locations:
    get:
      tags:
        - AppData
      description: By calling this endpoint you will receive the list of Google locations supported in App Data API.
      operationId: AppDataGoogleLocations
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AppDataGoogleLocationsResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  '/v3/app_data/google/locations/{country}':
    get:
      tags:
        - AppData
      description: By calling this endpoint you will receive the list of Google locations supported in App Data API.
      operationId: AppDataGoogleLocationsCountry
      parameters:
        - name: country
          in: path
          description: "country ISO code\noptional field\nspecify the ISO code if you want to filter the list of locations by country\nexample:\nus"
          required: true
          schema:
            type: string
          example: us
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AppDataGoogleLocationsCountryResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/app_data/google/languages:
    get:
      tags:
        - AppData
      description: By calling this endpoint you will receive the list of Google languages supported in App Data API.
      operationId: AppDataGoogleLanguages
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AppDataGoogleLanguagesResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/app_data/google/app_searches/task_post:
    post:
      tags:
        - AppData
      description: "‌‌\nThis endpoint will provide you with a list of apps ranking on Google Play for the specified keyword. The returned results are specific to the indicated keyword, as well as the language and location parameters."
      operationId: GoogleAppSearchesTaskPost
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AppDataGoogleAppSearchesTaskPostRequestInfo'
                nullable: true
              example:
                - keyword: vpn
                  location_code: 2840
                  language_code: en
                  depth: 30
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AppDataGoogleAppSearchesTaskPostResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/app_data/google/app_searches/tasks_ready:
    get:
      tags:
        - AppData
      description: "‌\nThe ‘Tasks Ready’ endpoint is designed to provide you with a list of completed tasks that haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed tasks using this endpoint. Then, you can collect the results using the ‘Task GET’ endpoints."
      operationId: GoogleAppSearchesTasksReady
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AppDataGoogleAppSearchesTasksReadyResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/app_data/tasks_ready:
    get:
      tags:
        - AppData
      description: "‌\nThe ‘Tasks Ready’ endpoint is designed to provide you with a list of completed tasks that haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed tasks using this endpoint. Then, you can collect the results using the ‘Task GET’ endpoints."
      operationId: AppDataTasksReady
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AppDataTasksReadyResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  '/v3/app_data/google/app_searches/task_get/advanced/{id}':
    get:
      tags:
        - AppData
      description: 'This endpoint will provide you with a list of apps ranking on Google Play for the keyword specified in a POST request. You will also receive additional information about each application: its ID, icon, reviews count, rating, price, and other data. The results are specific to the keyword as well as location and language parameters specified in the POST request.'
      operationId: GoogleAppSearchesTaskGetAdvanced
      parameters:
        - name: id
          in: path
          description: <em>task identifier</em><br><strong>unique task identifier in our system in the <a href="https://en.wikipedia.org/wiki/Universally_unique_identifier">UUID</a> format</strong><br>you will be able to use it within <strong>30 days</strong> to request the results of the task at any time
          required: true
          schema:
            type: string
          example: 00000000-0000-0000-0000-000000000000
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AppDataGoogleAppSearchesTaskGetAdvancedResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  '/v3/app_data/google/app_searches/task_get/html/{id}':
    get:
      tags:
        - AppData
      description: 'Description of the fields for sending a request:'
      operationId: GoogleAppSearchesTaskGetHtml
      parameters:
        - name: id
          in: path
          description: <em>task identifier</em><br><strong>unique task identifier in our system in the <a href="https://en.wikipedia.org/wiki/Universally_unique_identifier">UUID</a> format</strong><br>you will be able to use it within <strong>7 days</strong> to request the results of the task at any time
          required: true
          schema:
            type: string
          example: 00000000-0000-0000-0000-000000000000
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AppDataGoogleAppSearchesTaskGetHtmlResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/app_data/google/app_list/task_post:
    post:
      tags:
        - AppData
      description: "‌‌\nThis endpoint will provide you with a list of mobile applications published in the top charts on the Google Play platform. The returned results are specific to the app collection as well as the the language and location parameters."
      operationId: GoogleAppListTaskPost
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AppDataGoogleAppListTaskPostRequestInfo'
                nullable: true
              example:
                - app_collection: topselling_free
                  location_code: 2840
                  language_code: en
                  depth: 100
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AppDataGoogleAppListTaskPostResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/app_data/google/app_list/tasks_ready:
    get:
      tags:
        - AppData
      description: "‌\nThe ‘Tasks Ready’ endpoint is designed to provide you with a list of completed tasks that haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed tasks using this endpoint. Then, you can collect the results using the ‘Task GET’ endpoints."
      operationId: GoogleAppListTasksReady
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AppDataGoogleAppListTasksReadyResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  '/v3/app_data/google/app_list/task_get/advanced/{id}':
    get:
      tags:
        - AppData
      description: 'This endpoint will provide you with a list of applications published in the top charts on the Google Play platform, including app IDs, ratings, prices, titles, and more. The results are specific to the app_collection as well as the location and language parameters specified in the POST request.'
      operationId: GoogleAppListTaskGetAdvanced
      parameters:
        - name: id
          in: path
          description: <em>task identifier</em><br><strong>unique task identifier in our system in the <a href="https://en.wikipedia.org/wiki/Universally_unique_identifier">UUID</a> format</strong><br>you will be able to use it within <strong>30 days</strong> to request the results of the task at any time
          required: true
          schema:
            type: string
          example: 00000000-0000-0000-0000-000000000000
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AppDataGoogleAppListTaskGetAdvancedResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  '/v3/app_data/google/app_list/task_get/html/{id}':
    get:
      tags:
        - AppData
      description: 'Description of the fields for sending a request:'
      operationId: GoogleAppListTaskGetHtml
      parameters:
        - name: id
          in: path
          description: <em>task identifier</em><br><strong>unique task identifier in our system in the <a href="https://en.wikipedia.org/wiki/Universally_unique_identifier">UUID</a> format</strong><br>you will be able to use it within <strong>7 days</strong> to request the results of the task at any time
          required: true
          schema:
            type: string
          example: 00000000-0000-0000-0000-000000000000
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AppDataGoogleAppListTaskGetHtmlResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/app_data/google/app_info/task_post:
    post:
      tags:
        - AppData
      description: "‌‌\nThis endpoint will provide you with information about the Google Play application specified in the app_id field of the POST request."
      operationId: GoogleAppInfoTaskPost
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AppDataGoogleAppInfoTaskPostRequestInfo'
                nullable: true
              example:
                - app_id: org.telegram.messenger
                  location_code: 2840
                  language_code: en
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AppDataGoogleAppInfoTaskPostResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/app_data/google/app_info/tasks_ready:
    get:
      tags:
        - AppData
      description: "‌\nThe ‘Tasks Ready’ endpoint is designed to provide you with a list of completed tasks that haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed tasks using this endpoint. Then, you can collect the results using the ‘Task GET’ endpoints."
      operationId: GoogleAppInfoTasksReady
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AppDataGoogleAppInfoTasksReadyResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  '/v3/app_data/google/app_info/task_get/advanced/{id}':
    get:
      tags:
        - AppData
      description: 'This endpoint will provide you with information about the mobile application specified in a POST request. You will receive its ID, icon, description, reviews count, rating, number of installs, images, and other data. The results are specific to the app_id parameter specified in the POST request.'
      operationId: GoogleAppInfoTaskGetAdvanced
      parameters:
        - name: id
          in: path
          description: <em>task identifier</em><br><strong>unique task identifier in our system in the <a href="https://en.wikipedia.org/wiki/Universally_unique_identifier">UUID</a> format</strong><br>you will be able to use it within <strong>30 days</strong> to request the results of the task at any time
          required: true
          schema:
            type: string
          example: 00000000-0000-0000-0000-000000000000
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AppDataGoogleAppInfoTaskGetAdvancedResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  '/v3/app_data/google/app_info/task_get/html/{id}':
    get:
      tags:
        - AppData
      description: 'Description of the fields for sending a request:'
      operationId: GoogleAppInfoTaskGetHtml
      parameters:
        - name: id
          in: path
          description: <em>task identifier</em><br><strong>unique task identifier in our system in the <a href="https://en.wikipedia.org/wiki/Universally_unique_identifier">UUID</a> format</strong><br>you will be able to use it within <strong>7 days</strong> to request the results of the task at any time
          required: true
          schema:
            type: string
          example: 00000000-0000-0000-0000-000000000000
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AppDataGoogleAppInfoTaskGetHtmlResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/app_data/google/app_reviews/task_post:
    post:
      tags:
        - AppData
      description: "‌‌\nThis endpoint will provide you with reviews published on the Google Play platform for the app specified in the app_id field. The returned results are specific to the indicated language and location parameters."
      operationId: GoogleAppReviewsTaskPost
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AppDataGoogleAppReviewsTaskPostRequestInfo'
                nullable: true
              example:
                - app_id: org.telegram.messenger
                  location_code: 2840
                  language_code: en
                  depth: 150
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AppDataGoogleAppReviewsTaskPostResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/app_data/google/app_reviews/tasks_ready:
    get:
      tags:
        - AppData
      description: "‌\nThe ‘Tasks Ready’ endpoint is designed to provide you with a list of completed tasks that haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed tasks using this endpoint. Then, you can collect the results using the ‘Task GET’ endpoints."
      operationId: GoogleAppReviewsTasksReady
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AppDataGoogleAppReviewsTasksReadyResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  '/v3/app_data/google/app_reviews/task_get/advanced/{id}':
    get:
      tags:
        - AppData
      description: 'This endpoint will provide you with feedback data on applications listed on the Google Play platform, including review ratings, review content, user profile info of each reviewer, review publication dates, and more. The results are specific to the app_id as well as the location and language parameters specified in the POST request.'
      operationId: GoogleAppReviewsTaskGetAdvanced
      parameters:
        - name: id
          in: path
          description: <em>task identifier</em><br><strong>unique task identifier in our system in the <a href="https://en.wikipedia.org/wiki/Universally_unique_identifier">UUID</a> format</strong><br>you will be able to use it within <strong>30 days</strong> to request the results of the task at any time
          required: true
          schema:
            type: string
          example: 00000000-0000-0000-0000-000000000000
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AppDataGoogleAppReviewsTaskGetAdvancedResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  '/v3/app_data/google/app_reviews/task_get/html/{id}':
    get:
      tags:
        - AppData
      description: 'Description of the fields for sending a request:'
      operationId: GoogleAppReviewsTaskGetHtml
      parameters:
        - name: id
          in: path
          description: <em>task identifier</em><br><strong>unique task identifier in our system in the <a href="https://en.wikipedia.org/wiki/Universally_unique_identifier">UUID</a> format</strong><br>you will be able to use it within <strong>7 days</strong> to request the results of the task at any time
          required: true
          schema:
            type: string
          example: 00000000-0000-0000-0000-000000000000
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AppDataGoogleAppReviewsTaskGetHtmlResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/app_data/google/app_listings/categories:
    get:
      tags:
        - AppData
      description: This endpoint will provide you with a full list of app categories available on Google Play.
      operationId: GoogleAppListingsCategories
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AppDataGoogleAppListingsCategoriesResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/app_data/google/app_listings/search/live:
    post:
      tags:
        - AppData
      description: 'This endpoint will provide you with a list of apps published on Google Play along with additional information: its ID, icon, reviews count, rating, price, and other data. The results are specific to the title, description, and categories parameters specified in the API request.'
      operationId: GoogleAppListingsSearchLive
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AppDataGoogleAppListingsSearchLiveRequestInfo'
                nullable: true
              example:
                - title: vpn
                  description: vpn
                  categories:
                    - Tools
                  order_by:
                    - 'item.installs_count,asc'
                  filters:
                    - 
                      - item.rating.value
                      - '>'
                      - 4.5
                  limit: 10
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AppDataGoogleAppListingsSearchLiveResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/app_data/apple/categories:
    get:
      tags:
        - AppData
      description: This endpoint will provide you with a full list of app categories available on App Store.
      operationId: AppleCategories
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AppDataAppleCategoriesResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/app_data/apple/locations:
    get:
      tags:
        - AppData
      description: "By calling this endpoint you will receive the list of Apple locations supported in App Data API.\nfor more info please visit 'https://docs.dataforseo.com/v3/app_data/apple/locations/?bash'"
      operationId: AppleLocations
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AppDataAppleLocationsResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/app_data/apple/languages:
    get:
      tags:
        - AppData
      description: By calling this endpoint you will receive the list of Apple languages supported in App Data API.
      operationId: AppleLanguages
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AppDataAppleLanguagesResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/app_data/apple/app_searches/task_post:
    post:
      tags:
        - AppData
      description: "‌‌\nThis endpoint will provide you with a list of apps ranking on the App Store for the specified keyword. The returned results are specific to the indicated keyword, as well as the location and language parameters."
      operationId: AppleAppSearchesTaskPost
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AppDataAppleAppSearchesTaskPostRequestInfo'
                nullable: true
              example:
                - keyword: vpn
                  location_code: 2840
                  language_code: en
                  depth: 200
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AppDataAppleAppSearchesTaskPostResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/app_data/apple/app_searches/tasks_ready:
    get:
      tags:
        - AppData
      description: "‌\nThe ‘Tasks Ready’ endpoint is designed to provide you with a list of completed tasks that haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed tasks using this endpoint. Then, you can collect the results using the ‘Task GET’ endpoints."
      operationId: AppleAppSearchesTasksReady
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AppDataAppleAppSearchesTasksReadyResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  '/v3/app_data/apple/app_searches/task_get/advanced/{id}':
    get:
      tags:
        - AppData
      description: 'This endpoint will provide you with a list of apps ranking on the App Store for the keyword specified in a POST request. You will also receive additional information about each application: its ID, icon, reviews count, rating, price, and other data. The results are specific to the keyword as well as location and language parameters specified in the POST request.'
      operationId: AppleAppSearchesTaskGetAdvanced
      parameters:
        - name: id
          in: path
          description: <em>task identifier</em><br><strong>unique task identifier in our system in the <a href="https://en.wikipedia.org/wiki/Universally_unique_identifier">UUID</a> format</strong><br>you will be able to use it within <strong>30 days</strong> to request the results of the task at any time
          required: true
          schema:
            type: string
          example: 00000000-0000-0000-0000-000000000000
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AppDataAppleAppSearchesTaskGetAdvancedResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/app_data/apple/app_info/task_post:
    post:
      tags:
        - AppData
      description: "‌‌\nThis endpoint will provide you with information about the App Store application specified in the app_id field of the POST request."
      operationId: AppleAppInfoTaskPost
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AppDataAppleAppInfoTaskPostRequestInfo'
                nullable: true
              example:
                - app_id: '835599320'
                  location_code: 2840
                  language_code: en
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AppDataAppleAppInfoTaskPostResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/app_data/apple/app_info/tasks_ready:
    get:
      tags:
        - AppData
      description: "‌\nThe ‘Tasks Ready’ endpoint is designed to provide you with a list of completed tasks that haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed tasks using this endpoint. Then, you can collect the results using the ‘Task GET’ endpoints."
      operationId: AppleAppInfoTasksReady
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AppDataAppleAppInfoTasksReadyResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  '/v3/app_data/apple/app_info/task_get/advanced/{id}':
    get:
      tags:
        - AppData
      description: 'This endpoint will provide you with information about the mobile application specified in a POST request. You will receive its ID, icon, description, reviews count, rating, images, and other data. The results are specific to the app_id parameter specified in the POST request.'
      operationId: AppleAppInfoTaskGetAdvanced
      parameters:
        - name: id
          in: path
          description: <em>task identifier</em><br><strong>unique task identifier in our system in the <a href="https://en.wikipedia.org/wiki/Universally_unique_identifier">UUID</a> format</strong><br>you will be able to use it within <strong>30 days</strong> to request the results of the task at any time
          required: true
          schema:
            type: string
          example: 00000000-0000-0000-0000-000000000000
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AppDataAppleAppInfoTaskGetAdvancedResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/app_data/apple/app_list/task_post:
    post:
      tags:
        - AppData
      description: "This endpoint will provide you with a list of mobile applications published in the top app charts on the App Store platform. The returned results are specific to the app collection as well as the language and location parameters.\nfor more info please visit 'https://docs.dataforseo.com/v3/app_data/apple/app_list/task_post/?bash'"
      operationId: AppleAppListTaskPost
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AppDataAppleAppListTaskPostRequestInfo'
                nullable: true
              example:
                - app_collection: top_free_ios
                  location_code: 2840
                  language_code: en
                  app_category: games
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AppDataAppleAppListTaskPostResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/app_data/apple/app_list/tasks_ready:
    get:
      tags:
        - AppData
      description: "‌\nThe ‘Tasks Ready’ endpoint is designed to provide you with a list of completed tasks that haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed tasks using this endpoint. Then, you can collect the results using the ‘Task GET’ endpoints."
      operationId: AppleAppListTasksReady
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AppDataAppleAppListTasksReadyResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  '/v3/app_data/apple/app_list/task_get/advanced/{id}':
    get:
      tags:
        - AppData
      description: 'This endpoint will provide you with a list of applications published in the top app charts on the App Store platform, including app IDs, ratings, prices, titles, and more. The results are specific to the app_collection as well as the location and language parameters specified in the POST request.'
      operationId: AppleAppListTaskGetAdvanced
      parameters:
        - name: id
          in: path
          description: <em>task identifier</em><br><strong>unique task identifier in our system in the <a href="https://en.wikipedia.org/wiki/Universally_unique_identifier">UUID</a> format</strong><br>you will be able to use it within <strong>30 days</strong> to request the results of the task at any time
          required: true
          schema:
            type: string
          example: 00000000-0000-0000-0000-000000000000
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AppDataAppleAppListTaskGetAdvancedResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/app_data/apple/app_reviews/task_post:
    post:
      tags:
        - AppData
      description: "‌‌\nThis endpoint will provide you with reviews published on the App Store platform for the app specified in the app_id field. The returned results are specific to the indicated language and location parameters."
      operationId: AppleAppReviewsTaskPost
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AppDataAppleAppReviewsTaskPostRequestInfo'
                nullable: true
              example:
                - app_id: '835599320'
                  location_code: 2840
                  language_code: en
                  depth: 200
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AppDataAppleAppReviewsTaskPostResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/app_data/apple/app_reviews/tasks_ready:
    get:
      tags:
        - AppData
      description: "‌\nThe ‘Tasks Ready’ endpoint is designed to provide you with a list of completed tasks that haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed tasks using this endpoint. Then, you can collect the results using the ‘Task GET’ endpoints."
      operationId: AppleAppReviewsTasksReady
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AppDataAppleAppReviewsTasksReadyResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  '/v3/app_data/apple/app_reviews/task_get/advanced/{id}':
    get:
      tags:
        - AppData
      description: 'This endpoint will provide you with feedback data on applications listed on the App Store platform, including review ratings, review content, user profile info of each reviewer, review publication dates, and more. The results are specific to the app_id as well as the location and language parameters specified in the POST request.'
      operationId: AppleAppReviewsTaskGetAdvanced
      parameters:
        - name: id
          in: path
          description: <em>task identifier</em><br><strong>unique task identifier in our system in the <a href="https://en.wikipedia.org/wiki/Universally_unique_identifier">UUID</a> format</strong><br>you will be able to use it within <strong>30 days</strong> to request the results of the task at any time
          required: true
          schema:
            type: string
          example: 00000000-0000-0000-0000-000000000000
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AppDataAppleAppReviewsTaskGetAdvancedResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/app_data/apple/app_listings/categories:
    get:
      tags:
        - AppData
      description: This endpoint will provide you with a full list of app categories available on Apple App Store.
      operationId: AppleAppListingsCategories
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AppDataAppleAppListingsCategoriesResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/app_data/apple/app_listings/search/live:
    post:
      tags:
        - AppData
      description: 'This endpoint will provide you with a list of apps published on App Store along with additional information: its ID, icon, reviews count, rating, price, and other data. The results are specific to the title, description, and categories parameters specified in the API request.'
      operationId: AppleAppListingsSearchLive
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AppDataAppleAppListingsSearchLiveRequestInfo'
                nullable: true
              example:
                - title: vpn
                  description: vpn
                  categories:
                    - Utilities
                  order_by:
                    - 'item.rating.value,desc'
                  filters:
                    - 
                      - item.rating.value
                      - '>'
                      - 4.5
                  limit: 10
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AppDataAppleAppListingsSearchLiveResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/business_data/id_list:
    post:
      tags:
        - BusinessData
      description: 'This endpoint is designed to provide you with a list of IDs and metadata for all Business Data tasks created within the specified time period, including both successful and uncompleted tasks.'
      operationId: BusinessDataIdList
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/BusinessDataIdListRequestInfo'
                nullable: true
              example:
                - datetime_from: '2026-09-10 11:12:35'
                  datetime_to: '2026-09-20 11:12:35'
                  limit: 10
                  include_metadata: true
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/BusinessDataIdListResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/business_data/errors:
    post:
      tags:
        - BusinessData
      description: By calling this endpoint you will receive information about the Business Data API tasks that returned an error within the past 7 days.
      operationId: BusinessDataErrors
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/BusinessDataErrorsRequestInfo'
                nullable: true
              example:
                - limit: 10
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/BusinessDataErrorsResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/business_data/business_listings/locations:
    get:
      tags:
        - BusinessData
      description: You will receive the list of locations by this API call. You can also download the full list of supported locations in the CSV format (last updated 2026-09-01).
      operationId: BusinessListingsLocations
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/BusinessDataBusinessListingsLocationsResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/business_data/business_listings/categories:
    get:
      tags:
        - BusinessData
      description: This endpoint will provide you with the list of top categories by business count.
      operationId: BusinessListingsCategories
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/BusinessDataBusinessListingsCategoriesResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/business_data/business_listings/available_filters:
    get:
      tags:
        - BusinessData
      description: "‌‌\nHere you will find all the necessary information about filters that can be used with Business Listings API."
      operationId: BusinessListingsAvailableFilters
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/BusinessDataBusinessListingsAvailableFiltersResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/business_data/business_listings/search/live:
    post:
      tags:
        - BusinessData
      description: "‌‌\nBusiness Listings Search API provides results containing information about business entities listed on Google Maps in the specified categories. You will receive the address, contacts, rating, working hours, and other relevant data. The provided results are specific to the selected location (see the List of Locations) settings."
      operationId: BusinessListingsSearchLive
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/BusinessDataBusinessListingsSearchLiveRequestInfo'
                nullable: true
              example:
                - categories:
                    - pizza_restaurant
                  description: pizza
                  title: pizza
                  is_claimed: true
                  location_coordinate: '53.476225,-2.243572,10'
                  order_by:
                    - 'rating.value,desc'
                  filters:
                    - 
                      - rating.value
                      - '>'
                      - 3
                  limit: 3
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/BusinessDataBusinessListingsSearchLiveResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/business_data/business_listings/categories_aggregation/live:
    post:
      tags:
        - BusinessData
      description: "‌‌\nBusiness Listings Categories Aggregation endpoint provides results containing information about groups of related categories along with the number of entities in each category. The provided results are specific to the specified parameters."
      operationId: BusinessListingsCategoriesAggregationLive
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/BusinessDataBusinessListingsCategoriesAggregationLiveRequestInfo'
                nullable: true
              example:
                - categories:
                    - pizza_restaurant
                  description: pizza
                  title: pizza
                  is_claimed: true
                  location_coordinate: '53.476225,-2.243572,10'
                  initial_dataset_filters:
                    - 
                      - rating.value
                      - '>'
                      - 3
                  limit: 3
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/BusinessDataBusinessListingsCategoriesAggregationLiveResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/business_data/google/locations:
    get:
      tags:
        - BusinessData
      description: You will receive the list of locations by this API call. You can filter the list of locations by country when setting a task.
      operationId: BusinessDataGoogleLocations
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/BusinessDataGoogleLocationsResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  '/v3/business_data/google/locations/{country}':
    get:
      tags:
        - BusinessData
      description: You will receive the list of locations by this API call. You can filter the list of locations by country when setting a task.
      operationId: BusinessDataGoogleLocationsCountry
      parameters:
        - name: country
          in: path
          description: <em>country ISO code</em><br>optional field<br>specify the ISO code if you want to filter the list of locations by country<br>example:<br><code>us</code>
          required: true
          schema:
            type: string
          example: us
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/BusinessDataGoogleLocationsCountryResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/business_data/google/languages:
    get:
      tags:
        - BusinessData
      description: You will receive the list of languages by calling this API.
      operationId: BusinessDataGoogleLanguages
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/BusinessDataGoogleLanguagesResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/business_data/google/my_business_info/task_post:
    post:
      tags:
        - BusinessData
      description: "‌‌\nBusiness Data API provides results containing information about specific business entity from Google. The provided results are specific to the selected location (see the List of Locations) and language (see the List of Languages) settings."
      operationId: GoogleMyBusinessInfoTaskPost
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/BusinessDataGoogleMyBusinessInfoTaskPostRequestInfo'
                nullable: true
              example:
                - language_code: en
                  location_name: 'New York,New York,United States'
                  keyword: 'RustyBrick, Inc.'
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/BusinessDataGoogleMyBusinessInfoTaskPostResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/business_data/google/my_business_info/tasks_ready:
    get:
      tags:
        - BusinessData
      description: "‌\nThe ‘Tasks Ready’ endpoint is designed to provide you with the list of completed tasks, which haven’t been collected yet. If you don’t use the postback_url, you can receive the list of id for all completed tasks using this endpoint. Then, you can collect the results using the ‘Task GET’ endpoint."
      operationId: GoogleMyBusinessInfoTasksReady
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/BusinessDataGoogleMyBusinessInfoTasksReadyResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/business_data/tasks_ready:
    get:
      tags:
        - BusinessData
      description: "‌\nThe ‘Tasks Ready’ endpoint is designed to provide you with the list of completed tasks, which haven’t been collected yet. If you don’t use the postback_url, you can receive the list of id for all completed tasks using this endpoint. Then, you can collect the results using the ‘Task GET’ endpoint."
      operationId: BusinessDataTasksReady
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/BusinessDataTasksReadyResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  '/v3/business_data/google/my_business_info/task_get/{id}':
    get:
      tags:
        - BusinessData
      description: ''
      operationId: GoogleMyBusinessInfoTaskGet
      parameters:
        - name: id
          in: path
          description: <em>task identifier</em><br><strong>unique task identifier in our system in the <a href="https://en.wikipedia.org/wiki/Universally_unique_identifier">UUID</a> format</strong><br>you will be able to use it within <strong>30 days</strong> to request the results of the task at any time
          required: true
          schema:
            type: string
          example: 00000000-0000-0000-0000-000000000000
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/BusinessDataGoogleMyBusinessInfoTaskGetResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/business_data/google/my_business_info/live:
    post:
      tags:
        - BusinessData
      description: "‌‌\nBusiness Data API provides results containing information about specific business entity from Google. The provided results are specific to the selected location (see the List of Locations) and language (see the List of Languages) settings."
      operationId: GoogleMyBusinessInfoLive
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/BusinessDataGoogleMyBusinessInfoLiveRequestInfo'
                nullable: true
              example:
                - language_code: en
                  location_name: 'New York,New York,United States'
                  keyword: 'RustyBrick, Inc.'
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/BusinessDataGoogleMyBusinessInfoLiveResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/business_data/google/my_business_updates/task_post:
    post:
      tags:
        - BusinessData
      description: "‌‌\nThis endpoints provides the latest updates of a specific business entity from Google SERP. The provided results are specific to the selected location (see the List of Locations) and language (see the List of Languages) settings."
      operationId: GoogleMyBusinessUpdatesTaskPost
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/BusinessDataGoogleMyBusinessUpdatesTaskPostRequestInfo'
                nullable: true
              example:
                - language_code: en
                  location_name: 'New York,New York,United States'
                  keyword: 'RustyBrick, Inc.'
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/BusinessDataGoogleMyBusinessUpdatesTaskPostResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/business_data/google/my_business_updates/tasks_ready:
    get:
      tags:
        - BusinessData
      description: "‌\nThe ‘Tasks Ready’ endpoint is designed to provide you with the list of completed tasks, which haven’t been collected yet. If you don’t use the postback_url, you can receive the list of id for all completed tasks using this endpoint. Then, you can collect the results using the ‘Task GET’ endpoint."
      operationId: GoogleMyBusinessUpdatesTasksReady
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/BusinessDataGoogleMyBusinessUpdatesTasksReadyResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  '/v3/business_data/google/my_business_updates/task_get/{id}':
    get:
      tags:
        - BusinessData
      description: ''
      operationId: GoogleMyBusinessUpdatesTaskGet
      parameters:
        - name: id
          in: path
          description: <em>task identifier</em><br><strong>unique task identifier in our system in the <a href="https://en.wikipedia.org/wiki/Universally_unique_identifier">UUID</a> format</strong><br>you will be able to use it within <strong>30 days</strong> to request the results of the task at any time
          required: true
          schema:
            type: string
          example: 00000000-0000-0000-0000-000000000000
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/BusinessDataGoogleMyBusinessUpdatesTaskGetResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/business_data/google/hotel_searches/task_post:
    post:
      tags:
        - BusinessData
      description: "‌‌\nHotel Searches API provides results containing information about different hotels listed on Google. The provided results are specific to the keyword, selected location (see the List of Locations) and language (see the List of Languages) settings."
      operationId: GoogleHotelSearchesTaskPost
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/BusinessDataGoogleHotelSearchesTaskPostRequestInfo'
                nullable: true
              example:
                - language_code: en
                  location_name: 'New York,New York,United States'
                  keyword: cheap hotel
                  check_in: '2023-06-01'
                  check_out: '2023-06-30'
                  currency: USD
                  adults: 2
                  children:
                    - '14'
                  sort_by: highest_rating
                  priority: 2
                  tag: example
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/BusinessDataGoogleHotelSearchesTaskPostResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/business_data/google/hotel_searches/tasks_ready:
    get:
      tags:
        - BusinessData
      description: "‌\nThe ‘Tasks Ready’ endpoint is designed to provide you with the list of completed tasks, which haven’t been collected yet. If you don’t use the postback_url, you can receive the list of id for all completed tasks using this endpoint. Then, you can collect the results using the ‘Task GET’ endpoint."
      operationId: GoogleHotelSearchesTasksReady
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/BusinessDataGoogleHotelSearchesTasksReadyResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  '/v3/business_data/google/hotel_searches/task_get/{id}':
    get:
      tags:
        - BusinessData
      description: ''
      operationId: GoogleHotelSearchesTaskGet
      parameters:
        - name: id
          in: path
          description: <em>task identifier</em><br><strong>unique task identifier in our system in the <a href="https://en.wikipedia.org/wiki/Universally_unique_identifier">UUID</a> format</strong><br>you will be able to use it within <strong>30 days</strong> to request the results of the task at any time
          required: true
          schema:
            type: string
          example: 00000000-0000-0000-0000-000000000000
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/BusinessDataGoogleHotelSearchesTaskGetResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/business_data/google/hotel_searches/live:
    post:
      tags:
        - BusinessData
      description: "‌‌\nHotel Searches API provides results containing information about different hotels listed on Google Hotels. The provided results are specific to the selected location (see the List of Locations) and language (see the List of Languages) settings."
      operationId: GoogleHotelSearchesLive
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/BusinessDataGoogleHotelSearchesLiveRequestInfo'
                nullable: true
              example:
                - language_code: en
                  location_name: 'New York,New York,United States'
                  keyword: cheap hotel
                  check_in: '2023-06-01'
                  check_out: '2023-06-30'
                  currency: USD
                  adults: 2
                  children:
                    - '14'
                  sort_by: highest_rating
                  priority: 2
                  tag: example
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/BusinessDataGoogleHotelSearchesLiveResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/business_data/google/hotel_info/task_post:
    post:
      tags:
        - BusinessData
      description: "‌‌\nGoogle Hotel Info will provide you with structured data available for a specific hotel entity on the Google Hotels platform: such as service description, location details, rating, amenities, reviews, images, prices, and more."
      operationId: GoogleHotelInfoTaskPost
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/BusinessDataGoogleHotelInfoTaskPostRequestInfo'
                nullable: true
              example:
                - language_code: en
                  location_name: 'New York,New York,United States'
                  hotel_identifier: ChYIq6SB--i6p6cpGgovbS8wN2s5ODZfEAE
                  tag: some_string_123
                  postback_url: https://your-server.com/postbackscript.php
                  postback_data: advanced
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/BusinessDataGoogleHotelInfoTaskPostResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/business_data/google/hotel_info/tasks_ready:
    get:
      tags:
        - BusinessData
      description: "‌\nThe ‘Tasks Ready’ endpoint is designed to provide you with the list of completed tasks, which haven’t been collected yet. If you don’t use the postback_url, you can receive the list of id for all completed tasks using this endpoint. Then, you can collect the results using the ‘Task GET’ endpoint."
      operationId: GoogleHotelInfoTasksReady
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/BusinessDataGoogleHotelInfoTasksReadyResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  '/v3/business_data/google/hotel_info/task_get/advanced/{id}':
    get:
      tags:
        - BusinessData
      description: ''
      operationId: GoogleHotelInfoTaskGetAdvanced
      parameters:
        - name: id
          in: path
          description: <em>task identifier</em><br><strong>unique task identifier in our system in the <a href="https://en.wikipedia.org/wiki/Universally_unique_identifier">UUID</a> format</strong><br>you will be able to use it within <strong>30 days</strong> to request the results of the task at any time
          required: true
          schema:
            type: string
          example: 00000000-0000-0000-0000-000000000000
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/BusinessDataGoogleHotelInfoTaskGetAdvancedResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  '/v3/business_data/google/hotel_info/task_get/html/{id}':
    get:
      tags:
        - BusinessData
      description: ''
      operationId: GoogleHotelInfoTaskGetHtml
      parameters:
        - name: id
          in: path
          description: <em>task identifier</em><br><strong>unique task identifier in our system in the <a href="https://en.wikipedia.org/wiki/Universally_unique_identifier">UUID</a> format</strong><br>you will be able to use it within <strong>7 days</strong> to request the results of the task at any time
          required: true
          schema:
            type: string
          example: 00000000-0000-0000-0000-000000000000
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/BusinessDataGoogleHotelInfoTaskGetHtmlResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/business_data/google/hotel_info/live/advanced:
    post:
      tags:
        - BusinessData
      description: "‌‌\nGoogle Hotel Info will provide you with structured data available for a specific hotel entity on the Google Hotels platform: such as service description, location details, rating, amenities, reviews, images, prices, and more."
      operationId: GoogleHotelInfoLiveAdvanced
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/BusinessDataGoogleHotelInfoLiveAdvancedRequestInfo'
                nullable: true
              example:
                - language_code: en
                  location_name: 'New York,New York,United States'
                  hotel_identifier: CgoI-KWyzenM_MV3EAE
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/BusinessDataGoogleHotelInfoLiveAdvancedResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/business_data/google/hotel_info/live/html:
    post:
      tags:
        - BusinessData
      description: "‌‌\nGoogle Hotel Info will provide you with unstructured HTML data available for a specific hotel entity on the Google Hotels platform: such as service description, location details, rating, amenities, reviews, images, prices, and more."
      operationId: GoogleHotelInfoLiveHtml
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/BusinessDataGoogleHotelInfoLiveHtmlRequestInfo'
                nullable: true
              example:
                - language_code: en
                  location_name: 'New York,New York,United States'
                  hotel_identifier: ChYIq6SB--i6p6cpGgovbS8wN2s5ODZfEAE
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/BusinessDataGoogleHotelInfoLiveHtmlResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/business_data/google/reviews/task_post:
    post:
      tags:
        - BusinessData
      description: "‌‌\nThis endpoint provides results from the “Reviews” element of Google SERPs. The results are specific to the selected location (see the List of Locations) and language (see the List of Languages) parameters."
      operationId: GoogleReviewsTaskPost
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/BusinessDataGoogleReviewsTaskPostRequestInfo'
                nullable: true
              example:
                - location_name: 'London,England,United Kingdom'
                  language_name: English
                  keyword: hedonism wines
                  depth: 50
                  sort_by: highest_rating
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/BusinessDataGoogleReviewsTaskPostResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/business_data/google/reviews/tasks_ready:
    get:
      tags:
        - BusinessData
      description: "‌\nThe ‘Tasks Ready’ endpoint is designed to provide you with the list of completed tasks, which haven’t been collected yet. If you don’t use the postback_url, you can receive the list of id for all completed tasks using this endpoint. Then, you can collect the results using the ‘Task GET’ endpoint."
      operationId: GoogleReviewsTasksReady
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/BusinessDataGoogleReviewsTasksReadyResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  '/v3/business_data/google/reviews/task_get/{id}':
    get:
      tags:
        - BusinessData
      description: 'The returned results are specific to the indicated local establishment name, search engine, location and language parameters. We emulate set location and search engine with the highest accuracy so that the results you receive will match the actual search results for the specified parameters at the time of task setting. You can always check the returned results accessing the check_url in the Incognito mode to make sure the received data is entirely relevant. Note that user preferences, search history, and other personalized search factors are ignored by our system and thus would not be reflected in the returned results.'
      operationId: GoogleReviewsTaskGet
      parameters:
        - name: id
          in: path
          description: <em>task identifier</em><br><strong>unique task identifier in our system in the <a href="https://en.wikipedia.org/wiki/Universally_unique_identifier">UUID</a> format</strong><br>you will be able to use it within <strong>30 days</strong> to request the results of the task at any time
          required: true
          schema:
            type: string
          example: 00000000-0000-0000-0000-000000000000
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/BusinessDataGoogleReviewsTaskGetResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/business_data/google/extended_reviews/task_post:
    post:
      tags:
        - BusinessData
      description: "‌‌\nThis endpoint provides results from the “Reviews” element of Google SERPs, including not only Google user reviews but also reviews from other reputable sources (e.g., TripAdvisor, Yelp, Trustpilot). The results are specific to the selected location (see the List of Locations) and language (see the List of Languages) parameters."
      operationId: GoogleExtendedReviewsTaskPost
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/BusinessDataGoogleExtendedReviewsTaskPostRequestInfo'
                nullable: true
              example:
                - location_name: 'London,England,United Kingdom'
                  language_name: english
                  cid: '17626775537598922320'
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/BusinessDataGoogleExtendedReviewsTaskPostResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/business_data/google/extended_reviews/tasks_ready:
    get:
      tags:
        - BusinessData
      description: "‌\nThe ‘Tasks Ready’ endpoint is designed to provide you with the list of completed tasks, which haven’t been collected yet. If you don’t use the postback_url, you can receive the list of id for all completed tasks using this endpoint. Then, you can collect the results using the ‘Task GET’ endpoint."
      operationId: GoogleExtendedReviewsTasksReady
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/BusinessDataGoogleExtendedReviewsTasksReadyResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  '/v3/business_data/google/extended_reviews/task_get/{id}':
    get:
      tags:
        - BusinessData
      description: 'The returned results are specific to the indicated local establishment name, search engine, location and language parameters. We emulate set location and search engine with the highest accuracy so that the results you receive will match the actual search results for the specified parameters at the time of task setting. You can always check the returned results accessing the check_url in the Incognito mode to make sure the received data is entirely relevant. Note that user preferences, search history, and other personalized search factors are ignored by our system and thus would not be reflected in the returned results.'
      operationId: GoogleExtendedReviewsTaskGet
      parameters:
        - name: id
          in: path
          description: <em>task identifier</em><br><strong>unique task identifier in our system in the <a href="https://en.wikipedia.org/wiki/Universally_unique_identifier">UUID</a> format</strong><br>you will be able to use it within <strong>30 days</strong> to request the results of the task at any time
          required: true
          schema:
            type: string
          example: 00000000-0000-0000-0000-000000000000
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/BusinessDataGoogleExtendedReviewsTaskGetResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/business_data/google/questions_and_answers/task_post:
    post:
      tags:
        - BusinessData
      description: "‌‌\nThis endpoint will provide you with a detailed overview of questions and answers associated with a specific business entity listed on Google My Business. By submitting a request to this endpoint, you can access comprehensive data on the inquiries and responses related to a particular business, including the full text of the questions and answers, as well as metadata such as timestamps, user information.\n \nThe provided results are specific to the selected location (see the List of Locations) and language (see the List of Languages) settings.\n \nYour account will be billed for every 20 questions, the maximum number of answers returned for each question is 5."
      operationId: GoogleQuestionsAndAnswersTaskPost
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/BusinessDataGoogleQuestionsAndAnswersTaskPostRequestInfo'
                nullable: true
              example:
                - language_code: en
                  location_name: 'Los Angeles,California,United States'
                  keyword: The Last Bookstore
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/BusinessDataGoogleQuestionsAndAnswersTaskPostResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/business_data/google/questions_and_answers/tasks_ready:
    get:
      tags:
        - BusinessData
      description: "‌\nThe ‘Tasks Ready’ endpoint is designed to provide you with the list of completed tasks, which haven’t been collected yet. If you don’t use the postback_url, you can receive the list of id for all completed tasks using this endpoint. Then, you can collect the results using the ‘Task GET’ endpoint."
      operationId: GoogleQuestionsAndAnswersTasksReady
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/BusinessDataGoogleQuestionsAndAnswersTasksReadyResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  '/v3/business_data/google/questions_and_answers/task_get/{id}':
    get:
      tags:
        - BusinessData
      description: ''
      operationId: GoogleQuestionsAndAnswersTaskGet
      parameters:
        - name: id
          in: path
          description: <em>task identifier</em><br><strong>unique task identifier in our system in the <a href="https://en.wikipedia.org/wiki/Universally_unique_identifier">UUID</a> format</strong><br>you will be able to use it within <strong>30 days</strong> to request the results of the task at any time
          required: true
          schema:
            type: string
          example: 00000000-0000-0000-0000-000000000000
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/BusinessDataGoogleQuestionsAndAnswersTaskGetResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/business_data/google/questions_and_answers/live:
    post:
      tags:
        - BusinessData
      description: "‌‌\nThis endpoint will provide you with a detailed overview of questions and answers associated with a specific business entity listed on Google My Business. By submitting a request to this endpoint, you can access comprehensive data on the inquiries and responses related to a particular business, including the full text of the questions and answers, as well as metadata such as timestamps, user information.\n \nThe provided results are specific to the selected location (see the List of Locations) and language (see the List of Languages) settings.\n \nYour account will be billed for every 20 questions, the maximum number of answers returned for each question is 5."
      operationId: GoogleQuestionsAndAnswersLive
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/BusinessDataGoogleQuestionsAndAnswersLiveRequestInfo'
                nullable: true
              example:
                - language_code: en
                  location_name: 'Los Angeles,California,United States'
                  keyword: The Last Bookstore
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/BusinessDataGoogleQuestionsAndAnswersLiveResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/business_data/trustpilot/search/task_post:
    post:
      tags:
        - BusinessData
      description: "‌‌\nThis endpoint provides a list of business profiles listed on the Trustpilot platform. The returned results are relevant to the specified keyword."
      operationId: TrustpilotSearchTaskPost
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/BusinessDataTrustpilotSearchTaskPostRequestInfo'
                nullable: true
              example:
                - keyword: pizza restaurant
                  depth: 20
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/BusinessDataTrustpilotSearchTaskPostResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/business_data/trustpilot/search/tasks_ready:
    get:
      tags:
        - BusinessData
      description: "‌\nThe ‘Tasks Ready’ endpoint is designed to provide you with the list of completed tasks, which haven’t been collected yet. If you don’t use the postback_url, you can receive the list of id for all completed tasks using this endpoint. Then, you can collect the results using the ‘Task GET’ endpoint."
      operationId: TrustpilotSearchTasksReady
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/BusinessDataTrustpilotSearchTasksReadyResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  '/v3/business_data/trustpilot/search/task_get/{id}':
    get:
      tags:
        - BusinessData
      description: 'This endpoint provides a list of business profiles listed on the Trustpilot platform. The returned results are relevant to the keyword specified in a POST request. We emulate set parameters with the highest accuracy so that the results you receive match the actual search results for the specified parameters at the time of task setting. You can always check the returned results accessing the check_url in the Incognito mode to make sure the received data is entirely relevant. Note that user preferences, search history, and other personalized search factors are ignored by our system and thus will not be reflected in the returned results.'
      operationId: TrustpilotSearchTaskGet
      parameters:
        - name: id
          in: path
          description: <em>task identifier</em><br><strong>unique task identifier in our system in the <a href="https://en.wikipedia.org/wiki/Universally_unique_identifier">UUID</a> format</strong><br>you will be able to use it within <strong>30 days</strong> to request the results of the task at any time
          required: true
          schema:
            type: string
          example: 00000000-0000-0000-0000-000000000000
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/BusinessDataTrustpilotSearchTaskGetResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/business_data/trustpilot/reviews/task_post:
    post:
      tags:
        - BusinessData
      description: "‌‌\nThis endpoint provides reviews published on the Trustpilot platform for the local establishment specified in the domain field."
      operationId: TrustpilotReviewsTaskPost
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/BusinessDataTrustpilotReviewsTaskPostRequestInfo'
                nullable: true
              example:
                - domain: www.thepearlsource.com
                  depth: 40
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/BusinessDataTrustpilotReviewsTaskPostResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/business_data/trustpilot/reviews/tasks_ready:
    get:
      tags:
        - BusinessData
      description: "‌\nThe ‘Tasks Ready’ endpoint is designed to provide you with the list of completed tasks, which haven’t been collected yet. If you don’t use the postback_url, you can receive the list of id for all completed tasks using this endpoint. Then, you can collect the results using the ‘Task GET’ endpoint."
      operationId: TrustpilotReviewsTasksReady
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/BusinessDataTrustpilotReviewsTasksReadyResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  '/v3/business_data/trustpilot/reviews/task_get/{id}':
    get:
      tags:
        - BusinessData
      description: 'This endpoint provides reviews published on the Trustpilot platform The returned results are specific to the indicated business entity. We emulate set parameters with the highest accuracy so that the results you receive will match the actual search results for the specified parameters at the time of task setting. You can always check the returned results accessing the check_url in the Incognito mode to make sure the received data is entirely relevant. Note that user preferences, search history, and other personalized search factors are ignored by our system and thus would not be reflected in the returned results.'
      operationId: TrustpilotReviewsTaskGet
      parameters:
        - name: id
          in: path
          description: <em>task identifier</em><br><strong>unique task identifier in our system in the <a href="https://en.wikipedia.org/wiki/Universally_unique_identifier">UUID</a> format</strong><br>you will be able to use it within <strong>30 days</strong> to request the results of the task at any time
          required: true
          schema:
            type: string
          example: 00000000-0000-0000-0000-000000000000
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/BusinessDataTrustpilotReviewsTaskGetResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/business_data/tripadvisor/locations:
    get:
      tags:
        - BusinessData
      description: You will receive the list of locations by this API call. You can filter the list of locations by country when setting a task. Note that supported location types in Tripadvisor Business Data API are City and Region only.
      operationId: TripadvisorLocations
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/BusinessDataTripadvisorLocationsResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  '/v3/business_data/tripadvisor/locations/{country}':
    get:
      tags:
        - BusinessData
      description: You will receive the list of locations by this API call. You can filter the list of locations by country when setting a task. Note that supported location types in Tripadvisor Business Data API are City and Region only.
      operationId: TripadvisorLocationsCountry
      parameters:
        - name: country
          in: path
          description: <em>country ISO code</em><br>optional field<br>specify the ISO code if you want to filter the list of locations by country<br>example:<br><code>us</code>
          required: true
          schema:
            type: string
          example: us
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/BusinessDataTripadvisorLocationsCountryResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/business_data/tripadvisor/languages:
    get:
      tags:
        - BusinessData
      description: You will receive the list of languages by calling this API.
      operationId: TripadvisorLanguages
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/BusinessDataTripadvisorLanguagesResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/business_data/tripadvisor/search/task_post:
    post:
      tags:
        - BusinessData
      description: "‌‌\nThis endpoint provides a list of business profiles listed on the Tripadvisor platform. The returned results are relevant to the specified keyword and the selected location (see the List of Locations)."
      operationId: TripadvisorSearchTaskPost
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/BusinessDataTripadvisorSearchTaskPostRequestInfo'
                nullable: true
              example:
                - keyword: pizza
                  location_code: 1003854
                  depth: 30
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/BusinessDataTripadvisorSearchTaskPostResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/business_data/tripadvisor/search/tasks_ready:
    get:
      tags:
        - BusinessData
      description: "‌\nThe ‘Tasks Ready’ endpoint is designed to provide you with the list of completed tasks, which haven’t been collected yet. If you don’t use the postback_url, you can receive the list of id for all completed tasks using this endpoint. Then, you can collect the results using the ‘Task GET’ endpoint."
      operationId: TripadvisorSearchTasksReady
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/BusinessDataTripadvisorSearchTasksReadyResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  '/v3/business_data/tripadvisor/search/task_get/{id}':
    get:
      tags:
        - BusinessData
      description: This endpoint will provide you with data on businesses listed on the Tripadvisor platform. The results obtained through this endpoint are specific to the location (see the List of Tripadvisor Locations) and keyword parameters used in the POST request.
      operationId: TripadvisorSearchTaskGet
      parameters:
        - name: id
          in: path
          description: <em>task identifier</em><br><strong>unique task identifier in our system in the <a href="https://en.wikipedia.org/wiki/Universally_unique_identifier">UUID</a> format</strong><br>you will be able to use it within <strong>30 days</strong> to request the results of the task at any time
          required: true
          schema:
            type: string
          example: 00000000-0000-0000-0000-000000000000
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/BusinessDataTripadvisorSearchTaskGetResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/business_data/tripadvisor/reviews/task_post:
    post:
      tags:
        - BusinessData
      description: "‌‌\nThis endpoint provides results from the “Reviews” element on the Tripadvisor platform. The results are specific to the URL path or keyword you indicate, and and the selected location (see the List of Locations)."
      operationId: TripadvisorReviewsTaskPost
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/BusinessDataTripadvisorReviewsTaskPostRequestInfo'
                nullable: true
              example:
                - url_path: Hotel_Review-g60763-d23462501-Reviews-Margaritaville_Times_Square-New_York_City_New_York.html
                  location_code: 1003854
                  pingback_url: https://your-server.com/pingback.php?id=$id&tag=$tag
                  tag: some_string_123
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/BusinessDataTripadvisorReviewsTaskPostResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/business_data/tripadvisor/reviews/tasks_ready:
    get:
      tags:
        - BusinessData
      description: "‌\nThe ‘Tasks Ready’ endpoint is designed to provide you with the list of completed tasks, which haven’t been collected yet. If you don’t use the postback_url, you can receive the list of id for all completed tasks using this endpoint. Then, you can collect the results using the ‘Task GET’ endpoint."
      operationId: TripadvisorReviewsTasksReady
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/BusinessDataTripadvisorReviewsTasksReadyResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  '/v3/business_data/tripadvisor/reviews/task_get/{id}':
    get:
      tags:
        - BusinessData
      description: 'This endpoint provides feedback data on businesses listed on the Tripadvisor platform, including their locations, ratings, review content and count. The results are specific to the URL path indicated in the POST request.'
      operationId: TripadvisorReviewsTaskGet
      parameters:
        - name: id
          in: path
          description: <em>task identifier</em><br><strong>unique task identifier in our system in the <a href="https://en.wikipedia.org/wiki/Universally_unique_identifier">UUID</a> format</strong><br>you will be able to use it within <strong>30 days</strong> to request the results of the task at any time
          required: true
          schema:
            type: string
          example: 00000000-0000-0000-0000-000000000000
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/BusinessDataTripadvisorReviewsTaskGetResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/appendix/user_data:
    get:
      tags:
        - Appendix
      description: 'You will receive detailed information about your API usage, prices, spending and other account details by calling this API.'
      operationId: UserData
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AppendixUserDataResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/appendix/errors:
    get:
      tags:
        - Appendix
      description: This endpoint returns a list of possible DataForSEO API errors and general status codes. Below you will find a list of HTTP response codes and internal messages. We recommend storing the data connected to error codes in your application log and designing a necessary system for handling related exceptional or error conditions.
      operationId: Errors
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AppendixErrorsResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/appendix/webhook_resend:
    post:
      tags:
        - Appendix
      description: "Using this endpoint you can resend webhooks (pingbacks and postbacks) for up to 100 specified tasks.\nNote: Your account will not be double-charged for resending a webhook."
      operationId: WebhookResend
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AppendixWebhookResendRequestInfo'
                nullable: true
              example:
                - id: 08161139-0001-0066-1000-06491d097ed5
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AppendixWebhookResendResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
  /v3/appendix/status:
    get:
      tags:
        - Appendix
      description: By calling this API you will receive detailed information about the current status of all our APIs and endpoints. You will also get a full issue description if a problem occurs.
      operationId: AppendixStatus
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AppendixStatusResponseInfo'
                nullable: true
      security:
        - basicAuth: [ ]
components:
  schemas:
    BaseChatGptLlmScraperElementItem:
      type: object
      properties:
        type:
          type: string
          description: type of element
          nullable: true
        rank_group:
          type: integer
          description: <em>group rank in SERP</em><br>position within a group of elements with identical <code>type</code> values<br>positions of elements with different <code>type</code> values are omitted from <code>rank_group</code>
          nullable: true
        rank_absolute:
          type: integer
          description: <em>absolute rank in SERP</em><br>absolute position among all the elements
          nullable: true
      additionalProperties: false
      discriminator:
        propertyName: type
        mapping:
          chat_gpt_text: '#/components/schemas/ChatGptTextElementItem'
          chat_gpt_table: '#/components/schemas/ChatGptTableElementItem'
          chat_gpt_navigation_list: '#/components/schemas/ChatGptNavigationListElementItem'
          chat_gpt_images: '#/components/schemas/ChatGptImagesElementItem'
          chat_gpt_products: '#/components/schemas/ChatGptProductsElementItem'
          chat_gpt_local_businesses: '#/components/schemas/ChatGptLocalBusinessesElementItem'
          chat_gpt_ad: '#/components/schemas/ChatGptAdElementItem'
    BaseGeminiLlmScraperElementItem:
      type: object
      properties:
        type:
          type: string
          description: type of element
          nullable: true
        rank_group:
          type: integer
          description: <em>group rank in SERP</em><br>position within a group of elements with identical <code>type</code> values<br>positions of elements with different <code>type</code> values are omitted from <code>rank_group</code>
          nullable: true
        rank_absolute:
          type: integer
          description: <em>absolute rank in SERP</em><br>absolute position among all the elements in SERP
          nullable: true
        markdown:
          type: string
          description: <em>content of the element in markdown format</em><br>content of the result formatted in the <a href="https://en.wikipedia.org/wiki/Markdown" target="_blank">markdown markup language</a>
          nullable: true
      additionalProperties: false
      discriminator:
        propertyName: type
        mapping:
          gemini_text: '#/components/schemas/GeminiTextElementItem'
          gemini_table: '#/components/schemas/GeminiTableElementItem'
          gemini_images: '#/components/schemas/GeminiImagesElementItem'
    BaseAiOptimizationLlmResponseElementItem:
      type: object
      properties:
        type:
          type: string
          description: type of element
          nullable: true
      additionalProperties: false
      discriminator:
        propertyName: type
        mapping:
          reasoning: '#/components/schemas/ReasoningAiOptimizationLlmResponseElementItem'
          message: '#/components/schemas/MessageAiOptimizationLlmResponseElementItem'
    BaseBingSerpApiElementItem:
      type: object
      properties:
        type:
          type: string
          description: type of element
          nullable: true
        rank_group:
          type: integer
          description: <em>group rank in SERP</em><br>position within a group of elements with identical <code>type</code> values<br>positions of elements with different <code>type</code> values are omitted from <code>rank_group</code>
          nullable: true
        rank_absolute:
          type: integer
          description: <em> absolute rank in SERP</em><br>absolute position among all the elements in SERP
          nullable: true
        page:
          type: integer
          description: <em>search results page number</em><br>indicates the number of the SERP page on which the element is located
          nullable: true
        position:
          type: string
          description: '<em>the alignment of the element in SERP</em><br>            can take the following values:<br>            <code>left</code>, <code>right</code>'
          nullable: true
        xpath:
          type: string
          description: <em>the <a href="https://en.wikipedia.org/wiki/XPath">XPath</a> of the element</em>
          nullable: true
        rectangle:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AiModeRectangleInfo'
          description: <em>rectangle parameters</em><br>            contains cartesian coordinates and pixel dimensions of the result's snippet in SERP<br>            equals <code>null</code> if <code>calculate_rectangles</code> in the POST request is not set to <code>true</code>
          nullable: true
      additionalProperties: false
      discriminator:
        propertyName: type
        mapping:
          organic: '#/components/schemas/BingOrganicSerpElementItem'
          paid: '#/components/schemas/BingPaidSerpElementItem'
          featured_snippet: '#/components/schemas/BingFeaturedSnippetSerpElementItem'
          related_searches: '#/components/schemas/BingRelatedSearchesSerpElementItem'
          ai_overview: '#/components/schemas/BingAiOverviewSerpElementItem'
          images: '#/components/schemas/BingImagesSerpElementItem'
          video: '#/components/schemas/BingVideoSerpElementItem'
          shopping: '#/components/schemas/BingShoppingSerpElementItem'
          answer_box: '#/components/schemas/BingAnswerBoxSerpElementItem'
          local_pack: '#/components/schemas/BingLocalPackSerpElementItem'
          questions_and_answers: '#/components/schemas/BingQuestionsAndAnswersSerpElementItem'
          hotels_pack: '#/components/schemas/BingHotelsPackSerpElementItem'
          jobs: '#/components/schemas/BingJobsSerpElementItem'
          top_stories: '#/components/schemas/BingTopStoriesSerpElementItem'
          carousel: '#/components/schemas/BingCarouselSerpElementItem'
          map: '#/components/schemas/BingMapSerpElementItem'
          events: '#/components/schemas/BingEventsSerpElementItem'
          recipes: '#/components/schemas/BingRecipesSerpElementItem'
          people_also_ask: '#/components/schemas/BingPeopleAlsoAskSerpElementItem'
          people_also_search: '#/components/schemas/BingPeopleAlsoSearchSerpElementItem'
    BaseSerpApiElementItem:
      type: object
      properties:
        type:
          type: string
          description: type of element
          nullable: true
        page:
          type: integer
          description: <em>search results page number</em><br>indicates the number of the SERP page on which the element is located
          nullable: true
        position:
          type: string
          description: '<em>the alignment of the element in SERP</em><br>can take the following values:<br><code>left</code>, <code>right</code>'
          nullable: true
        xpath:
          type: string
          description: <em>the <a href="https://en.wikipedia.org/wiki/XPath">XPath</a> of the element</em>
          nullable: true
        rectangle:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AiModeRectangleInfo'
          description: <em>rectangle parameters</em><br>contains cartesian coordinates and pixel dimensions of the result's snippet in SERP<br>equals <code>null</code> if <code>calculate_rectangles</code> in the POST request is not set to <code>true</code>
          nullable: true
      additionalProperties: false
      discriminator:
        propertyName: type
        mapping:
          paid: '#/components/schemas/PaidSerpElementItem'
          organic: '#/components/schemas/OrganicSerpElementItem'
          featured_snippet: '#/components/schemas/FeaturedSnippetSerpElementItem'
          knowledge_graph: '#/components/schemas/KnowledgeGraphSerpElementItem'
          top_stories: '#/components/schemas/TopStoriesSerpElementItem'
          people_also_ask: '#/components/schemas/PeopleAlsoAskSerpElementItem'
          people_also_search: '#/components/schemas/PeopleAlsoSearchSerpElementItem'
          images: '#/components/schemas/ImagesSerpElementItem'
          twitter: '#/components/schemas/TwitterSerpElementItem'
          google_reviews: '#/components/schemas/GoogleReviewsSerpElementItem'
          jobs: '#/components/schemas/JobsSerpElementItem'
          map: '#/components/schemas/MapSerpElementItem'
          app: '#/components/schemas/AppSerpElementItem'
          local_pack: '#/components/schemas/LocalPackSerpElementItem'
          carousel: '#/components/schemas/CarouselSerpElementItem'
          video: '#/components/schemas/VideoSerpElementItem'
          answer_box: '#/components/schemas/AnswerBoxSerpElementItem'
          shopping: '#/components/schemas/ShoppingSerpElementItem'
          google_flights: '#/components/schemas/GoogleFlightsSerpElementItem'
          events: '#/components/schemas/EventsSerpElementItem'
          related_searches: '#/components/schemas/RelatedSearchesSerpElementItem'
          multi_carousel: '#/components/schemas/MultiCarouselSerpElementItem'
          recipes: '#/components/schemas/RecipesSerpElementItem'
          top_sights: '#/components/schemas/TopSightsSerpElementItem'
          scholarly_articles: '#/components/schemas/ScholarlyArticlesSerpElementItem'
          popular_products: '#/components/schemas/PopularProductsSerpElementItem'
          stocks_box: '#/components/schemas/StocksBoxSerpElementItem'
          find_results_on: '#/components/schemas/FindResultsOnSerpElementItem'
          questions_and_answers: '#/components/schemas/QuestionsAndAnswersSerpElementItem'
          hotels_pack: '#/components/schemas/HotelsPackSerpElementItem'
          commercial_units: '#/components/schemas/CommercialUnitsSerpElementItem'
          local_services: '#/components/schemas/LocalServicesSerpElementItem'
          google_hotels: '#/components/schemas/GoogleHotelsSerpElementItem'
          math_solver: '#/components/schemas/MathSolverSerpElementItem'
          currency_box: '#/components/schemas/CurrencyBoxSerpElementItem'
          product_considerations: '#/components/schemas/ProductConsiderationsSerpElementItem'
          short_videos: '#/components/schemas/ShortVideosSerpElementItem'
          refine_products: '#/components/schemas/RefineProductsSerpElementItem'
          perspectives: '#/components/schemas/PerspectivesSerpElementItem'
          discussions_and_forums: '#/components/schemas/DiscussionsAndForumsSerpElementItem'
          compare_sites: '#/components/schemas/CompareSitesSerpElementItem'
          knowledge_graph_carousel_item: '#/components/schemas/KnowledgeGraphCarouselItemSerpElementItem'
          knowledge_graph_description_item: '#/components/schemas/KnowledgeGraphDescriptionItemSerpElementItem'
          knowledge_graph_images_item: '#/components/schemas/KnowledgeGraphImagesItemSerpElementItem'
          knowledge_graph_list_item: '#/components/schemas/KnowledgeGraphListItemSerpElementItem'
          knowledge_graph_row_item: '#/components/schemas/KnowledgeGraphRowItemSerpElementItem'
          knowledge_graph_hotels_booking_item: '#/components/schemas/KnowledgeGraphHotelsBookingItemSerpElementItem'
          knowledge_graph_expanded_item: '#/components/schemas/KnowledgeGraphExpandedItemSerpElementItem'
          knowledge_graph_part_item: '#/components/schemas/KnowledgeGraphPartItemSerpElementItem'
          knowledge_graph_shopping_item: '#/components/schemas/KnowledgeGraphShoppingItemSerpElementItem'
          knowledge_graph_ai_overview_item: '#/components/schemas/KnowledgeGraphAiOverviewItemSerpElementItem'
          ai_overview: '#/components/schemas/AiOverviewSerpElementItem'
          third_party_reviews: '#/components/schemas/ThirdPartyReviewsSerpElementItem'
          dictionary: '#/components/schemas/DictionarySerpElementItem'
          google_posts: '#/components/schemas/GooglePostsSerpElementItem'
          mention_carousel: '#/components/schemas/MentionCarouselSerpElementItem'
          podcasts: '#/components/schemas/PodcastsSerpElementItem'
          visual_stories: '#/components/schemas/VisualStoriesSerpElementItem'
          found_on_web: '#/components/schemas/FoundOnWebSerpElementItem'
          explore_brands: '#/components/schemas/ExploreBrandsSerpElementItem'
          courses: '#/components/schemas/CoursesSerpElementItem'
    BaseSerpApiKnowledgeGraphElementItem:
      type: object
      properties:
        type:
          type: string
          description: type of element
          nullable: true
        page:
          type: integer
          description: <em>search results page number</em><br>indicates the number of the SERP page on which the element is located
          nullable: true
        position:
          type: string
          description: '<em>the alignment of the element in SERP</em><br>can take the following values:<br><code>left</code>, <code>right</code>'
          nullable: true
        xpath:
          type: string
          description: <em>the <a href="https://en.wikipedia.org/wiki/XPath">XPath</a> of the element</em>
          nullable: true
        rectangle:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AiModeRectangleInfo'
          description: <em>rectangle parameters</em><br>contains cartesian coordinates and pixel dimensions of the result's snippet in SERP<br>equals <code>null</code> if <code>calculate_rectangles</code> in the POST request is not set to <code>true</code>
          nullable: true
      additionalProperties: false
      discriminator:
        propertyName: type
        mapping:
          knowledge_graph_carousel_item: '#/components/schemas/SerpApiKnowledgeGraphCarouselItemElementItem'
          knowledge_graph_description_item: '#/components/schemas/SerpApiKnowledgeGraphDescriptionItemElementItem'
          knowledge_graph_images_item: '#/components/schemas/SerpApiKnowledgeGraphImagesItemElementItem'
          knowledge_graph_list_item: '#/components/schemas/SerpApiKnowledgeGraphListItemElementItem'
          knowledge_graph_row_item: '#/components/schemas/SerpApiKnowledgeGraphRowItemElementItem'
          knowledge_graph_expanded_item: '#/components/schemas/SerpApiKnowledgeGraphExpandedItemElementItem'
          knowledge_graph_part_item: '#/components/schemas/SerpApiKnowledgeGraphPartItemElementItem'
          knowledge_graph_shopping_item: '#/components/schemas/SerpApiKnowledgeGraphShoppingItemElementItem'
          knowledge_graph_hotels_booking_item: '#/components/schemas/SerpApiKnowledgeGraphHotelsBookingItemElementItem'
          knowledge_graph_ai_overview_item: '#/components/schemas/SerpApiKnowledgeGraphAiOverviewItemElementItem'
    BaseSerpApiProductConsiderationExpandedElementItem:
      type: object
      properties:
        type:
          type: string
          description: type of element
          nullable: true
      additionalProperties: false
      discriminator:
        propertyName: type
        mapping:
          product_considerations_expanded_element: '#/components/schemas/SerpApiProductConsiderationsExpandedElementItem'
          product_considerations_ai_overview_expanded_element: '#/components/schemas/SerpApiProductConsiderationsAiOverviewExpandedElementItem'
    BaseSerpApiBingPeopleAlsoAskExpandedElementItem:
      type: object
      properties:
        type:
          type: string
          description: type of element
          nullable: true
        featured_title:
          type: string
          description: <em>title</em>
          nullable: true
        url:
          type: string
          description: <em>URL</em>
          nullable: true
        domain:
          type: string
          description: <em>domain name of the reference</em>
          nullable: true
        title:
          type: string
          description: <em>title of the result in SERP</em>
          nullable: true
        description:
          type: string
          description: <em>description of the results element in SERP</em>
          nullable: true
        images:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/AiModeImagesElementInfo'
            nullable: true
          description: <em>images of the element</em>
          nullable: true
        timestamp:
          type: string
          description: '<em>date and time when the video was published</em><br>            in the UTC format: "yyyy-mm-dd hh-mm-ss +00:00"<br>            example: <code>2009-01-01 00:00:00 +00:00</code>'
          nullable: true
        table:
          type: object
          oneOf:
            - $ref: '#/components/schemas/Table'
          description: '<em>results table</em><br>            if there are none, equals <code>null</code>'
          nullable: true
      additionalProperties: false
      discriminator:
        propertyName: type
        mapping:
          people_also_ask_expanded_element: '#/components/schemas/SerpApiBingPeopleAlsoAskExpandedElementItem'
    BaseSerpApiPeopleAlsoAskExpandedElementItem:
      type: object
      properties:
        type:
          type: string
          description: type of element
          nullable: true
      additionalProperties: false
      discriminator:
        propertyName: type
        mapping:
          people_also_ask_expanded_element: '#/components/schemas/SerpApiPeopleAlsoAskExpandedElementItem'
          people_also_ask_ai_overview_expanded_element: '#/components/schemas/SerpApiPeopleAlsoAskAiOverviewExpandedElementItem'
    BaseSerpApiBingAiOverviewElementItem:
      type: object
      properties:
        type:
          type: string
          description: type of element
          nullable: true
      additionalProperties: false
      discriminator:
        propertyName: type
        mapping:
          ai_overview_element: '#/components/schemas/SerpApiBingAiOverviewElementItem'
          ai_overview_video_element: '#/components/schemas/SerpApiBingAiOverviewVideoElementItem'
          ai_overview_videos_element: '#/components/schemas/SerpApiBingAiOverviewVideosElementItem'
          ai_overview_images_element: '#/components/schemas/SerpApiBingAiOverviewImagesElementItem'
          ai_overview_organic_element: '#/components/schemas/SerpApiBingAiOverviewOrganicElementItem'
    BaseSerpApiAiOverviewElementItem:
      type: object
      properties:
        type:
          type: string
          description: type of element
          nullable: true
        position:
          type: string
          description: '<em>the alignment of the element in SERP</em><br>can take the following values:<br><code>left</code>, <code>right</code>'
          nullable: true
      additionalProperties: false
      discriminator:
        propertyName: type
        mapping:
          ai_overview_element: '#/components/schemas/SerpApiAiOverviewElementItem'
          ai_overview_expanded_element: '#/components/schemas/SerpApiAiOverviewExpandedElementItem'
          ai_overview_video_element: '#/components/schemas/SerpApiAiOverviewVideoElementItem'
          ai_overview_table_element: '#/components/schemas/SerpApiAiOverviewTableElementItem'
    BaseSerpApiGoogleMapsElementItem:
      type: object
      properties:
        type:
          type: string
          description: type of element
          nullable: true
        rank_group:
          type: integer
          description: <em>group rank in SERP</em><br>position within a group of elements with identical <code>type</code> values<br>positions of elements with different <code>type</code> values are omitted from <code>rank_group</code>
          nullable: true
        rank_absolute:
          type: integer
          description: <em> absolute rank in SERP</em><br>absolute position among all the elements in SERP
          nullable: true
        domain:
          type: string
          description: <em>domain in SERP</em>
          nullable: true
        title:
          type: string
          description: <em>title of the element</em>
          nullable: true
        url:
          type: string
          description: <em>search URL with refinement parameters</em>
          nullable: true
        rating:
          type: object
          oneOf:
            - $ref: '#/components/schemas/RatingInfo'
          description: <em>the element's rating </em><br>the popularity rate based on reviews and displayed in SERP
          nullable: true
        rating_distribution:
          type: object
          additionalProperties:
            type: integer
            format: Int64
            nullable: true
          description: '<em>the distribution of ratings of the business entity</em><br>the object displays the number of 1-star to 5-star ratings, as reviewed by users'
          nullable: true
      additionalProperties: false
      discriminator:
        propertyName: type
        mapping:
          maps_search: '#/components/schemas/SerpApiMapsSearchElementItem'
          maps_paid_item: '#/components/schemas/SerpApiMapsPaidItemElementItem'
    BaseSerpApiAiModeAiOverviewElementItem:
      type: object
      properties:
        type:
          type: string
          description: type of element
          nullable: true
        position:
          type: string
          description: '<em>the alignment of the element in SERP</em><br>can take the following values:<br><code>left</code>, <code>right</code>'
          nullable: true
      additionalProperties: false
      discriminator:
        propertyName: type
        mapping:
          ai_overview_element: '#/components/schemas/SerpApiAiModeAiOverviewElementItem'
          ai_overview_expanded_element: '#/components/schemas/SerpApiAiModeAiOverviewExpandedElementItem'
          ai_overview_video_element: '#/components/schemas/SerpApiAiModeAiOverviewVideoElementItem'
          ai_overview_table_element: '#/components/schemas/SerpApiAiModeAiOverviewTableElementItem'
          ai_overview_shopping: '#/components/schemas/SerpApiAiModeAiOverviewShoppingItem'
          ai_overview_paid: '#/components/schemas/SerpApiAiModeAiOverviewPaidItem'
    BaseSerpApiYoutubeOrganicElementItem:
      type: object
      properties:
        type:
          type: string
          description: type of element
          nullable: true
        rank_group:
          type: integer
          description: <em>group rank in SERP</em><br>            position within a group of elements with identical <code>type</code> values<br>            positions of elements with different <code>type</code> values are omitted from <code>rank_group</code>
          nullable: true
        rank_absolute:
          type: integer
          description: <em> absolute rank in SERP for the target domain</em><br>            absolute position among all the elements in SERP
          nullable: true
        block_rank:
          type: integer
          description: <em>block rank in SERP</em><br>            position among all the blocks in SERP
          nullable: true
        block_name:
          type: string
          description: <em>name of the block in SERP</em><br>            example:<br>            <code>"People also watched"</code><br>
          nullable: true
        channel_id:
          type: string
          description: <em>ID of the channel</em>
          nullable: true
        url:
          type: string
          description: <em>URL of the channel</em>
          nullable: true
      additionalProperties: false
      discriminator:
        propertyName: type
        mapping:
          youtube_channel: '#/components/schemas/SerpApiYoutubeChannelElementItem'
          youtube_video: '#/components/schemas/SerpApiYoutubeVideoElementItem'
          youtube_video_paid: '#/components/schemas/SerpApiYoutubeVideoPaidElementItem'
          youtube_playlist: '#/components/schemas/SerpApiYoutubePlaylistElementItem'
    BaseSerpApiGoogleNewsElementItem:
      type: object
      properties:
        type:
          type: string
          description: type of element
          nullable: true
        rank_group:
          type: integer
          description: <em>group rank in SERP</em><br>position within a group of elements with identical <code>type</code> values<br>positions of elements with different <code>type</code> values are omitted from <code>rank_group</code>
          nullable: true
        rank_absolute:
          type: integer
          description: <em> absolute rank in SERP</em><br>absolute position among all the elements in SERP
          nullable: true
        xpath:
          type: string
          description: <em>the <a href="https://en.wikipedia.org/wiki/XPath" rel="noopener noreferrer" target="_blank">XPath</a> of the element</em>
          nullable: true
        title:
          type: string
          description: <em>title of the element</em>
          nullable: true
        rectangle:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AiModeRectangleInfo'
          description: <em>rectangle parameters</em><br>contains cartesian coordinates and pixel dimensions of the result's snippet in SERP<br>equals <code>null</code> if <code>calculate_rectangles</code> in the POST request is not set to <code>true</code>
          nullable: true
      additionalProperties: false
      discriminator:
        propertyName: type
        mapping:
          news_search: '#/components/schemas/SerpApiGoogleNewsNewsSearchElementItem'
          top_stories: '#/components/schemas/SerpApiGoogleNewsTopStoriesElementItem'
    BaseSerpApiGoogleImagesElementItem:
      type: object
      properties:
        type:
          type: string
          description: type of element
          nullable: true
        rank_group:
          type: integer
          description: <em>group rank in SERP</em><br>position within a group of elements with identical <code>type</code> values<br>positions of elements with different <code>type</code> values are omitted from <code>rank_group</code>
          nullable: true
        rank_absolute:
          type: integer
          description: <em> absolute rank in SERP for the target domain</em><br>absolute position among all the elements in SERP
          nullable: true
        xpath:
          type: string
          description: <em>the <a href="https://en.wikipedia.org/wiki/XPath" rel="noopener noreferrer" target="_blank">XPath</a> of the element</em>
          nullable: true
      additionalProperties: false
      discriminator:
        propertyName: type
        mapping:
          carousel: '#/components/schemas/SerpApiGoogleImagesCarouselElementItem'
          images_search: '#/components/schemas/SerpApiGoogleImagesImagesSearchElementItem'
          related_searches: '#/components/schemas/SerpApiGoogleImagesRelatedSearchesElementItem'
    BaseSerpApiAdsAdvertiserElementItem:
      type: object
      properties:
        type:
          type: string
          description: type of element
          nullable: true
        rank_group:
          type: integer
          description: <em>group rank in SERP</em><br>position within a group of elements with identical <code>type</code> values<br>positions of elements with different <code>type</code> values are omitted from <code>rank_group</code>
          nullable: true
        rank_absolute:
          type: integer
          description: <em>absolute rank in SERP</em><br>absolute position among all the elements in SERP
          nullable: true
      additionalProperties: false
      discriminator:
        propertyName: type
        mapping:
          ads_multi_account_advertiser: '#/components/schemas/SerpApiAdsMultiAccountAdvertiserElementItem'
          ads_advertiser: '#/components/schemas/SerpApiAdsAdvertiserElementItem'
          ads_domain: '#/components/schemas/SerpApiAdsDomainElementItem'
    BaseSerpApiGoogleSearchByImagesElementItem:
      type: object
      properties:
        type:
          type: string
          description: type of element
          nullable: true
        rank_group:
          type: integer
          description: <em>group rank in SERP</em><br>            position within a group of elements with identical <code>type</code> values<br>            positions of elements with different <code>type</code> values are omitted from <code>rank_group</code>
          nullable: true
        rank_absolute:
          type: integer
          description: <em>absolute rank in SERP</em><br>            absolute position among all the elements in SERP
          nullable: true
        page:
          type: integer
          nullable: true
        position:
          type: string
          description: '<em>the alignment of the element in SERP</em><br>            can take the following values:<br>            <code>left</code>, <code>right</code>'
          nullable: true
        xpath:
          type: string
          description: <em>the <a href="https://en.wikipedia.org/wiki/XPath" rel="noopener noreferrer" target="_blank">XPath</a> of the element</em>
          nullable: true
        title:
          type: string
          description: <em>title of the element</em>
          nullable: true
        url:
          type: string
          description: <em>search URL with refinement parameters</em>
          nullable: true
        rectangle:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AiModeRectangleInfo'
          description: <em>rectangle parameters</em><br>            contains cartesian coordinates and pixel dimensions of the result's snippet in SERP<br>            equals <code>null</code> if <code>calculate_rectangles</code> in the POST request is not set to <code>true</code>
          nullable: true
      additionalProperties: false
      discriminator:
        propertyName: type
        mapping:
          organic: '#/components/schemas/SerpApiGoogleSearchByImagesOrganicElementItem'
          images: '#/components/schemas/SerpApiGoogleSearchByImagesImagesElementItem'
    BaseSerpApiGoogleFinanceElementItem:
      type: object
      properties:
        type:
          type: string
          description: type of element
          nullable: true
      additionalProperties: false
      discriminator:
        propertyName: type
        mapping:
          google_finance_asset_pair_element: '#/components/schemas/SerpApiGoogleFinanceAssetPairElementElementItem'
          google_finance_market_index_element: '#/components/schemas/SerpApiGoogleFinanceMarketIndexElementElementItem'
          google_finance_market_instrument_element: '#/components/schemas/SerpApiGoogleFinanceMarketInstrumentElementElementItem'
          google_finance_hero_groups: '#/components/schemas/SerpApiGoogleFinanceHeroGroupsElementItem'
          google_finance_interested: '#/components/schemas/SerpApiGoogleFinanceInterestedElementItem'
          google_finance_news: '#/components/schemas/SerpApiGoogleFinanceNewsElementItem'
          google_finance_earnings_calendar: '#/components/schemas/SerpApiGoogleFinanceEarningsCalendarElementItem'
          google_finance_most_followed: '#/components/schemas/SerpApiGoogleFinanceMostFollowedElementItem'
          google_finance_market_trends: '#/components/schemas/SerpApiGoogleFinanceMarketTrendsElementItem'
          google_finance_people_also_search: '#/components/schemas/SerpApiGoogleFinancePeopleAlsoSearchElementItem'
          google_finance_explore_market_trends: '#/components/schemas/SerpApiGoogleFinanceExploreMarketTrendsElementItem'
          google_finance_quote: '#/components/schemas/SerpApiGoogleFinanceQuoteElementItem'
          google_finance_compare_to: '#/components/schemas/SerpApiGoogleFinanceCompareToElementItem'
          google_finance_financial: '#/components/schemas/SerpApiGoogleFinanceFinancialElementItem'
          google_finance_futures_chain: '#/components/schemas/SerpApiGoogleFinanceFuturesChainElementItem'
          google_finance_details: '#/components/schemas/SerpApiGoogleFinanceDetailsElementItem'
          google_finance_about: '#/components/schemas/SerpApiGoogleFinanceAboutElementItem'
    BaseSerpApiGoogleFinanceTickerSearchElementItem:
      type: object
      properties:
        type:
          type: string
          description: type of element
          nullable: true
        rank_group:
          type: integer
          description: <em>group rank in SERP</em><br>position within a group of elements with identical <code>type</code> values<br>positions of elements with different <code>type</code> values are omitted from <code>rank_group</code>
          nullable: true
        rank_absolute:
          type: integer
          description: <em>absolute rank in SERP</em><br>absolute position among all the elements in SERP
          nullable: true
        identifier:
          type: string
          description: '<em>identifier of the element</em><br>full identifier of the element that consists from <code>ticker</code> and <code>market_identifier</code><br>example: <code>PX1:INDEXDB</code>'
          nullable: true
        displayed_name:
          type: string
          description: '<em>name of the market index as displayed on Google Finance</em><br>example: <code>CAC 40</code>'
          nullable: true
        url:
          type: string
          description: <em>URL to the page of the market index on Google Finance</em>
          nullable: true
        location:
          type: string
          description: '<em>location of the market index</em><br>example: <code>Europe/Paris</code>'
          nullable: true
        trend:
          type: string
          description: '<em>growth trend of the market index</em><br>possible values: <code>up</code>, <code>down</code>, <code>stable</code>'
          nullable: true
        timestamp:
          type: string
          description: '<em>date and time of the value readout</em><br>in the UTC format: "yyyy-mm-dd hh-mm-ss +00:00"<br>example:<br><code class="long-string">2025-02-10 09:40:00 +00:00</code>'
          nullable: true
        percentage_delta:
          type: number
          description: <em>percentage of change in value of the market index</em>
          nullable: true
      additionalProperties: false
      discriminator:
        propertyName: type
        mapping:
          google_finance_asset_pair: '#/components/schemas/SerpApiGoogleFinanceAssetPairElementItem'
          google_finance_market_instrument: '#/components/schemas/SerpApiGoogleFinanceMarketInstrumentElementItem'
          google_finance_market_index: '#/components/schemas/SerpApiGoogleFinanceMarketIndexElementItem'
    BaseDataforseoLabsApiElementItem:
      type: object
      properties:
        type:
          type: string
          description: type of element
          nullable: true
        se_type:
          type: string
          description: <em>search engine type</em>
          nullable: true
        rank_group:
          type: integer
          description: <em>position within a group of elements with identical <code>type</code> values</em><br>            positions of elements with different <code>type</code> values are omitted from <code>rank_group</code>
          nullable: true
        rank_absolute:
          type: integer
          description: <em>absolute rank in SERP</em><br>            absolute position among all the elements in SERP
          nullable: true
        position:
          type: string
          description: '<em>the alignment of the element in SERP</em><br>            can take the following values:<br>            <code>left</code>, <code>right</code>'
          nullable: true
        xpath:
          type: string
          description: <em>the <a href="https://en.wikipedia.org/wiki/XPath">XPath</a> of the element</em>
          nullable: true
      additionalProperties: false
      discriminator:
        propertyName: type
        mapping:
          paid: '#/components/schemas/DataLabsPaidSerpElementItem'
          organic: '#/components/schemas/DataLabsOrganicSerpElementItem'
          local_pack: '#/components/schemas/DataLabsLocalPackSerpElementItem'
          answer_box: '#/components/schemas/DataLabsAnswerBoxSerpElementItem'
          carousel: '#/components/schemas/DataLabsCarouselSerpElementItem'
          multi_carousel: '#/components/schemas/DataLabsMultiCarouselSerpElementItem'
          featured_snippet: '#/components/schemas/DataLabsFeaturedSnippetSerpElementItem'
          google_flights: '#/components/schemas/DataLabsGoogleFlightsSerpElementItem'
          google_reviews: '#/components/schemas/DataLabsGoogleReviewsSerpElementItem'
          google_posts: '#/components/schemas/DataLabsGooglePostsSerpElementItem'
          images: '#/components/schemas/DataLabsImagesSerpElementItem'
          jobs: '#/components/schemas/DataLabsJobsSerpElementItem'
          knowledge_graph: '#/components/schemas/DataLabsKnowledgeGraphSerpElementItem'
          hotels_pack: '#/components/schemas/DataLabsHotelsPackSerpElementItem'
          map: '#/components/schemas/DataLabsMapSerpElementItem'
          people_also_ask: '#/components/schemas/DataLabsPeopleAlsoAskSerpElementItem'
          related_searches: '#/components/schemas/DataLabsRelatedSearchesSerpElementItem'
          people_also_search: '#/components/schemas/DataLabsPeopleAlsoSearchSerpElementItem'
          shopping: '#/components/schemas/DataLabsShoppingSerpElementItem'
          top_stories: '#/components/schemas/DataLabsTopStoriesSerpElementItem'
          twitter: '#/components/schemas/DataLabsTwitterSerpElementItem'
          video: '#/components/schemas/DataLabsVideoSerpElementItem'
          events: '#/components/schemas/DataLabsEventsSerpElementItem'
          recipes: '#/components/schemas/DataLabsRecipesSerpElementItem'
          top_sights: '#/components/schemas/DataLabsTopSightsSerpElementItem'
          scholarly_articles: '#/components/schemas/DataLabsScholarlyArticlesSerpElementItem'
          popular_products: '#/components/schemas/DataLabsPopularProductsSerpElementItem'
          questions_and_answers: '#/components/schemas/DataLabsQuestionsAndAnswersSerpElementItem'
          find_results_on: '#/components/schemas/DataLabsFindResultsOnSerpElementItem'
          stocks_box: '#/components/schemas/DataLabsStocksBoxSerpElementItem'
          commercial_units: '#/components/schemas/DataLabsCommercialUnitsSerpElementItem'
          local_services: '#/components/schemas/DataLabsLocalServicesSerpElementItem'
          google_hotels: '#/components/schemas/DataLabsGoogleHotelsSerpElementItem'
          math_solver: '#/components/schemas/DataLabsMathSolverSerpElementItem'
          mention_carousel: '#/components/schemas/DataLabsMentionCarouselSerpElementItem'
          podcasts: '#/components/schemas/DataLabsPodcastsSerpElementItem'
          visual_stories: '#/components/schemas/DataLabsVisualStoriesSerpElementItem'
          found_on_web: '#/components/schemas/DataLabsFoundOnWebSerpElementItem'
          explore_brands: '#/components/schemas/DataLabsExploreBrandsSerpElementItem'
          courses: '#/components/schemas/DataLabsCoursesSerpElementItem'
    BaseDataforseoLabsKnowledgeGraphElementItem:
      type: object
      properties:
        type:
          type: string
          description: type of element
          nullable: true
        rank_group:
          type: integer
          description: <em>group rank in SERP</em><br>            position within a group of elements with identical <code>type</code> values</em><br>            positions of elements with different <code>type</code> values are omitted from <code>rank_group</code>
          nullable: true
        rank_absolute:
          type: integer
          description: <em>absolute rank in SERP</em><br>            absolute position among all the elements in SERP
          nullable: true
        position:
          type: string
          description: '<em>the alignment of the element in SERP</em><br>            can take the following values:<br>            <code>left</code>, <code>right</code>'
          nullable: true
        xpath:
          type: string
          description: <em>the <a href="https://en.wikipedia.org/wiki/XPath">XPath</a> of the element</em>
          nullable: true
      additionalProperties: false
      discriminator:
        propertyName: type
        mapping:
          knowledge_graph_images_item: '#/components/schemas/DataforseoLabsKnowledgeGraphImagesItemElementItem'
          knowledge_graph_carousel_item: '#/components/schemas/DataforseoLabsKnowledgeGraphCarouselItemElementItem'
          knowledge_graph_description_item: '#/components/schemas/DataforseoLabsKnowledgeGraphDescriptionItemElementItem'
          knowledge_graph_list_item: '#/components/schemas/DataforseoLabsKnowledgeGraphListItemElementItem'
          knowledge_graph_part_item: '#/components/schemas/DataforseoLabsKnowledgeGraphPartItemElementItem'
          knowledge_graph_expanded_item: '#/components/schemas/DataforseoLabsKnowledgeGraphExpandedItemElementItem'
          knowledge_graph_row_item: '#/components/schemas/DataforseoLabsKnowledgeGraphRowItemElementItem'
          knowledge_graph_shopping_item: '#/components/schemas/DataforseoLabsKnowledgeGraphShoppingItemElementItem'
    BaseMerchantAmazonElementItem:
      type: object
      properties:
        type:
          type: string
          description: type of element
          nullable: true
        rank_group:
          type: integer
          description: <em>position within a group of elements with identical <code>type</code> values</em><br>positions of elements with different <code>type</code> values are omitted from <code>rank_group</code>
          nullable: true
        rank_absolute:
          type: integer
          description: <em> absolute rank in SERP</em><br>absolute position among all the elements found in Amazon SERP
          nullable: true
        xpath:
          type: string
          description: <em>the <a href="https://en.wikipedia.org/wiki/XPath">XPath</a> of the element</em>
          nullable: true
      additionalProperties: false
      discriminator:
        propertyName: type
        mapping:
          amazon_paid: '#/components/schemas/MerchantAmazonPaidSerpElementItem'
          amazon_serp: '#/components/schemas/MerchantAmazonSerpSerpElementItem'
          editorial_recommendations: '#/components/schemas/MerchantEditorialRecommendationsSerpElementItem'
          related_searches: '#/components/schemas/MerchantRelatedSearchesSerpElementItem'
          top_rated_from_our_brands: '#/components/schemas/MerchantTopRatedFromOurBrandsSerpElementItem'
    BaseMerchantAmazonSellersElementItem:
      type: object
      properties:
        type:
          type: string
          description: type of element
          nullable: true
        rank_group:
          type: integer
          description: <em>position within a group of elements with identical <code>type</code> values</em><br>positions of elements with different <code>type</code> values are omitted from <code>rank_group</code>
          nullable: true
        rank_absolute:
          type: integer
          description: <em> absolute rank in SERP</em><br>absolute position among all the elements found in Amazon Sellers SERP
          nullable: true
        position:
          type: string
          description: '<em>alignment of the element in SERP</em><br>possible values:<br><code>left</code>, <code>right</code>'
          nullable: true
        xpath:
          type: string
          description: <em><a href="https://en.wikipedia.org/wiki/XPath">XPath</a> of the element</em>
          nullable: true
        seller_name:
          type: string
          description: <em>business name of the seller</em>
          nullable: true
        seller_url:
          type: string
          description: <em>url forwarding to the seller's page on Amazon</em>
          nullable: true
        ships_from:
          type: string
          description: <em>sender company name</em>
          nullable: true
        price:
          type: object
          oneOf:
            - $ref: '#/components/schemas/PriceInfo'
          description: '<em>product pricing details</em><br>if there are no details, the value will be <code>null</code>'
          nullable: true
        percentage_discount:
          type: number
          description: <em>value of the percentage discount</em>
          nullable: true
        applicable_vouchers:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/AmazonApplicableVouchersItem'
            nullable: true
          description: <em>array of objects containing information about applicable vouchers</em>
          nullable: true
        rating:
          type: object
          oneOf:
            - $ref: '#/components/schemas/RatingElement'
          description: <em>seller rating details</em><br>seller popularity rate based on customer reviews
          nullable: true
        condition:
          type: string
          description: <em>product condition</em><br>condition of the product offered by the seller
          nullable: true
        condition_description:
          type: string
          description: <em>product condition details</em><br>expanded details on the condition of the product offered by the seller
          nullable: true
        delivery_info:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AmazonDeliveryInfo'
          description: <em>delivery information</em><br>delivery information including free and fast delivery date ranges
          nullable: true
      additionalProperties: false
      discriminator:
        propertyName: type
        mapping:
          amazon_seller_main_item: '#/components/schemas/MerchantAmazonSellerMainItemSerpElementItem'
          amazon_seller_item: '#/components/schemas/MerchantAmazonSellerItemSerpElementItem'
    BaseMerchantAmazonProductInformationElementItem:
      type: object
      properties:
        type:
          type: string
          description: type of element
          nullable: true
        section_name:
          type: string
          description: <em>name of the section related to product information specified in the <code>contents</code></em>
          nullable: true
      additionalProperties: false
      discriminator:
        propertyName: type
        mapping:
          product_information_details_item: '#/components/schemas/ProductInformationProductInformationDetailsItem'
          product_information_text_item: '#/components/schemas/ProductInformationProductInformationTextItem'
          product_information_extended_item: '#/components/schemas/ProductInformationProductInformationExtendedItem'
    BaseMerchantAmazonProductInformationRowElementItem:
      type: object
      properties:
        type:
          type: string
          description: type of element
          nullable: true
      additionalProperties: false
      discriminator:
        propertyName: type
        mapping:
          product_information_image_row: '#/components/schemas/ProductInformationRowProductInformationImageRowElementItem'
          product_information_text_row: '#/components/schemas/ProductInformationRowProductInformationTextRowElementItem'
    BaseMerchantGoogleShoppingSellersElementItem:
      type: object
      properties:
        type:
          type: string
          description: type of element
          nullable: true
        rank_group:
          type: integer
          description: <em>position within a group of elements with identical <code>type</code> values</em><br>positions of elements with different <code>type</code> values are omitted from <code>rank_group</code>
          nullable: true
        rank_absolute:
          type: integer
          description: <em> absolute rank in SERP</em><br>absolute position among all the elements found in Google Shopping SERP
          nullable: true
        position:
          type: string
          description: '<em>the alignment of the element in Google Shopping SERP</em><br>possible values:<br><code>left</code>, <code>right</code>'
          nullable: true
        xpath:
          type: string
          description: <em><a href="https://en.wikipedia.org/wiki/XPath">XPath</a> of the element</em>
          nullable: true
        domain:
          type: string
          description: <em>domain in SERP</em>
          nullable: true
        title:
          type: string
          description: <em>product title</em>
          nullable: true
        url:
          type: string
          description: '<em>Google Shopping URL forwarding to the product page on the seller’s website</em><br>if you want to obtain a URL of the advertisement forwarding to the product page on the seller''s website, please refer to the <a href="/v3/merchant/google/sellers/ad_url/">Google Shopping Sellers Ad URL</a> endpoint'
          nullable: true
        details:
          type: string
          description: '<em>details and special offers</em><br>if there are no details, the value will be <code>null</code>'
          nullable: true
        base_price:
          type: number
          description: <em>product price without tax and shipping</em>
          nullable: true
        tax:
          type: number
          description: '<em>the amount of tax</em><br>tax is specified as the actual amount of money, not as the percentage'
          nullable: true
        shipping_price:
          type: number
          description: <em>product shipping price</em>
          nullable: true
        total_price:
          type: number
          description: <em>product price including tax and shipping</em>
          format: int64
          nullable: true
        currency:
          type: string
          description: <em>currency in the <a href="https://en.wikipedia.org/wiki/ISO_4217">ISO</a> format</em><br>example:<br><code>USD</code>
          nullable: true
        seller_name:
          type: string
          description: <em>name of the seller</em><br>the name of the company that placed a corresponding product on Google Shopping
          nullable: true
        shop_ad_aclk:
          type: string
          description: <em>unique ad click referral parameter</em><br>using this parameter you can get a URL of the advertisement in <a href="/v3/merchant/google/sellers/ad_url/">Google Shopping Sellers Ad URL</a>
          nullable: true
      additionalProperties: false
      discriminator:
        propertyName: type
        mapping:
          shops_list: '#/components/schemas/GoogleShoppingSellersShopsListElementItem'
          buy_on_google: '#/components/schemas/GoogleShoppingSellersBuyOnGoogleElementItem'
    BaseMerchantGoogleShoppingProductsElementItem:
      type: object
      properties:
        type:
          type: string
          description: type of element
          nullable: true
        rank_group:
          type: integer
          description: <em>position within a group of elements with identical <code>type</code> values</em><br>positions of elements with different <code>type</code> values are omitted from <code>rank_group</code>
          nullable: true
        rank_absolute:
          type: integer
          description: <em>absolute rank in SERP</em><br>absolute position among all the elements found in Google Shopping SERP
          nullable: true
        position:
          type: string
          description: '<em>alignment of the element in SERP</em><br>can take the following values:<br><code>left</code>, <code>right</code>'
          nullable: true
        xpath:
          type: string
          description: <em><a href="https://en.wikipedia.org/wiki/XPath">XPath</a> of the element</em>
          nullable: true
      additionalProperties: false
      discriminator:
        propertyName: type
        mapping:
          google_shopping_serp: '#/components/schemas/GoogleShoppingSerpElementItem'
          google_shopping_paid: '#/components/schemas/GoogleShoppingPaidElementItem'
          google_shopping_sponsored_carousel: '#/components/schemas/GoogleShoppingSponsoredCarouselElementItem'
          google_shopping_carousel: '#/components/schemas/GoogleShoppingCarouselElementItem'
          related_searches: '#/components/schemas/RelatedSearchesElementItem'
    BaseOnPageResourceItem:
      type: object
      properties:
        resource_type:
          type: string
          description: type of element
          nullable: true
        status_code:
          type: integer
          description: 'general status codeyou can find the full list of the response codes hereNote: we strongly recommend designing a necessary system for handling related exceptional or error conditions'
          nullable: true
        location:
          type: string
          description: location headerindicates the URL to redirect a page to
          nullable: true
        url:
          type: string
          description: page URL
          nullable: true
        resource_errors:
          type: object
          oneOf:
            - $ref: '#/components/schemas/OnPageResourceIssueInfo'
          description: resource errors and warnings
          nullable: true
        size:
          type: integer
          description: resource sizeindicates the size of a given page measured in bytes
          nullable: true
        encoded_size:
          type: integer
          description: page size after encodingindicates the size of the encoded page measured in bytes
          nullable: true
        total_transfer_size:
          type: integer
          description: compressed page sizeindicates the compressed size of a given page
          format: int64
          nullable: true
        fetch_time:
          type: string
          description: 'date and time when a resource was fetchedin the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”example:2019-11-15 12:57:46 +00:00'
          nullable: true
        cache_control:
          type: object
          oneOf:
            - $ref: '#/components/schemas/CacheControl'
          description: instructions for caching
          nullable: true
        checks:
          type: object
          additionalProperties:
            type: boolean
            nullable: true
          description: website checkson-page check-ups related to the page
          nullable: true
        content_encoding:
          type: string
          description: type of encoding
          nullable: true
        media_type:
          type: string
          description: types of media used to display a page
          nullable: true
        server:
          type: string
          description: server version
          nullable: true
        last_modified:
          type: object
          oneOf:
            - $ref: '#/components/schemas/LastModified'
          description: 'contains data on changes related to the resourceif there is no data, the value will be null'
          nullable: true
      additionalProperties: false
      discriminator:
        propertyName: resource_type
        mapping:
          html: '#/components/schemas/OnPageHtmlResourceItem'
          broken: '#/components/schemas/OnPageBrokenResourceItem'
          redirect: '#/components/schemas/OnPageRedirectResourceItem'
          script: '#/components/schemas/OnPageScriptResourceItem'
          image: '#/components/schemas/OnPageImageResourceItem'
          stylesheet: '#/components/schemas/OnPageStylesheetResourceItem'
    BaseOnPageLinkItem:
      type: object
      properties:
        type:
          type: string
          description: type of element
          nullable: true
        domain_from:
          type: string
          description: <em>referring domain</em><br>the link was found on this domain
          nullable: true
        domain_to:
          type: string
          description: <em>referenced domain</em><br>the link is pointing to this domain
          nullable: true
        page_from:
          type: string
          description: <em>referring page</em><br>relative URL of the page on which the link was found
          nullable: true
        page_to:
          type: string
          description: <em>referenced page</em><br>relative URL of the page to which the link is pointing
          nullable: true
        link_from:
          type: string
          description: <em>referring page</em><br>absolute URL of the page on which the link was found
          nullable: true
        link_to:
          type: string
          description: <em>referenced page</em><br>absolute URL of the page to which the link is pointing
          nullable: true
        dofollow:
          type: boolean
          description: '<em>indicates whether the link is dofollow</em><br>if the value is <code>true</code>, the link doesn''t have a <code>rel="nofollow"</code> attribute'
          nullable: true
        page_from_scheme:
          type: string
          description: <em><a href="https://en.wikipedia.org/wiki/List_of_URI_schemes" target="_blank" rel="noopener noreferrer">url scheme</a> of the referring page</em>
          nullable: true
        page_to_scheme:
          type: string
          description: <em><a href="https://en.wikipedia.org/wiki/List_of_URI_schemes" target="_blank" rel="noopener noreferrer">url scheme</a> of the referenced page</em>
          nullable: true
        direction:
          type: string
          description: '<em>direction of the link</em><br>possible values: <code>internal</code>, <code>external</code>'
          nullable: true
        is_broken:
          type: boolean
          description: <em>link is broken</em><br>indicates whether a link is directing to a broken page or resource
          nullable: true
        is_link_relation_conflict:
          type: boolean
          description: '<em>indicates that the link may have a conflict with another link</em><br>if <code>true</code>, at least one link pointing to <code>link_to</code> has a <code>rel="nofollow"</code> attribute <strong>and</strong> at least one is dofollow'
          nullable: true
        page_to_status_code:
          type: integer
          description: <em>status code of the referenced page</em><br>status code of the page to which the link is pointing
          nullable: true
      additionalProperties: false
      discriminator:
        propertyName: type
        mapping:
          anchor: '#/components/schemas/OnPageAnchorLinkItem'
          image: '#/components/schemas/OnPageImageLinkItem'
          canonical: '#/components/schemas/OnPageCanonicalLinkItem'
          alternate: '#/components/schemas/OnPageAlternateLinkItem'
          link: '#/components/schemas/OnPageLinkLinkItem'
          redirect: '#/components/schemas/OnPageRedirectLinkItem'
          meta: '#/components/schemas/OnPageMetaLinkItem'
    BaseKeywordDataDataforseoTrendsItem:
      type: object
      properties:
        type:
          type: string
          description: type of element
          nullable: true
        position:
          type: integer
          description: '<em>the alignment of the element</em><br>can take the following values: <code>1</code>, <code>2</code>, <code>3</code>, <code>4</code>, etc.'
          nullable: true
        keywords:
          type: array
          items:
            type: string
            nullable: true
          description: <em>keywords in a POST array</em>
          nullable: true
      additionalProperties: false
      discriminator:
        propertyName: type
        mapping:
          dataforseo_trends_graph: '#/components/schemas/DataforseoTrendsDataforseoTrendsGraphElementItem'
          subregion_interests: '#/components/schemas/DataforseoTrendsSubregionInterestsElementItem'
          demography: '#/components/schemas/DataforseoTrendsDemographyElementItem'
    BaseKeywordDataGoogleTrendsItem:
      type: object
      properties:
        type:
          type: string
          description: type of element
          nullable: true
        position:
          type: integer
          description: '<em>the alignment of the element in Google Trends</em><br>can take the following values: <code>1</code>, <code>2</code>, <code>3</code>, <code>4</code>, etc.'
          nullable: true
        title:
          type: string
          description: <em>title of the element in Google Trends</em>
          nullable: true
        keywords:
          type: array
          items:
            type: string
            nullable: true
          description: <em>relevant keywords</em><br>the data included in the <code>google_trends_graph</code> element is based on the keywords listed in this array
          nullable: true
      additionalProperties: false
      discriminator:
        propertyName: type
        mapping:
          google_trends_graph: '#/components/schemas/GoogleTrendsGoogleTrendsGraphElementItem'
          google_trends_map: '#/components/schemas/GoogleTrendsGoogleTrendsMapElementItem'
          google_trends_queries_list: '#/components/schemas/GoogleTrendsGoogleTrendsQueriesListElementItem'
          google_trends_topics_list: '#/components/schemas/GoogleTrendsGoogleTrendsTopicsListElementItem'
    AiOptimizationLLmMentionsMultiTargetMetricsRequestInfo:
      type: object
      properties:
        target:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/BaseAiOptimizationLLmMentionsTargetElement'
            nullable: true
          nullable: true
        key:
          type: string
          description: "key for grouping the results\nrequired field\ngroups results for comparison and serves as a label for the group;\nyou can specify up to 250 characters in the key field"
          nullable: true
    AiOptimizationLLmMentionsDomainElement:
      allOf:
        - type: object
          oneOf:
            - $ref: '#/components/schemas/BaseAiOptimizationLLmMentionsTargetElement'
          nullable: true
        - type: object
          properties:
            domain:
              type: string
              description: "target domain\nrequired field if you don’t specify keyword\na domain should be specified without https:// and www."
              nullable: true
            include_subdomains:
              type: boolean
              description: "indicates if the subdomains of the target domain will be included in the search\noptional field\nif set to true, the subdomains will be included in the search\ndefault value: false"
              nullable: true
    AiOptimizationLLmMentionsKeywordElement:
      allOf:
        - type: object
          oneOf:
            - $ref: '#/components/schemas/BaseAiOptimizationLLmMentionsTargetElement'
          nullable: true
        - type: object
          properties:
            keyword:
              type: string
              description: "target keyword\nrequired field if you don’t specify domain\nyou can specify up to 2000 characters in the keyword field\nall %## will be decoded (plus character ‘+’ will be decoded to a space character)\nif you need to use the “%” character for your keyword, please specify it as “%25”;\nif you need to use the “+” character for your keyword, please specify it as “%2B”\nlearn more about rules and limitations of keyword and keywords fields in"
              nullable: true
            match_type:
              type: string
              description: "target keyword match type\ndefines how the specified keyword is matched\noptional field\npossible values:\nword_match – full-text search for terms that match the specified seed keyword with additional words included before, after, or within the key phrase (e.g., search for “light” will return results with “light bulb”, “light switch”);\npartial_match – substring search that finds all instances containing the specified sequence of characters, even if it appears inside a longer word (e.g., search for “light” will return results with “lighting”, “highlight”);\ndefault value: word_match"
              nullable: true
    BaseAiOptimizationLLmMentionsTargetElement:
      type: object
      properties:
        search_scope:
          type: array
          items:
            type: string
            nullable: true
          description: "target domain search scope\noptional field\npossible values:\nany, sources, search_results\ndefault value: any"
          nullable: true
        search_filter:
          type: string
          description: "target domain search filter\noptional field\npossible values:\ninclude, exclude\ndefault value: include"
          nullable: true
      discriminator:
        propertyName: type
        mapping:
          domain: '#/components/schemas/AiOptimizationLLmMentionsDomainElement'
          keyword: '#/components/schemas/AiOptimizationLLmMentionsKeywordElement'
    DataLabsVisualStoriesSerpElementItem:
      type: object
      allOf:
        - type: object
          oneOf:
            - $ref: '#/components/schemas/BaseDataforseoLabsApiElementItem'
          nullable: true
        - type: object
          properties:
            items:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AmazonLabelElement'
                nullable: true
              description: historical SERPs and related data found in the database
              nullable: true
      deprecated: true
    SerpApiStopCrawlOnMatchInfo:
      type: object
      properties:
        match_value:
          type: string
          description: "arget domain or wildcard value\nrequired field if stop_crawl_on_match is specified;\nspecify a target domain or wildcard value;\nNote: domain name must be specified without a request protocol;\nexample: dataforseo.com"
          nullable: true
        match_type:
          type: string
          description: "target match type\nrequired field if stop_crawl_on_match is specified;\ntype of match for the match_value\npossible values: domain, with_subdomains, wildcard"
          nullable: true
    LlmMessageChainItem:
      type: object
      properties:
        role:
          type: string
          description: role of the user from whom the message originates
          nullable: true
        message:
          type: string
          description: message text
          nullable: true
    DemographyComparisonInfo:
      type: object
      properties:
        age:
          type: object
          additionalProperties:
            type: array
            items:
              type: integer
              nullable: true
            nullable: true
          description: type of element
          nullable: true
        gender:
          type: object
          additionalProperties:
            type: array
            items:
              type: integer
              nullable: true
            nullable: true
          description: type of element
          nullable: true
    ResourceMetaInfo:
      type: object
      properties:
        alternative_text:
          type: string
          description: content of the image alt attribute
          nullable: true
        title:
          type: string
          description: title
          nullable: true
        original_width:
          type: number
          description: original image width in px
          format: double
          nullable: true
        original_height:
          type: number
          description: original image height in px
          format: double
          nullable: true
        width:
          type: number
          description: image width in px
          format: double
          nullable: true
        height:
          type: number
          description: image height in px
          format: double
          nullable: true
    VideoElement:
      type: object
      properties:
        type:
          type: string
          description: type of element
          nullable: true
        source:
          type: string
          description: URL to the video source
          nullable: true
        preview:
          type: string
          description: URL to the video preview image
          nullable: true
        title:
          type: string
          description: <em>title of a given link element</em>
          nullable: true
        timestamp:
          type: string
          description: '<em>date and time when the result was published</em><br>in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”<br>example:<br><code class="long-string">2019-11-15 12:57:46 +00:00</code>'
          nullable: true
        url:
          type: string
          description: <em>source URL</em>
          nullable: true
    RefinementChipsInfo:
      type: object
      properties:
        type:
          type: string
          description: type of element
          nullable: true
        xpath:
          type: string
          description: the XPath of the element
          nullable: true
        items:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/RefinementChipsElement'
            nullable: true
          description: items of the element
          nullable: true
    RefinementChipsElement:
      type: object
      properties:
        type:
          type: string
          description: type of element
          nullable: true
        title:
          type: string
          description: title of the element
          nullable: true
        url:
          type: string
          description: search URL with refinement parameters
          nullable: true
        domain:
          type: string
          description: domain in SERP
          nullable: true
        options:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/AmazonLabelElement'
            nullable: true
          description: further search refinement options
          nullable: true
    AmazonLabelElement:
      type: object
      properties:
        type:
          type: string
          description: type of element
          nullable: true
        title:
          type: string
          description: title of the element
          nullable: true
        url:
          type: string
          description: search URL with refinement parameters
          nullable: true
        domain:
          type: string
          description: domain in SERP
          nullable: true
    ReviewResponseItemInfo:
      type: object
      properties:
        title:
          type: string
          description: the title of response
          nullable: true
        text:
          type: string
          description: the content of response
          nullable: true
        timestamp:
          type: string
          description: the time of publication
          nullable: true
    WorkDayInfo:
      type: object
      properties:
        open:
          type: object
          oneOf:
            - $ref: '#/components/schemas/TimeInfo'
          description: opening time
          nullable: true
        close:
          type: object
          oneOf:
            - $ref: '#/components/schemas/TimeInfo'
          description: closing time
          nullable: true
    TimeInfo:
      type: object
      properties:
        hour:
          type: integer
          description: hours in the 24-hour format
          nullable: true
        minute:
          type: integer
          description: minutes
          nullable: true
    PopularWorkTimeInfo:
      type: object
      properties:
        time:
          type: object
          oneOf:
            - $ref: '#/components/schemas/TimeInfo'
          description: hours in the 24-hour format
          nullable: true
        popular_index:
          type: integer
          description: "popularity index\nrelative time-bound popularity index measured from 0 to 100;\nhigher value corresponds to a busier time of a day"
          nullable: true
    AboutThisResultElement:
      type: object
      properties:
        type:
          type: string
          description: type of element
          nullable: true
        url:
          type: string
          description: result’s URL
          nullable: true
        source:
          type: string
          description: source of additional information about the result
          nullable: true
        source_info:
          type: string
          description: "additional information about the result\ndescription of the website from Wikipedia or another additional context"
          nullable: true
        source_url:
          type: string
          description: URL to full information from the 'source'
          nullable: true
        language:
          type: string
          description: the language of the result
          nullable: true
        location:
          type: string
          description: location for which the result is relevant
          nullable: true
        search_terms:
          type: array
          items:
            type: string
            nullable: true
          description: matching search terms that appear in the result
          nullable: true
        related_terms:
          type: array
          items:
            type: string
            nullable: true
          description: related search terms that appear in the result
          nullable: true
      deprecated: true
    DataLabsPodcastsSerpElementItem:
      type: object
      allOf:
        - type: object
          oneOf:
            - $ref: '#/components/schemas/BaseDataforseoLabsApiElementItem'
          nullable: true
        - type: object
          properties:
            items:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/PodcastsElement'
                nullable: true
              description: historical SERPs and related data found in the database
              nullable: true
      deprecated: true
    AiModeRectangleInfo:
      type: object
      properties:
        x:
          type: number
          description: "x-axis coordinate\nx-axis coordinate of the top-left corner of the result’s snippet, where top-left corner of the screen is the origin"
          format: double
          nullable: true
        y:
          type: number
          description: "y-axis coordinate\ny-axis coordinate of the top-left corner of the result’s snippet, where top-left corner of the screen is the origin"
          format: double
          nullable: true
        width:
          type: number
          description: width of the element in pixels
          format: double
          nullable: true
        height:
          type: number
          description: height of the element in pixels
          format: double
          nullable: true
    CrawlStatusInfo:
      type: object
      properties:
        max_crawl_pages:
          type: integer
          description: "maximum number of pages to crawl\n indicates the max_crawl_pages limit you specified when setting a task"
          format: int64
          nullable: true
        pages_in_queue:
          type: integer
          description: number of pages that are currently in the crawling queue
          format: int64
          nullable: true
        pages_crawled:
          type: integer
          description: number of crawled pages
          format: int64
          nullable: true
    RelatedSearchesElement:
      type: object
      properties:
        type:
          type: string
          description: type of element
          nullable: true
        title:
          type: string
          description: product title
          nullable: true
        url:
          type: string
          description: the URL of the product page
          nullable: true
        image_alt:
          type: string
          description: the alt tag of the product image featured in the results
          nullable: true
        image_url:
          type: string
          description: URL of the product image featured in the results
          nullable: true
    LinkElement:
      type: object
      properties:
        type:
          type: string
          description: type of element
          nullable: true
        title:
          type: string
          description: title of a given link element
          nullable: true
        snippet:
          type: string
          description: text alongside the link title
          nullable: true
        description:
          type: string
          description: description of the results element
          nullable: true
        url:
          type: string
          description: URL
          nullable: true
        domain:
          type: string
          description: domain where a link points
          nullable: true
        xpath:
          type: string
          description: the XPath of the element
          nullable: true
    AmazonDeliveryInfo:
      type: object
      properties:
        delivery_message:
          type: string
          description: message accompanying the delivery information as posted by the seller
          nullable: true
        delivery_date_from:
          type: string
          description: the earliest date when the product can be shipped
          nullable: true
        delivery_date_to:
          type: string
          description: the latest date when the product can be delivered
          nullable: true
        fastest_delivery_date_from:
          type: string
          description: the earliest date when the product can be delivered with a fast delivery option
          nullable: true
        fastest_delivery_date_to:
          type: string
          description: the latest date when the product can be delivered with a fast delivery option
          nullable: true
        delivery_price:
          type: object
          oneOf:
            - $ref: '#/components/schemas/PriceInfo'
          description: "price for the delivery\nprice of the delivery based on the location you specified in the POST request;\nif free delivery is available, the value is null"
          nullable: true
    Table:
      type: object
      properties:
        table_element:
          type: string
          description: "name assigned to the table element\npossible values:\ntable_element"
          nullable: true
        table_header:
          type: array
          items:
            type: string
            nullable: true
          description: column names
          nullable: true
        table_content:
          type: array
          items:
            type: array
            items:
              type: string
              nullable: true
            nullable: true
          description: "the content of the table\none line of the table in this element of the array"
          nullable: true
    AmazonKeywordData:
      properties:
        se_type:
          type: string
          description: search engine type
          nullable: true
        keyword:
          type: string
          description: related keyword
          nullable: true
        location_code:
          type: integer
          description: location code in a POST array
          format: int64
          nullable: true
        language_code:
          type: string
          description: language code in a POST array
          nullable: true
        keyword_info:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AmazonKeywordInfo'
          description: keyword info for the returned keyword
          nullable: true
    AmazonKeywordInfo:
      properties:
        se_type:
          type: string
          description: search engine type
          nullable: true
        last_updated_time:
          type: string
          description: "date and time when keyword data was updated\nin the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”\nexample:    '2019-11-15 12:57:46 +00:00'"
          nullable: true
        search_volume:
          type: integer
          description: "average monthly search volume rate\nrepresents the (approximate) number of searches for the provided keyword idea on Amazon"
          format: int64
          nullable: true
    PriceInfo:
      type: object
      properties:
        current:
          type: number
          description: "current price\nindicates the current price of the product or service featured in the result"
          format: double
          nullable: true
        regular:
          type: number
          description: "regular price\nindicates the regular price of the product or service with no discounts applied"
          format: double
          nullable: true
        max_value:
          type: number
          description: "the maximum price\nthe maximum price of the product or service as indicated in the result"
          format: double
          nullable: true
        currency:
          type: string
          description: "currency of the listed price\nISO code of the currency applied to the price"
          nullable: true
        is_price_range:
          type: boolean
          description: "price is provided as a range\nindicates whether a price is provided in a range"
          nullable: true
        displayed_price:
          type: string
          description: "price string in the result\nraw price string as provided in the result"
          nullable: true
    RatingInfo:
      properties:
        rating_type:
          type: string
          description: "the type of rating\nhere you can find the following elements: Max5, Percents, CustomMax"
          nullable: true
        value:
          type: number
          description: the value of the rating
          format: double
          nullable: true
        votes_count:
          type: integer
          description: the amount of feedback
          format: int64
          nullable: true
        rating_max:
          type: integer
          description: the maximum value for a rating_type
          nullable: true
    SocialMetricsInfo:
      properties:
        type:
          type: string
          description: type of element
          nullable: true
        like_count:
          type: integer
          description: likes count
          format: int64
          nullable: true
    DataLabsMentionCarouselSerpElementItem:
      type: object
      allOf:
        - type: object
          oneOf:
            - $ref: '#/components/schemas/BaseDataforseoLabsApiElementItem'
          nullable: true
        - type: object
          properties:
            title:
              type: string
              description: title of the result in SERP
              nullable: true
            items:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/MentionCarouselElement'
                nullable: true
              description: historical SERPs and related data found in the database
              nullable: true
      deprecated: true
    CoursesSerpElementItem:
      type: object
      allOf:
        - type: object
          oneOf:
            - $ref: '#/components/schemas/BaseSerpApiElementItem'
          nullable: true
        - type: object
          properties:
            rank_group:
              type: integer
              description: "group rank in SERP\nposition within a group of elements with identical type values;\npositions of elements with different type values are omitted from rank_group;\nalways equals 0 for desktop"
              nullable: true
            rank_absolute:
              type: integer
              description: "absolute rank in SERP\nabsolute position among all the elements in SERP\nalways equals 0 for desktop"
              nullable: true
            title:
              type: string
              description: title of a given link element
              nullable: true
            categories:
              type: array
              items:
                type: string
                nullable: true
              description: "array of course categories\ncontains a list of categories relevant to courses"
              nullable: true
            items:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/CoursesElement'
                nullable: true
              description: contains arrays of elements available in the list
              nullable: true
      deprecated: true
    TopDomainInfo:
      properties:
        domain:
          type: string
          nullable: true
        count:
          type: integer
          format: int64
          nullable: true
    ContentAnalysisCategoriesInfo:
      properties:
        category:
          type: array
          items:
            type: integer
            nullable: true
          nullable: true
        count:
          type: integer
          format: int64
          nullable: true
    ExploreBrandsSerpElementItem:
      type: object
      allOf:
        - type: object
          oneOf:
            - $ref: '#/components/schemas/BaseSerpApiElementItem'
          nullable: true
        - type: object
          properties:
            rank_group:
              type: integer
              description: "group rank in SERP\nposition within a group of elements with identical type values;\npositions of elements with different type values are omitted from rank_group;\nalways equals 0 for desktop"
              nullable: true
            rank_absolute:
              type: integer
              description: "absolute rank in SERP\nabsolute position among all the elements in SERP\nalways equals 0 for desktop"
              nullable: true
            title:
              type: string
              description: title of a given link element
              nullable: true
            items:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/ExploreBrandsElement'
                nullable: true
              description: contains arrays of elements available in the list
              nullable: true
      deprecated: true
    FoundOnWebSerpElementItem:
      type: object
      allOf:
        - type: object
          oneOf:
            - $ref: '#/components/schemas/BaseSerpApiElementItem'
          nullable: true
        - type: object
          properties:
            rank_group:
              type: integer
              description: "group rank in SERP\nposition within a group of elements with identical type values;\npositions of elements with different type values are omitted from rank_group;\nalways equals 0 for desktop"
              nullable: true
            rank_absolute:
              type: integer
              description: "absolute rank in SERP\nabsolute position among all the elements in SERP\nalways equals 0 for desktop"
              nullable: true
            title:
              type: string
              description: title of a given link element
              nullable: true
            related_searches:
              type: array
              items:
                type: string
                nullable: true
              description: search queries related to the elment
              nullable: true
            items:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/FoundOnWebElement'
                nullable: true
              description: contains arrays of elements available in the list
              nullable: true
      deprecated: true
    SpellInfo:
      properties:
        keyword:
          type: string
          description: "keyword obtained as a result of search engine autocorrection\n the results will be provided for the corrected keyword"
          nullable: true
        type:
          type: string
          description: "type of autocorrection\n possible values:\n did_you_mean, showing_results_for, no_results_found_for, including_results_for\n note: Yahoo and Yandex support only the following autocorrection type:\n including_results_for"
          nullable: true
    TechnologiesInfo:
      type: object
      properties:
        add_ons:
          type: object
          additionalProperties:
            type: array
            items:
              type: string
              nullable: true
            nullable: true
          nullable: true
        analytics:
          type: object
          additionalProperties:
            type: array
            items:
              type: string
              nullable: true
            nullable: true
          nullable: true
        web_development:
          type: object
          additionalProperties:
            type: array
            items:
              type: string
              nullable: true
            nullable: true
          nullable: true
        security:
          type: object
          additionalProperties:
            type: array
            items:
              type: string
              nullable: true
            nullable: true
          nullable: true
        business_tools:
          type: object
          additionalProperties:
            type: array
            items:
              type: string
              nullable: true
            nullable: true
          nullable: true
        sales:
          type: object
          additionalProperties:
            type: array
            items:
              type: string
              nullable: true
            nullable: true
          nullable: true
        other:
          type: object
          additionalProperties:
            type: array
            items:
              type: string
              nullable: true
            nullable: true
          nullable: true
        user_generated_content:
          type: object
          additionalProperties:
            type: array
            items:
              type: string
              nullable: true
            nullable: true
          nullable: true
        booking:
          type: object
          additionalProperties:
            type: array
            items:
              type: string
              nullable: true
            nullable: true
          nullable: true
        privacy:
          type: object
          additionalProperties:
            type: array
            items:
              type: string
              nullable: true
            nullable: true
          nullable: true
        servers:
          type: object
          additionalProperties:
            type: array
            items:
              type: string
              nullable: true
            nullable: true
          nullable: true
        location:
          type: object
          additionalProperties:
            type: array
            items:
              type: string
              nullable: true
            nullable: true
          nullable: true
        content:
          type: object
          additionalProperties:
            type: array
            items:
              type: string
              nullable: true
            nullable: true
          nullable: true
        media:
          type: object
          additionalProperties:
            type: array
            items:
              type: string
              nullable: true
            nullable: true
          nullable: true
        marketing:
          type: object
          additionalProperties:
            type: array
            items:
              type: string
              nullable: true
            nullable: true
          nullable: true
        communication:
          type: object
          additionalProperties:
            type: array
            items:
              type: string
              nullable: true
            nullable: true
          nullable: true
        utilities:
          type: object
          additionalProperties:
            type: array
            items:
              type: string
              nullable: true
            nullable: true
          nullable: true
    AuthorsElement:
      type: object
      properties:
        type:
          type: string
          description: type of element
          nullable: true
        name:
          type: string
          description: name of the dataset author
          nullable: true
        url:
          type: string
          description: author’s link URL
          nullable: true
        domain:
          type: string
          description: author’s link domain
          nullable: true
    MessageInfo:
      type: object
      properties:
        level:
          type: string
          description: "level of error\ncan take the following values: fatal, error, warning, info"
          nullable: true
        message:
          type: string
          description: "message associated with an error\nmessage providing the details of the detected error"
          nullable: true
    ClickstreamKeywordInfo:
      type: object
      properties:
        search_volume:
          type: integer
          description: <em>average monthly search volume rate</em><br>represents the (approximate) number of searches for the given keyword idea on google.com
          format: int64
          nullable: true
        last_updated_time:
          type: string
          description: '<em>date and time when keyword data was updated</em><br>in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”<br>example:<br><code class="long-string">2019-11-15 12:57:46 +00:00</code>'
          nullable: true
        gender_distribution:
          type: object
          additionalProperties:
            type: integer
            format: int64
            nullable: true
          description: <em>distribution of estimated clickstream-based metrics by gender</em><br>learn more about how the metric is calculated in this <a href="https://dataforseo.com/help-center/what-are-clickstream-based-metrics-and-how-do-we-calculate-them" rel="noopener noreferrer" target="_blank">help center article</a>
          nullable: true
        age_distribution:
          type: object
          additionalProperties:
            type: integer
            format: int64
            nullable: true
          description: <em>distribution of clickstream-based metrics by age</em><br>learn more about how the metric is calculated in this <a href="https://dataforseo.com/help-center/what-are-clickstream-based-metrics-and-how-do-we-calculate-them" rel="noopener noreferrer" target="_blank">help center article</a>
          nullable: true
        monthly_searches:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/MonthlySearchesInfo'
            nullable: true
          description: '<em>monthly searches</em><br>represents the (approximate) number of searches on this keyword idea (as available for the past twelve months), targeted to the specified geographic locations'
          nullable: true
    BaseLocalBusinessLink:
      type: object
      properties:
        type:
          type: string
          description: type of element
          nullable: true
      additionalProperties: false
      discriminator:
        propertyName: type
        mapping:
          reservation: '#/components/schemas/LocalBusinessReservationLink'
          order: '#/components/schemas/LocalBusinessOrderLink'
          menu: '#/components/schemas/LocalBusinessMenuLink'
    LocalBusinessReservationLink:
      allOf:
        - $ref: '#/components/schemas/BaseLocalBusinessLink'
        - properties:
            title:
              type: string
              description: "title of the element\ndomain of the reservation software"
              nullable: true
            url:
              type: string
              description: URL to make a reservation
              nullable: true
    LocalBusinessOrderLink:
      allOf:
        - $ref: '#/components/schemas/BaseLocalBusinessLink'
        - properties:
            delivery_services:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/LocalBusinessDeliveryServiceInfo'
                nullable: true
              description: lists available delivery services
              nullable: true
    LocalBusinessDeliveryServiceInfo:
      properties:
        type:
          type: string
          description: type of element
          nullable: true
        title:
          type: string
          description: "title of the element\ndomain of the online food ordering system"
          nullable: true
        url:
          type: string
          description: URL to place an order
          nullable: true
    LocalBusinessMenuLink:
      allOf:
        - $ref: '#/components/schemas/BaseLocalBusinessLink'
        - properties:
            title:
              type: string
              description: "title of the element\ndomain of the online menu system"
              nullable: true
            url:
              type: string
              description: URL to view the menu
              nullable: true
    BaseResponseInfo:
      properties:
        version:
          type: string
          description: the current version of the API
          nullable: true
        status_code:
          type: integer
          description: "general status code\nyou can find the full list of the response codes here"
          nullable: true
        status_message:
          type: string
          description: "general informational message\nyou can find the full list of general informational messages here"
          nullable: true
        time:
          type: string
          description: 'total execution time, seconds'
          nullable: true
        cost:
          type: number
          description: 'total tasks cost, USD'
          format: double
          nullable: true
        tasks_count:
          type: integer
          description: the number of tasks in the tasks array
          format: int64
          nullable: true
        tasks_error:
          type: integer
          description: the number of tasks in the tasks array returned with an error
          format: int64
          nullable: true
    BaseResponseTaskInfo:
      properties:
        id:
          type: string
          description: "task identifier\nunique task identifier in our system in the UUID format"
          nullable: true
        status_code:
          type: integer
          description: "status code of the task\ngenerated by DataForSEO, can be within the following range: 10000-60000\nyou can find the full list of the response codes here"
          nullable: true
        status_message:
          type: string
          description: "informational message of the task\nyou can find the full list of general informational messages here"
          nullable: true
        time:
          type: string
          description: 'execution time, seconds'
          nullable: true
        cost:
          type: number
          description: 'total tasks cost, USD'
          format: double
          nullable: true
        result_count:
          type: integer
          description: number of elements in the result array
          format: int64
          nullable: true
        path:
          type: array
          items:
            type: string
            nullable: true
          description: URL path
          nullable: true
        data:
          type: object
          additionalProperties:
            type: object
            nullable: true
          description: contains the same parameters that you specified in the POST request
          nullable: true
    SectionContentItemInfo:
      type: object
      properties:
        text:
          type: string
          description: "secondary content on the page\nyou can find more information about content priority calculation in this help center article"
          nullable: true
        url:
          type: string
          description: "page URL.\ndisplayed in case the text is a link anchor"
          nullable: true
        urls:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/ContentUrlInfo'
            nullable: true
          description: contains other URLs and anchors found in the content element
          nullable: true
    KeywordInfoNormalizedWithInfo:
      type: object
      properties:
        last_updated_time:
          type: string
          description: "date and time when the dataset was updated\nin the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”\nexample:\n2019-11-15 12:57:46 +00:00"
          nullable: true
        search_volume:
          type: integer
          description: current search volume rate of a keyword
          nullable: true
        is_normalized:
          type: boolean
          description: "keyword info is normalized\nif true, values are normalized with Bing data"
          nullable: true
        monthly_searches:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/MonthlySearchesInfo'
            nullable: true
          description: "monthly search volume rates\narray of objects with search volume rates in a certain month of a year"
          nullable: true
    VisualStoriesSerpElementItem:
      type: object
      allOf:
        - type: object
          oneOf:
            - $ref: '#/components/schemas/BaseSerpApiElementItem'
          nullable: true
        - type: object
          properties:
            rank_group:
              type: integer
              description: "group rank in SERP\nposition within a group of elements with identical type values;\npositions of elements with different type values are omitted from rank_group;\nalways equals 0 for desktop"
              nullable: true
            rank_absolute:
              type: integer
              description: "absolute rank in SERP\nabsolute position among all the elements in SERP\nalways equals 0 for desktop"
              nullable: true
            items:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AmazonLabelElement'
                nullable: true
              description: contains arrays of elements available in the list
              nullable: true
      deprecated: true
    MonthlySearchesInfo:
      type: object
      properties:
        year:
          type: integer
          description: year
          nullable: true
        month:
          type: integer
          description: month
          nullable: true
        search_volume:
          type: integer
          description: monthly average search volume rate
          nullable: true
    ContentUrlInfo:
      type: object
      properties:
        url:
          type: string
          description: contains other URLs and anchors found in the content element
          nullable: true
        anchor_text:
          type: string
          description: text of the URL’s anchor
          nullable: true
    TableContentInfo:
      type: object
      properties:
        header:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/TableContentItemInfo'
            nullable: true
          description: parsed content of the header
          nullable: true
        body:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/TableContentItemInfo'
            nullable: true
          description: content of the body of the table
          nullable: true
        footer:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/TableContentItemInfo'
            nullable: true
          description: content of the footer of the table
          nullable: true
    TableContentItemInfo:
      type: object
      properties:
        row_cells:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/RowCellInfo'
            nullable: true
          description: content of the row cells of the header
          nullable: true
    RowCellInfo:
      type: object
      properties:
        text:
          type: string
          description: content of the row cells of the header
          nullable: true
        urls:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/ContentUrlInfo'
            nullable: true
          description: contains other URLs and anchors found in the content element
          nullable: true
        is_header:
          type: boolean
          description: content of the row cells of the header
          nullable: true
    ContententRatingInfo:
      type: object
      properties:
        name:
          type: string
          description: "rating name\nhere you can find the following elements: Max5, Percents, CustomMax"
          nullable: true
        rating_value:
          type: number
          description: the value of the rating
          format: double
          nullable: true
        rating_count:
          type: integer
          description: number of votes
          format: int64
          nullable: true
        max_rating_value:
          type: number
          description: maximum value for the rating name
          format: double
          nullable: true
        relative_rating:
          type: number
          description: relative rating
          format: double
          nullable: true
    ContentOfferInfo:
      type: object
      properties:
        name:
          type: string
          description: name of the product
          nullable: true
        price:
          type: number
          description: price of the product
          format: double
          nullable: true
        price_currency:
          type: string
          description: price currency
          nullable: true
        price_valid_until:
          type: string
          description: "displays the date and time until which the price is valid\nin the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”\nexample: \"2022-11-01 10:02:52 +00:00\""
          nullable: true
    ContentCommentInfo:
      type: object
      properties:
        rating:
          type: object
          oneOf:
            - $ref: '#/components/schemas/ContententRatingInfo'
          description: "product’s rating\ncontains information about the rating a customer has given to the product"
          nullable: true
        title:
          type: string
          description: title of the customer’s comment
          nullable: true
        publish_date:
          type: string
          description: date when the comment was published
          nullable: true
        author:
          type: string
          description: author of the comment
          nullable: true
        have_form:
          type: boolean
          description: ''
          nullable: true
        primary_content:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/SectionContentItemInfo'
            nullable: true
          description: "primary content on the page\nyou can find more information about content priority calculation in this help center article"
          nullable: true
    SerpIdListRequestInfo:
      type: object
      properties:
        datetime_from:
          type: string
          description: '<em>start time for filtering results</em><br><strong>required field</strong><br>if <code>include_metadata</code> is set to <code>true</code>, minimum start value: a month from current datetime;<br>if <code>include_metadata</code> is set to <code>false</code>, minimum start value: six months from current datetime;<br>maximum start value: current <code>datetime</code>;<br>must be specified in the UTC format: "yyyy-mm-dd hh-mm-ss +00:00";<br>example:<br><code>2023-01-15 12:57:46 +00:00</code>'
        datetime_to:
          type: string
          description: '<em>finish time for filtering results</em><br><strong>required field</strong><br>if <code>include_metadata</code> is set to <code>true</code>, minimum finish value: a month from current datetime;<br>if <code>include_metadata</code> is set to <code>false</code>, minimum finish value: six months from current datetime;<br>maximum finish value: current <code>datetime</code>;<br><strong>Note:</strong> <code>datetime_to</code> must be greater than <code>datetime_from</code>;<br>must be specified in the UTC format: "yyyy-mm-dd hh-mm-ss +00:00";<br>example:<br><code>2023-01-31 13:57:46 +00:00</code>'
        limit:
          type: integer
          description: '<em>the maximum number of returned task IDs</em><br>optional field<br>default value: <code>1000</code><br>maximum value: <code>1000</code><br>minimum value: <code>1</code>'
          nullable: true
        offset:
          type: integer
          description: '<em>offset in the results array of returned task IDs</em><br>optional field<br>if you specify the <code>10</code> value, the first ten tasks in the results array will be omitted;<br>minimum and default value: <code>0</code>;<br>maximum value: <code>100M</code> (100 million)'
          nullable: true
        sort:
          type: string
          description: '<em>sorting by task execution time</em><br>optional field<br>possible values: <code>"asc"</code>, <code>"desc"</code><br>default value: <code>"asc"</code>'
          nullable: true
        include_metadata:
          type: boolean
          description: '<em>include task metadata in the response</em><br>optional field<br>if set to <code>true</code>, the <code>metadata</code> object containing parameters specified in the POST request will be provided in the response;<br>default value: <code>false</code>'
          nullable: true
      example:
        - datetime_from: '2026-09-10 11:12:35'
          datetime_to: '2026-09-20 11:12:35'
          limit: 10
          include_metadata: true
    SerpIdListResultInfo:
      type: object
      properties:
        id:
          type: string
          description: <em>task identifier</em><br><strong>unique task identifier in our system in the <a href="https://en.wikipedia.org/wiki/Universally_unique_identifier" target="_blank">UUID</a> format</strong>
          nullable: true
        url:
          type: string
          description: <em>URL of the task</em><br>URL you used for making an API call
          nullable: true
        datetime_posted:
          type: string
          description: '<em>date and time when the task was made</em><br>in the UTC format: "yyyy-mm-dd hh-mm-ss +00:00"<br>example:<br><code>2023-01-15 12:57:46 +00:00</code>'
          nullable: true
        datetime_done:
          type: string
          description: '<em>date and time when the task was completed</em><br>in the UTC format: "yyyy-mm-dd hh-mm-ss +00:00"<br>example:<br><code>2023-01-15 12:57:46 +00:00</code>'
          nullable: true
        status:
          type: string
          description: <em>informational message of the task</em><br>you can find the full list of general informational messages <a href="/v3/appendix-errors/">here</a>
          nullable: true
        cost:
          type: number
          description: '<em>total tasks cost, USD</em>'
          nullable: true
        metadata:
          type: object
          additionalProperties:
            type: object
            nullable: true
          description: <em>contains parameters you specified in the POST request</em>
          nullable: true
    SerpIdListTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpIdListResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    SerpIdListResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpIdListTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    SerpErrorsRequestInfo:
      type: object
      properties:
        limit:
          type: integer
          description: '<em>the maximum number of returned tasks that responded with an error</em><br>optional field<br>default value: <code>1000</code><br>maximum value: <code>1000</code><br>minimum value: <code>1</code>'
          nullable: true
        offset:
          type: integer
          description: '<em>offset in the results array of returned tasks</em><br>optional field<br>if you specify the <code>10</code> value, the first ten tasks in the results array will be omitted and the data will be provided for the successive tasks<br>default and minimum value: <code>0</code><br>maximum value: <code>100M</code> (100 million)'
          nullable: true
        filtered_function:
          type: string
          description: '<em>return tasks with a certain function</em><br>use this field to obtain a list of tasks that returned an error filtered by the certain endpoint''s URL, as well as <code>pingback_url</code> or <code>postback_url</code> specified in the API request;<br>you can filter the results by the values you receive in the <code>function</code> fields of the API response;<br>i.e., once you receive unfiltered results, you can call this API again to filter them by <code>function</code>; <br>example: <code>serp/task_get/advanced</code>'
          nullable: true
        datetime_from:
          type: string
          description: '<em>start time for filtering results</em><br>optional field<br>allows filtering results by the <code>datetime</code> parameter within the range of the last 7 days;<br>must be specified in the UTC format: <code>"yyyy-mm-dd hh-mm-ss +00:00"</code>;<br>minimum value: 7 days from the current <code>datetime</code><br>maximum value: current <code>datetime</code><br>example:<br><code>2021-11-15 12:57:46 +00:00</code>'
          nullable: true
        datetime_to:
          type: string
          description: '<em>finish time for filtering results</em><br>optional field<br>allows filtering results by the <code>datetime</code> parameter within the range of the last 7 days;<br>must be specified in the UTC format: "yyyy-mm-dd hh-mm-ss +00:00"<br>minimum value: 7 days from the current <code>datetime</code><br>maximum value: current <code>datetime</code><br><strong>Note</strong> <code>datetime_to</code> must be greater than <code>datetime_from</code> if both parameters are used;<br>example:<br><code>2021-11-15 13:57:46 +00:00</code>'
          nullable: true
      example:
        - limit: 10
          offset: 0
          filtered_function: pingback_url
    SerpErrorsResultInfo:
      type: object
      properties:
        id:
          type: string
          description: <em>task identifier</em><br><strong>unique task identifier in our system in the <a href="https://en.wikipedia.org/wiki/Universally_unique_identifier">UUID</a> format</strong>
          nullable: true
        datetime:
          type: string
          description: '<em>date and time when an error occurred</em><br>in the UTC format: "yyyy-mm-dd hh-mm-ss +00:00"<br>example:<br><code>2019-11-15 12:57:46 +00:00</code>'
          nullable: true
        function:
          type: string
          description: <em>corresponding API function</em>
          nullable: true
        error_code:
          type: integer
          description: <em>error code of the task</em><br>error code of the task generated by DataForSEO<br><a href="https://docs.dataforseo.com/v3/appendix/errors/" rel="noopener noreferrer" target="_blank">see full list of error codes</a>
          nullable: true
        error_message:
          type: string
          description: '<em>error message or error URL</em><br>error message generated by DataForSEO, or URL that caused an error<br><a href="https://docs.dataforseo.com/v3/appendix/errors/" rel="noopener noreferrer" target="_blank">see full list of error messages</a>'
          nullable: true
        http_url:
          type: string
          description: <em>URL that caused an error</em><br>URL you used for making an API call or pingback/postback URL
          nullable: true
        http_method:
          type: string
          description: <em>HTTP method that caused an error</em>
          nullable: true
        http_code:
          type: integer
          description: <em>HTTP status code</em>
          nullable: true
        http_time:
          type: number
          description: '<em>time taken by HTTP request</em><br>for tasks set with a pingback/postback, this field will show the time it took your server to respond'
          nullable: true
        http_response:
          type: string
          description: <em>HTTP response</em><br>server response
          nullable: true
    SerpErrorsTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpErrorsResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    SerpErrorsResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpErrorsTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    SerpScreenshotRequestInfo:
      type: object
      properties:
        task_id:
          type: string
          description: <em>task identifier</em><br><strong>required field</strong><br>unique identifier of the associated task in the <a href="https://en.wikipedia.org/wiki/Universally_unique_identifier">UUID</a> format<br>you will be able to use it within <strong>7 days</strong> to request the results of the task at any time
        browser_preset:
          type: string
          description: '<em>browser resolution preset</em><br>optional field<br>browser preset associated with a certain device type<br>can take the following values: <code>desktop</code>, <code>tablet</code>, <code>mobile</code> <br><strong>Note:</strong> by default, browser preset corresponds to the device type specified in the POST request'
          nullable: true
        browser_screen_width:
          type: integer
          description: '<em>width of the browser resolution</em><br>optional field<br>can be specified in the following range: <code>240-9999</code><br>default value for <code>desktop</code>: 1920<br>default value for <code>mobile</code>: 390<br>default value for <code>table</code>: 1024'
          format: int64
          nullable: true
        browser_screen_height:
          type: integer
          description: '<em>height of the browser resolution</em><br>optional field<br>can be specified in the following range: <code>240-9999</code><br>default value for <code>desktop</code>: 1080<br>default value for <code>mobile</code>: 844<br>default value for <code>table</code>: 1366'
          nullable: true
        browser_screen_scale_factor:
          type: number
          description: '<em>browser scale factor</em><br>optional field<br>can be specified in the following range: <code>0.5-3</code><br>default value for <code>desktop</code>: 1<br>default value for <code>mobile</code>: 3<br>default value for <code>table</code>: 2'
          nullable: true
        page:
          type: integer
          description: '<em>number of SERP pages</em><br>optional field<br>if <code>depth</code> in the corresponding Task POST request exceeds 10 results (or 1 SERP page), specify the number of SERP pages to screenshot;<br>default value: <code>1</code>'
          nullable: true
      example:
        - task_id: 06211235-0696-0139-1000-36727fbd3c90
          browser_screen_scale_factor: 0.5
    ScreenshotItem:
      type: object
      properties:
        image:
          type: string
          description: '<em>screenshot of the requested page</em><br>URL of the page screenshot on the DataForSEO storage<br><strong>note: the page screenshot saved on the DataForSEO storage only remains accessible for one day after making the request</strong>'
          nullable: true
    SerpScreenshotResultInfo:
      type: object
      properties:
        items_count:
          type: integer
          description: <em>number of items in the results array</em>
          format: int64
          nullable: true
        items:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/ScreenshotItem'
            nullable: true
          description: <em>items array</em>
          nullable: true
    SerpScreenshotTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpScreenshotResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    SerpScreenshotResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpScreenshotTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    SerpAiSummaryRequestInfo:
      type: object
      properties:
        task_id:
          type: string
          description: <em>task identifier</em><br><strong>required field</strong><br>unique identifier of the associated task in the <a href="https://en.wikipedia.org/wiki/Universally_unique_identifier">UUID</a> format<br>you will be able to use it within <strong>30 days</strong> to request the results of the task at any time
        prompt:
          type: string
          description: '<em>AI prompt</em><br>optional field<br>additional task for AI summariser;<br>any form of text, question or information that communicates to AI what response you''re looking for;<br>max number of symbols or characters you can specify: <code>2000</code>;<br><strong>note:</strong> your prompt has to be relevant to the keyword specified in the POST request to SERP API'
          nullable: true
        support_extra:
          type: boolean
          description: '<em>support extra SERP features</em><br>optional field<br>if set to <code>true</code>, the AI model will consider the following extra SERP features, in addition to <code>organic</code> results: <code>answer_box</code>, <code>knowledge_graph</code>, <code>featured_snippet</code>;<br>default value: <code>true</code>'
          nullable: true
        fetch_content:
          type: boolean
          description: '<em>fetch content from pages in SERPs</em><br>optional field<br>if set to <code>true</code>, the API will fetch the content from pages featured in SERP results, and the AI model will consider this content when generating the summary in the result;<br>default value: <code>false</code>'
          nullable: true
        include_links:
          type: boolean
          description: '<em>include source links in the summary</em><br>optional field<br>if set to <code>true</code>, the <code>summary</code> field in the API response will contain links to sources of the generated summary;<br>default value: <code>false</code>'
          nullable: true
      example:
        - task_id: 07031739-1535-0139-0000-9d1e639a5b7d
          prompt: explain what DataForSEO is
          include_links: true
          fetch_content: true
    SerpAiSummaryItem:
      type: object
      properties:
        summary:
          type: string
          description: <em>generated summary</em><br>summary generated by the AI model according to the parameters specified in the request
          nullable: true
    SerpAiSummaryResultInfo:
      type: object
      properties:
        items_count:
          type: integer
          description: <em>number of items in the results array</em>
          format: int64
          nullable: true
        items:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/SerpAiSummaryItem'
            nullable: true
          description: <em>items array</em>
          nullable: true
    SerpAiSummaryTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpAiSummaryResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    SerpAiSummaryResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpAiSummaryTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    SerpGoogleLocationsResultInfo:
      type: object
      properties:
        location_code:
          type: integer
          description: <em>location code</em>
          nullable: true
        location_name:
          type: string
          description: <em>full name of the location</em>
          nullable: true
        location_code_parent:
          type: integer
          description: '<em>the code of the superordinate location</em><br>example:<br>`"location_code": 9041134`,<br>`"location_name": "Vienna International Airport,Lower Austria,Austria"`,<br>`"location_code_parent": 20044`<p>where `location_code_parent` corresponds to:<p>`"location_code": 20044`,<br>`"location_name": "Lower Austria,Austria"`'
          nullable: true
        country_iso_code:
          type: string
          description: <em>ISO country code of the location</em>
          nullable: true
        location_type:
          type: string
          description: '<em>location type</em><br>indicates the geographic classification of the location<br>example:<br>`"location_type": "Country"`, or `"location_type": "State"`'
          nullable: true
    SerpGoogleLocationsTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleLocationsResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    SerpGoogleLocationsResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleLocationsTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    SerpGoogleLocationsCountryResultInfo:
      type: object
      properties:
        location_code:
          type: integer
          description: <em>location code</em>
          nullable: true
        location_name:
          type: string
          description: <em>full name of the location</em>
          nullable: true
        location_code_parent:
          type: integer
          description: '<em>the code of the superordinate location</em><br>example:<br>`"location_code": 9041134`,<br>`"location_name": "Vienna International Airport,Lower Austria,Austria"`,<br>`"location_code_parent": 20044`<p>where `location_code_parent` corresponds to:<p>`"location_code": 20044`,<br>`"location_name": "Lower Austria,Austria"`'
          nullable: true
        country_iso_code:
          type: string
          description: <em>ISO country code of the location</em>
          nullable: true
        location_type:
          type: string
          description: '<em>location type</em><br>indicates the geographic classification of the location<br>example:<br>`"location_type": "Country"`, or `"location_type": "State"`'
          nullable: true
    SerpGoogleLocationsCountryTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleLocationsCountryResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    SerpGoogleLocationsCountryResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleLocationsCountryTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    SerpGoogleLanguagesResultInfo:
      type: object
      properties:
        language_name:
          type: string
          description: <em>language name</em>
          nullable: true
        language_code:
          type: string
          description: <em>language code according to <a href="https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes" target="_blank" rel="noopener noreferrer">ISO 639-1</a></em>
          nullable: true
    SerpGoogleLanguagesTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleLanguagesResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    SerpGoogleLanguagesResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleLanguagesTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    SerpGoogleOrganicTaskPostRequestInfo:
      type: object
      properties:
        keyword:
          type: string
          description: '<p><em>keyword</em><p><strong>required field</strong><p>you can specify <strong>up to 700 characters</strong> in the <code>keyword</code> field<p>all %## will be decoded (plus character ‘+’ will be decoded to a space character)<p>if you need to use the “%” character for your <code>keyword</code>, please specify it as “%25”;<p>if you need to use the “+” character for your <code>keyword</code>, please specify it as “%2B”;<p>if this field contains such parameters as <em>‘allinanchor:’, ‘allintext:’, ‘allintitle:’, ‘allinurl:’, ‘cache:’, ‘define:’, ‘filetype:’, ‘id:’, ‘inanchor:’, ‘info:’, ‘intext:’, ‘intitle:’, ‘inurl:’, ‘link:’, ‘site:’, <strong>the charge per task will be multiplied by 5</strong></em><br><p>learn more about rules and limitations of <code>keyword</code> and <code>keywords</code> fields in DataForSEO APIs in this <a href="https://dataforseo.com/help-center/rules-and-limitations-of-keyword-and-keywords-fields-in-dataforseo-apis" rel="noopener noreferrer" target="_blank">Help Center article</a></p>'
        location_code:
          type: integer
          description: '<p><em>search engine location code</em><p><strong>required field if you don''t specify</strong> <code>location_name</code>&nbsp;or <code>location_coordinate</code><p><strong>if you use this field, you don''t need to specify <code>location_name</code> or <code>location_coordinate</code></strong><p>you can receive the list of available locations of the search engines with their <code>location_code</code> by making a separate request to the <code>https://api.dataforseo.com/v3/serp/google/locations</code><p>example:<p><code class="long-string">2840</code></p>'
        language_code:
          type: string
          description: '<p><em>search engine language code</em><p><strong>required field if you don''t specify</strong> <code>language_name</code><p><strong>if you use this field, you don''t need to specify <code>language_name</code></strong><p>you can receive the list of available languages of the search engine with their <code>language_code</code>&nbsp;by making a separate request to the <code>https://api.dataforseo.com/v3/serp/google/languages</code><em><p></em>example:<em><p></em><code class="long-string">en</code></p>'
        depth:
          type: integer
          description: '<p><em>parsing depth</em><p>optional field<p>number of results in SERP<p><strong>default value: <code>10</code></strong><p>max value: <code>700</code></p><br><strong>Your account will be billed per each SERP containing up to 10 results;</strong><p>Setting depth above 10 may result in additional charges <a href="https://dataforseo.com/help-center/how-many-results-scraped" rel="noopener noreferrer" target="_blank">if the search engine returns more than 10 results</a>;<p>The cost can be calculated on the <a title="Pricing" href="https://dataforseo.com/pricing/serp/google-organic-serp-api" target="_blank" rel="noopener noreferrer">Pricing</a> page.'
          nullable: true
        device:
          type: string
          description: '<p><em>device type</em><p>optional field<p>return results for a specific device type<p>can take the values:<code>desktop</code>, <code>mobile</code><p>default value: <code>desktop</code></p>'
          nullable: true
        load_async_ai_overview:
          type: boolean
          description: '<p><em>load asynchronous ai overview</em><p>optional field<p>set to <code>true</code> to obtain <code>ai_overview</code> items is SERPs even if they are loaded asynchronously;<p>if set to <code>false</code>, you will only obtain <code>ai_overview</code> items from cache;<p>default value: <code>false</code><p><strong>Note:</strong> you will be charged extra $0.0006 for using this parameter;<p>if the element is absent or contains <code>"asynchronous_ai_overview": false</code>, all extra charges will be returned to your account balance</p>'
          nullable: true
        pingback_url:
          type: string
          description: '<p><em>notification URL of a completed task</em><p>optional field<p>when a task is completed we will notify you by GET request sent to the URL you have specified<p>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<p>example:<p><code>http://your-server.com/pingscript?id=$id</code><p><code>http://your-server.com/pingscript?id=$id&amp;tag=$tag</code><p><strong>Note:</strong> special characters in <code>pingback_url</code> will be urlencoded;<p>i.a., the <code>#</code> character will be encoded into <code>%23</code></p><br><p>learn more on our <a href="https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api" target="_blank" rel="noopener noreferrer">Help Center</a></p>'
          nullable: true
        postback_url:
          type: string
          description: '<p><em>URL for sending task results</em><p>optional field<p>once the task is completed, we will send a POST request with its results compressed in the <code>gzip</code> format to the <code>postback_url</code> you specified<p>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request<p>example:<p><code>http://your-server.com/postbackscript?id=$id</code><p><code>http://your-server.com/postbackscript?id=$id&amp;tag=$tag</code><p><strong>Note:</strong> special characters in <code>postback_url</code> will be urlencoded;<p>i.a., the <code>#</code> character will be encoded into <code>%23</code></p><br><p>learn more on our <a href="https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api" target="_blank" rel="noopener noreferrer">Help Center</a></p>'
          nullable: true
        postback_data:
          type: string
          description: '<p><em>postback_url datatype</em><p><strong>required field if you specify <code>postback_url</code></strong><p>corresponds to the datatype that will be sent to your server<p>possible values:<p><code>regular</code>, <code>advanced</code>, <code>html</code></p>'
        priority:
          type: integer
          description: <p><em>task priority</em><p>optional field<p>can take the following values:<p>1 – normal execution priority (set by default);<p>2 – high execution priority</p><br>You will be additionally charged for the tasks with high execution priority.<p>The cost can be calculated on the <a title="Pricing" href="https://dataforseo.com/pricing/serp/google-organic-serp-api" target="_blank" rel="noopener noreferrer">Pricing</a> page.
          nullable: true
        location_name:
          type: string
          description: '<p><em>full name of search engine location</em><p><strong>required field if you don''t specify</strong> <code>location_code</code> or <code>location_coordinate</code><p><strong>if you use this field, you don''t need to specify <code>location_code</code> or <code>location_coordinate</code></strong><p>you can receive the list of available locations of the search engine with their <code>location_name</code> by making a separate request to the <code>https://api.dataforseo.com/v3/serp/google/locations</code><p>example:<p><code class="long-string">London,England,United Kingdom</code></p>'
        location_coordinate:
          type: string
          description: '<p><em>GPS coordinates of a location</em><p><strong>required field if you don''t specify</strong> <code>location_name</code>&nbsp;or <code>location_code</code><p><strong>if you use this field, you don''t need to specify <code>location_name</code> or <code>location_code</code></strong><p><code>location_coordinate</code> parameter should be specified in the <em>"latitude,longitude,radius"</em> format<p>the maximum number of decimal digits for <em>"latitude"</em> and <em>"longitude"</em>: 7<p>the minimum value for <em>"radius"</em>: 199 (mm)<p>the maximum value for <em>"radius"</em>: 199999 (mm)<p>example:<p><code class="long-string">53.476225,-2.243572,200</code></p>'
        language_name:
          type: string
          description: '<p><em>full name of search engine language</em><p><strong>required field if you don''t specify</strong> <code>language_code</code><p><strong>if you use this field, you don''t need to specify <code>language_code</code></strong><p>you can receive the list of available languages of the search engine with their <code>language_name</code> by making a separate request to the <code>https://api.dataforseo.com/v3/serp/google/languages</code><p>example:<p><code class="long-string">English</code></p>'
        tag:
          type: string
          description: <p><em>user-defined task identifier</em><p>optional field<p><em>the character limit is 255</em><p>you can use this parameter to identify the task and match it with the result<p>you will find the specified <code>tag</code> value in the <code>data</code> object of the response</p>
          nullable: true
        os:
          type: string
          description: '<p><em>device operating system</em><p>optional field<p>if you specify <code>desktop</code> in the <code>device</code> field, choose from the following values: <code>windows</code>, <code>macos</code><p>default value: <code>windows</code><p>if you specify <code>mobile</code> in the <code>device</code> field, choose from the following values: <code>android</code>, <code>ios</code><p>default value: <code>android</code></p>'
          nullable: true
        stop_crawl_on_match:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/SerpApiStopCrawlOnMatchInfo'
            nullable: true
          description: "array of targets to stop crawling\noptional field\nif specified, the response will contain SERP results up to and including the specified match_value;\nyou can specify up to 10 target values in this array\nexample:\n\"stop_crawl_on_match\":[{\"match_value\":\"dataforseo.com\",\"match_type\":\"with_subdomains\"}]\nlearn more about this parameter on our Help Center - https://dataforseo.com/help-center/using-the-stop_crawl_on_match-parameter-in-serp-api\nYour account will be billed per each SERP crawled through the specified targets"
          nullable: true
        match_type:
          type: string
          description: <p><em>target match type</em><p><strong>required field if <code>stop_crawl_on_match</code> is specified</strong><p>type of match for the <code>match_value</code><p>possible values:<p><code>domain</code> – specific domain or subdomain<p><code>with_subdomains</code> – main domain and subdomains<p><code>wildcard</code> –  wildcard pattern</p>
        match_value:
          type: string
          description: '<p><em>target domain, subdomain, or wildcard value</em><p><strong>required field if <code>stop_crawl_on_match</code> is specified</strong><p>specify a target domain, subdomain, or wildcard value;<p><strong>Note:</strong> domain or subdomain must be specified without a request protocol;<p>example: <code>"match_value": "dataforseo.com"</code>,<p><code>"match_value": "/blog/post-*"</code></p>'
        max_crawl_pages:
          type: integer
          description: '<p><em>page crawl limit</em><p>optional field<p>number of search results pages to crawl<p>max value: <code>100</code><p><strong>Note:</strong> you will be charged for each page crawled (10 organic results per page);<p>learn more about pricing on our <a href="https://dataforseo.com/pricing/serp/google-organic-serp-api" target="_blank">Pricing</a> page;<p><strong>Note#2:</strong> the <code>max_crawl_pages</code> and <code>depth</code> parameters complement each other;<p>learn more at <a href="https://dataforseo.com/help-center/what-is-max-crawl-pages-and-how-does-it-work" rel="noopener noreferrer" target="_blank">our help center</a></p>'
          nullable: true
        search_param:
          type: string
          description: '<p><em>additional parameters of the search query</em><p>optional field<p><a href="https://dataforseo.com/help-center/google-search-engine-parameters-and-how-to-use-them">get the list of available parameters and additional details here</a></p><br><strong>Note:</strong> the following search engine parameters are not supported and will be automatically unset if specified: <code>lr</code>, <code>cr</code>, <code>as_qdr</code>, <code>as_sitesearch</code>, <code>as_occt</code>, <code>as_filetype</code>.'
          nullable: true
        remove_from_url:
          type: array
          items:
            type: string
          description: '<p><em>remove specific parameters from URLs</em><p>optional field<p>using this field, you can specify up to 10 parameters to remove from URLs in the result<p>example:<p><code>"remove_from_url": ["srsltid"]</code></p>'
          nullable: true
        expand_ai_overview:
          type: boolean
          description: '<p><em>expand ai overview</em><p>optional field<p>set to <code>true</code> to expand the <code>ai_overview</code> item;<p>default value: <code>false</code>;<p><strong>Note:</strong> this parameter applies only to <a href="/v3/serp/google/organic/task_get/html/?bash" rel="noopener noreferrer" target="_blank">HTML task results</a></p>'
          nullable: true
        people_also_ask_click_depth:
          type: integer
          description: '<p><em>clicks on the corresponding element</em><p>optional field<p>specify the click depth on the <code>people_also_ask</code> element to get additional <code>people_also_ask_element</code> items;<p><strong>Note</strong> your account will be billed $0.00015 extra for each click regardless of task priority;<p>if the element is absent or we perform fewer clicks than you specified, all extra charges will be returned to your account balance<p>possible values: from <code>1</code> to <code>4</code></p>'
          nullable: true
        group_organic_results:
          type: boolean
          description: '<p><em>display related results</em><p>optional field<p>if set to <code>true</code>, the <code>related_result</code> element in the response will be provided as a snippet of its parent organic result;<p>if set to <code>false</code>, the <code>related_result</code> element will be provided as a separate organic result;<p>default value: <code>true</code></p>'
          nullable: true
        calculate_rectangles:
          type: boolean
          description: '<p><em>calcualte pixel rankings for SERP elements in advanced results</em><p>optional field<p>pixel ranking refers to the distance between the result snippet and top left corner of the screen;<p><a href="https://dataforseo.com/help-center/pixel-ranking-in-serp-api">Visit Help Center to learn more&gt;&gt;</a><p>by default, the parameter is set to <code>false</code><p><strong>Note:</strong> you will be charged extra $0.0006 for using this parameter</p>'
          nullable: true
        browser_screen_width:
          type: integer
          description: '<p><em>browser screen width</em><p>optional field<p>you can set a custom browser screen width to calculate pixel rankings for a particular device;<p>can be specified within the following range: <code>240-9999</code>;<p>by default, the parameter is set to:<p><code>1920</code> for <code>desktop</code>;<p><code>360</code> for <code>mobile</code> on <code>android</code>;<p><code>375</code> for <code>mobile</code> on <code>iOS</code>;<p><strong>Note:</strong> to use this parameter, set <code>calculate_rectangles</code> to <code>true</code></p>'
          format: int64
          nullable: true
        browser_screen_height:
          type: integer
          description: '<p><em>browser screen height</em><p>optional field<p>you can set a custom browser screen height to calculate pixel rankings for a particular device;<p>can be specified within the following range: <code>240-9999</code>;<p>by default, the parameter is set to:<p><code>1080</code> for <code>desktop</code>;<p><code>640</code> for <code>mobile</code> on <code>android</code>;<p><code>812</code> for <code>mobile</code> on <code>iOS</code>;<p><strong>Note:</strong> to use this parameter, set <code>calculate_rectangles</code> to <code>true</code></p>'
          nullable: true
        browser_screen_resolution_ratio:
          type: integer
          description: '<p><em>browser screen resolution ratio</em><p>optional field<p>you can set a custom browser screen resolution ratio to calculate pixel rankings for a particular device;<p>can be specified within the following range: <code>0.5-3</code>;<p>by default, the parameter is set to:<p><code>1</code> for <code>desktop</code>;<p><code>3</code> for <code>mobile</code> on <code>android</code>;<p><code>3</code> for <code>mobile</code> on <code>iOS</code>;<p><strong>Note:</strong> to use this parameter, set <code>calculate_rectangles</code> to <code>true</code></p>'
          nullable: true
        url:
          type: string
          description: '<p><em>direct URL of the search query</em><p>optional field<p>you can specify a direct URL and we will sort it out to the necessary fields. Note that this method is the most difficult for our API to process and also requires you to specify the exact language and location in the URL. In most cases, we wouldn’t recommend using this method.<p>example:<p><code class="long-string">https://www.google.co.uk/search?q=%20rank%20tracker%20api&amp;hl=en&amp;gl=GB&amp;uule=w+CAIQIFISCXXeIa8LoNhHEZkq1d1aOpZS</code></p><br><strong>Note:</strong> the following search engine parameters are not supported and will be automatically unset if specified in the URL: <code>lr</code>, <code>cr</code>, <code>as_qdr</code>, <code>as_sitesearch</code>, <code>as_occt</code>, <code>as_filetype</code>.'
          nullable: true
        target_search_mode:
          type: string
          description: '<p><em>target matching mode</em><p>optional field<p>to enable this parameter, <code>stop_crawl_on_match</code> must also be enabled<p>defines how the crawl should stop when multiple targets are specified in <code>stop_crawl_on_match</code><p>possible values: <code>all</code>, <code>any</code><p><code>all</code> – the crawl stops only when all specified targets are found<p><code>any</code> – the crawl stops when any single target is found<p>default value: <code>any</code><p>learn more about this parameter on our <a href="https://dataforseo.com/help-center/how-to-use-new-crawl-control-parameters-in-google-organic-serp-api" target="_blank">Help Center</a></p>'
          nullable: true
        find_targets_in:
          type: array
          items:
            type: string
          description: '<p><em>SERP element types to check for targets</em><p>optional field<p>to enable this parameter, <code>stop_crawl_on_match</code> must also be enabled<p>specifies which SERP element types should be checked for target matches<p>if not specified, all first-level elements with <code>url</code> and <code>domain</code> fields are checked for targets<p>possible values: <code>organic</code>, <code>paid</code>, <code>local_pack</code>, <code>featured_snippet</code>, <code>events</code>, <code>google_flights</code>, <code>images</code>, <code>jobs</code>, <code>knowledge_graph</code>, <code>local_service</code>, <code>map</code>, <code>scholarly_articles</code>, <code>third_party_reviews</code>, <code>twitter</code><p><strong>Note:</strong> cannot contain the same element types as <code>ignore_targets_in</code><p>example:<p><code>"find_targets_in": ["organic", "featured_snippet"]</code><p>learn more about this parameter on our <a href="https://dataforseo.com/help-center/how-to-use-new-crawl-control-parameters-in-google-organic-serp-api" target="_blank">Help Center</a></p>'
          nullable: true
        ignore_targets_in:
          type: array
          items:
            type: string
          description: '<p><em>SERP element types to exclude from target search</em><p>optional field<p>to enable this parameter, <code>stop_crawl_on_match</code> must also be enabled<p>specifies which SERP element types should be excluded when searching for target matches<p>possible values: <code>organic</code>, <code>paid</code>, <code>local_pack</code>, <code>featured_snippet</code>, <code>events</code>, <code>google_flights</code>, <code>images</code>, <code>jobs</code>, <code>knowledge_graph</code>, <code>local_service</code>, <code>map</code>, <code>scholarly_articles</code>, <code>third_party_reviews</code>, <code>twitter</code><p><strong>Note:</strong> cannot contain the same element types as <code>find_targets_in</code><p>example:<p><code>"ignore_targets_in": ["paid", "images"]</code><p>learn more about this parameter on our <a href="https://dataforseo.com/help-center/how-to-use-new-crawl-control-parameters-in-google-organic-serp-api" target="_blank">Help Center</a></p>'
          nullable: true
        se_domain:
          type: string
          description: '<p><em>search engine domain</em><p>optional field<p>we choose the relevant search engine domain automatically according to the location and language you specify<p>however, you can set a custom search engine domain in this field<p>example:<p><code><em>google.co.uk</em>, <em>google.com.au</em>, <em>google.de</em></code>, etc.</p>'
          nullable: true
      example:
        - language_code: en
          location_code: 2840
          keyword: albert einstein
        - language_name: English
          location_name: United States
          keyword: albert einstein
          priority: 2
          tag: some_string_123
          pingback_url: https://your-server.com/pingscript?id=$id&tag=$tag
        - url: https://www.google.co.uk/search?q=albert%20einstein&hl=en&gl=GB&uule=w+CAIQIFISCXXeIa8LoNhHEZkq1d1aOpZS
          postback_data: html
          postback_url: https://your-server.com/postbackscript
    SerpGoogleOrganicTaskPostTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: object
              description: '<em>array of results</em><br>in this case, the value will be <code>null</code>'
              nullable: true
    SerpGoogleOrganicTaskPostResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleOrganicTaskPostTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    SerpGoogleOrganicTasksReadyResultInfo:
      type: object
      properties:
        id:
          type: string
          description: <em>task identifier of the completed task</em><br><strong>unique task identifier in our system in the <a href="https://en.wikipedia.org/wiki/Universally_unique_identifier">UUID</a> format</strong>
          nullable: true
        se:
          type: string
          description: <em>search engine specified when setting the task</em>
          nullable: true
        se_type:
          type: string
          description: '<em>type of search engine</em><br>example: <code>{{low_se_type_under}}</code>'
          nullable: true
        date_posted:
          type: string
          description: <em>date when the task was posted (in the UTC format)</em>
          nullable: true
        tag:
          type: string
          description: <em>user-defined task identifier</em>
          nullable: true
        endpoint_regular:
          type: string
          description: '<em>URL for collecting the results of the SERP Regular task</em><br>if SERP Regular is not supported in the specified endpoint, the value will be <code>null</code>'
          nullable: true
        endpoint_advanced:
          type: string
          description: '<em>URL for collecting the results of the SERP Advanced task</em><br>if SERP Advanced is not supported in the specified endpoint, the value will be <code>null</code>'
          nullable: true
        endpoint_html:
          type: string
          description: '<em>URL for collecting the results of the SERP HTML task</em><br>if SERP HTML is not supported in the specified endpoint, the value will be <code>null</code>'
          nullable: true
    SerpGoogleOrganicTasksReadyTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleOrganicTasksReadyResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    SerpGoogleOrganicTasksReadyResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleOrganicTasksReadyTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    SerpTasksReadyResultInfo:
      type: object
      properties:
        id:
          type: string
          description: <em>task identifier of the completed task</em><br><strong>unique task identifier in our system in the <a href="https://en.wikipedia.org/wiki/Universally_unique_identifier">UUID</a> format</strong>
          nullable: true
        se:
          type: string
          description: <em>search engine specified when setting the task</em>
          nullable: true
        se_type:
          type: string
          description: '<em>type of search engine</em><br>example: <code>{{low_se_type_under}}</code>'
          nullable: true
        date_posted:
          type: string
          description: <em>date when the task was posted (in the UTC format)</em>
          nullable: true
        tag:
          type: string
          description: <em>user-defined task identifier</em>
          nullable: true
        endpoint_regular:
          type: string
          description: '<em>URL for collecting the results of the SERP Regular task</em><br>if SERP Regular is not supported in the specified endpoint, the value will be <code>null</code>'
          nullable: true
        endpoint_advanced:
          type: string
          description: '<em>URL for collecting the results of the SERP Advanced task</em><br>if SERP Advanced is not supported in the specified endpoint, the value will be <code>null</code>'
          nullable: true
        endpoint_html:
          type: string
          description: '<em>URL for collecting the results of the SERP HTML task</em><br>if SERP HTML is not supported in the specified endpoint, the value will be <code>null</code>'
          nullable: true
    SerpTasksReadyTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpTasksReadyResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    SerpTasksReadyResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpTasksReadyTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    SerpGoogleOrganicTasksFixedResultInfo:
      type: object
      properties:
        id:
          type: string
          description: <em>task identifier of the completed task</em><br><strong>unique task identifier in our system in the <a href="https://en.wikipedia.org/wiki/Universally_unique_identifier">UUID</a> format</strong>
          nullable: true
        se:
          type: string
          description: <em>search engine specified when setting the task</em>
          nullable: true
        se_type:
          type: string
          description: '<em>type of search engine</em><br>can take the following values: <code>{{low_se_type_under}}</code>'
          nullable: true
        date_posted:
          type: string
          nullable: true
        tag:
          type: string
          description: <em>user-defined task identifier</em>
          nullable: true
        endpoint_regular:
          type: string
          description: '<em>URL for collecting the results of the SERP Regular task</em><br>if SERP Regular is not supported in the specified endpoint, the value will be <code>null</code>'
          nullable: true
        endpoint_advanced:
          type: string
          description: '<em>URL for collecting the results of the SERP Advanced task</em><br>if SERP Advanced is not supported in the specified endpoint, the value will be <code>null</code>'
          nullable: true
        endpoint_html:
          type: string
          description: '<em>URL for collecting the results of the SERP HTML task</em><br>if SERP HTML is not supported in the specified endpoint, the value will be <code>null</code>'
          nullable: true
    SerpGoogleOrganicTasksFixedTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleOrganicTasksFixedResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    SerpGoogleOrganicTasksFixedResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleOrganicTasksFixedTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    PaidSerpElementItem:
      type: object
      allOf:
        - type: object
          oneOf:
            - $ref: '#/components/schemas/BaseSerpApiElementItem'
          nullable: true
        - type: object
          properties:
            rank_group:
              type: integer
              description: <em>group rank in SERP</em><br>position within a group of elements with identical <code>type</code> values<br>positions of elements with different <code>type</code> values are omitted from <code>rank_group</code>
              nullable: true
            rank_absolute:
              type: integer
              description: '<em> absolute rank in SERP</em><br>absolute position among all the elements found in SERP<strong>note</strong> values are returned in the ascending order, with values corresponding to advanced SERP features omitted from the results;<br>to get all items (including SERP features and rich snippets) with their positions, please refer to the <a href="https://docs.dataforseo.com/v3/serp/google/organic/live/advanced/?php">Google Organiс Advanced SERP</a> endpoint'
              nullable: true
            domain:
              type: string
              description: <em>domain in SERP</em>
              nullable: true
            title:
              type: string
              description: <em>title of the results element in SERP</em>
              nullable: true
            description:
              type: string
              description: <em>description of the results element in SERP</em>
              nullable: true
            url:
              type: string
              description: <em> relevant URL in SERP</em>
              nullable: true
            breadcrumb:
              type: string
              description: <em>breadcrumb in SERP</em>
              nullable: true
            website_name:
              type: string
              description: <em>name of the website in SERP</em>
              nullable: true
            is_image:
              type: boolean
              description: <em>indicates whether the element contains an_<code class="prettyprint">image</code></em><br><strong>Note:</strong> this check no longer appears in SERPn
              nullable: true
            is_video:
              type: boolean
              description: <em>indicates whether the element contains a <code class="prettyprint">video</code></em><br><strong>Note:</strong> this check no longer appears in SERP
              nullable: true
            checks:
              type: array
              items:
                type: string
                description: <em>indicates whether the element contains an_<code class="prettyprint">image</code></em><br><strong>Note:</strong> this check no longer appears in SERPn
                nullable: true
              description: '<em>array of properties detected for the SERP element</em><br>lists the properties that are true for this element<br>each value in the array represents a detected property <br>example:<br>if <code>is_image</code> is present in the array, the element contains an image<br>possible values in the array:<br><code>is_image</code>, <code>is_video</code>, <code>is_featured_snippet</code>, <code>amp_version</code>, <code>is_malicious</code>, <code>is_web_story</code>, <code>is_highly_cited</code><br>equals <code>null</code> if none of the properties are detected for the element<br>learn more about the <code>checks</code> array in <a href="https://dataforseo.com/help-center/whats-a-checks-array-in-the-google-organic-serp-api" target="_blank">this Help Center article</a>'
              nullable: true
            images:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AiModeImagesElementInfo'
                nullable: true
              description: '<em>images of the element</em><br>if there are none, equals <code>null</code>'
              nullable: true
            highlighted:
              type: array
              items:
                type: string
                nullable: true
              description: <em>words highlighted in bold within the results <code>description</code></em>
              nullable: true
            extra:
              type: object
              additionalProperties:
                type: string
                nullable: true
              description: <em>additional information about the result</em>
              nullable: true
            description_rows:
              type: array
              items:
                type: string
                nullable: true
              description: '<em>extended description</em><br>if there is none, equals <code>null</code>'
              nullable: true
            links:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AdLinkElement'
                nullable: true
              description: <em>link of the element</em>
              nullable: true
            price:
              type: object
              oneOf:
                - $ref: '#/components/schemas/PriceInfo'
              description: '<em>pricing details</em><br>contains the pricing details of the product or service featured in the result;<br>if there is none, equals <code>null</code>'
              nullable: true
            rating:
              type: object
              oneOf:
                - $ref: '#/components/schemas/RatingInfo'
              description: '<em>the item''s rating </em><br>the popularity rate based on reviews and displayed in SERP<br>if there is none, equals <code>null</code>'
              nullable: true
    OrganicSerpElementItem:
      type: object
      allOf:
        - type: object
          oneOf:
            - $ref: '#/components/schemas/BaseSerpApiElementItem'
          nullable: true
        - type: object
          properties:
            rank_group:
              type: integer
              description: <em>group rank in SERP</em><br>position within a group of elements with identical <code>type</code> values<br>positions of elements with different <code>type</code> values are omitted from <code>rank_group</code>
              nullable: true
            rank_absolute:
              type: integer
              description: '<em> absolute rank in SERP</em><br>absolute position among all the elements found in SERP<strong>note</strong> values are returned in the ascending order, with values corresponding to advanced SERP features omitted from the results;<br>to get all items (including SERP features and rich snippets) with their positions, please refer to the <a href="https://docs.dataforseo.com/v3/serp/google/organic/live/advanced/?php">Google Organiс Advanced SERP</a> endpoint'
              nullable: true
            domain:
              type: string
              description: <em>domain in SERP</em>
              nullable: true
            title:
              type: string
              description: <em>title of the results element in SERP</em>
              nullable: true
            description:
              type: string
              description: <em>description of the results element in SERP</em>
              nullable: true
            url:
              type: string
              description: <em> relevant URL in SERP</em>
              nullable: true
            breadcrumb:
              type: string
              description: <em>breadcrumb in SERP</em>
              nullable: true
            cache_url:
              type: string
              description: <em>cached version of the page</em>
              nullable: true
            related_search_url:
              type: string
              description: <em>URL to a similar search</em><br>URL to a new search for the same keyword(s) <a href="https://support.google.com/websearch/answer/2466433?hl=en#:~:text=Search%20for%20related%20sites">on related sites</a>
              nullable: true
            website_name:
              type: string
              description: <em>name of the website in SERP</em>
              nullable: true
            is_image:
              type: boolean
              description: <em>indicates whether the element contains an_<code class="prettyprint">image</code></em><br><strong>Note:</strong> this check no longer appears in SERPn
              nullable: true
            is_video:
              type: boolean
              description: <em>indicates whether the element contains a <code class="prettyprint">video</code></em><br><strong>Note:</strong> this check no longer appears in SERP
              nullable: true
            is_featured_snippet:
              type: boolean
              description: <em>indicates whether the element is a <code class="prettyprint">featured_snippet</code></em><br><strong>Note:</strong> this check no longer appears in SERP
              nullable: true
            is_malicious:
              type: boolean
              description: <em>indicates whether the element is marked as malicious</em><br><strong>Note:</strong> this check no longer appears in SERP
              nullable: true
            is_web_story:
              type: boolean
              description: <em>indicates whether the element is marked as Google web story</em><br><strong>Note:</strong> this check no longer appears in SERP
              nullable: true
            checks:
              type: array
              items:
                type: string
                description: <em>indicates whether the element contains an_<code class="prettyprint">image</code></em><br><strong>Note:</strong> this check no longer appears in SERPn
                nullable: true
              description: '<em>array of properties detected for the SERP element</em><br>lists the properties that are true for this element<br>each value in the array represents a detected property <br>example:<br>if <code>is_image</code> is present in the array, the element contains an image<br>possible values in the array:<br><code>is_image</code>, <code>is_video</code>, <code>is_featured_snippet</code>, <code>amp_version</code>, <code>is_malicious</code>, <code>is_web_story</code>, <code>is_highly_cited</code><br>equals <code>null</code> if none of the properties are detected for the element<br>learn more about the <code>checks</code> array in <a href="https://dataforseo.com/help-center/whats-a-checks-array-in-the-google-organic-serp-api" target="_blank">this Help Center article</a>'
              nullable: true
            pre_snippet:
              type: string
              description: <em>includes additional information appended before the result description in SERP</em>
              nullable: true
            extended_snippet:
              type: string
              description: <em>includes additional information appended after the result description in SERP</em>
              nullable: true
            images:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AiModeImagesElementInfo'
                nullable: true
              description: '<em>images of the element</em><br>if there are none, equals <code>null</code>'
              nullable: true
            amp_version:
              type: boolean
              description: <em>Accelerated Mobile Pages</em><br>indicates whether an item has the Accelerated Mobile Page (AMP) version
              nullable: true
            rating:
              type: object
              oneOf:
                - $ref: '#/components/schemas/RatingInfo'
              description: '<em>the item''s rating </em><br>the popularity rate based on reviews and displayed in SERP<br>if there is none, equals <code>null</code>'
              nullable: true
            price:
              type: object
              oneOf:
                - $ref: '#/components/schemas/PriceInfo'
              description: '<em>pricing details</em><br>contains the pricing details of the product or service featured in the result;<br>if there is none, equals <code>null</code>'
              nullable: true
            highlighted:
              type: array
              items:
                type: string
                nullable: true
              description: <em>words highlighted in bold within the results <code>description</code></em>
              nullable: true
            links:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/LinkElement'
                nullable: true
              description: <em>link of the element</em>
              nullable: true
            faq:
              type: object
              oneOf:
                - $ref: '#/components/schemas/FaqBox'
              description: <em>frequently asked questions</em><br>questions and answers extension shown below some of Google's search results<br><strong>Note:</strong> this object is deprecated and always returns <code>null</code>
              nullable: true
              deprecated: true
            extended_people_also_search:
              type: array
              items:
                type: string
                nullable: true
              description: <em>extension of the organic element</em><br>extension of the organic result containing related search queries<br><strong>Note:</strong> extension appears in SERP upon clicking on the result and then bouncing back to search results
              nullable: true
            about_this_result:
              type: object
              oneOf:
                - $ref: '#/components/schemas/AboutThisResultElement'
              description: <em>contains information from the 'About this result' panel</em><br><strong>Note:</strong> this object is deprecated and always returns <code>null</code>
              nullable: true
              deprecated: true
            related_result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/RelatedResult'
                nullable: true
              description: '<em>related result from the same domain</em><br>related result from the same domain appears as a part of the main result snippet;<br>you can derive the <code>related_result</code> snippets as <code>"type": "organic"</code> results by setting the <code>group_organic_results</code> parameter to <code>false</code> in the POST request'
              nullable: true
            timestamp:
              type: string
              description: '<em>date and time when the result was published</em><br>in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”<br>example:<br><code class="long-string">2019-11-15 12:57:46 +00:00</code>'
              nullable: true
    FeaturedSnippetSerpElementItem:
      type: object
      allOf:
        - type: object
          oneOf:
            - $ref: '#/components/schemas/BaseSerpApiElementItem'
          nullable: true
        - type: object
          properties:
            rank_group:
              type: integer
              description: <em>group rank in SERP</em><br>position within a group of elements with identical <code>type</code> values<br>positions of elements with different <code>type</code> values are omitted from <code>rank_group</code>
              nullable: true
            rank_absolute:
              type: integer
              description: '<em> absolute rank in SERP</em><br>absolute position among all the elements found in SERP<strong>note</strong> values are returned in the ascending order, with values corresponding to advanced SERP features omitted from the results;<br>to get all items (including SERP features and rich snippets) with their positions, please refer to the <a href="https://docs.dataforseo.com/v3/serp/google/organic/live/advanced/?php">Google Organiс Advanced SERP</a> endpoint'
              nullable: true
            domain:
              type: string
              description: <em>domain of the ad element in SERP</em>
              nullable: true
            title:
              type: string
              description: <em>title of the ad element in SERP</em>
              nullable: true
            description:
              type: string
              description: <em>description of the ad element in SERP</em>
              nullable: true
            url:
              type: string
              description: <em>relevant URL of the ad element in SERP</em>
              nullable: true
            breadcrumb:
              type: string
              description: <em>breadcrumb of the ad element in SERP</em>
              nullable: true
            featured_title:
              type: string
              description: <em>title</em>
              nullable: true
            timestamp:
              type: string
              description: '<em>date and time when the result was published</em><br>in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”<br>example:<br><code class="long-string">2019-11-15 12:57:46 +00:00</code>'
              nullable: true
            images:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AiModeImagesElementInfo'
                nullable: true
              description: '<em>images of the element</em><br>if there are none, equals <code>null</code>'
              nullable: true
            table:
              type: object
              oneOf:
                - $ref: '#/components/schemas/Table'
              description: <em>table present in the element</em><br>the header and content of the table present in the element
              nullable: true
    SerpGoogleOrganicTaskGetRegularResultInfo:
      type: object
      properties:
        keyword:
          type: string
          description: <em>keyword received in a POST array</em><br><strong>keyword is returned with decoded %## (plus symbol '+' will be decoded to a space character)</strong>
          nullable: true
        type:
          type: string
          description: type of element
          nullable: true
        se_domain:
          type: string
          description: <em>search engine domain in a POST array</em>
          nullable: true
        location_code:
          type: integer
          description: <em>location code in a POST array</em>
          nullable: true
        language_code:
          type: string
          description: <em>language code in a POST array</em>
          nullable: true
        check_url:
          type: string
          description: <em>direct URL to search engine results</em><br>you can use it to make sure that we provided accurate results
          nullable: true
        datetime:
          type: string
          description: '<em>date and time when the result was received</em><br>in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”<br>example:<br><code class="long-string">2019-11-15 12:57:46 +00:00</code>'
          nullable: true
        spell:
          type: object
          oneOf:
            - $ref: '#/components/schemas/SpellInfo'
          description: '<em>autocorrection of the search engine</em><br>if the search engine provided results for a keyword that was corrected, we will specify the keyword corrected by the search engine and the type of autocorrection;<br>if there is none, the value is <code>null</code>'
          nullable: true
        refinement_chips:
          type: object
          oneOf:
            - $ref: '#/components/schemas/RefinementChipsInfo'
          description: '<em>search refinement chips</em><br>if there are none, the value is <code>null</code>'
          nullable: true
        item_types:
          type: array
          items:
            type: string
            nullable: true
          description: '<em>types of search results found in SERP</em><br>contains types of all search results (<code>items</code>) found in the returned SERP<br>possible item types:<br><code>answer_box</code>, <code>app</code>, <code>carousel</code>, <code>multi_carousel</code>, <code>featured_snippet</code>, <code>google_flights</code>, <code>google_reviews</code>, <code>third_party_reviews</code>,  <code>images</code>, <code>jobs</code>, <code>knowledge_graph</code>, <code>local_pack</code>, <code>hotels_pack</code>, <code>map</code>, <code>organic</code>, <code>paid</code>, <code>people_also_ask</code>, <code>related_searches</code>, <code>people_also_search</code>, <code>shopping</code>, <code>top_stories</code>, <code>twitter</code>, <code>video</code>, <code>events</code>, <code>recipes</code>, <code>top_sights</code>, <code>scholarly_articles</code>, <code>popular_products</code>, <code>questions_and_answers</code>, <code>find_results_on</code>, <code>stocks_box</code>, <code>commercial_units</code>, <code>local_services</code>, <code>google_hotels</code>, <code>math_solver</code>, <code>currency_box</code>, <code>product_considerations</code>, <code>short_videos</code>, <code>refine_products</code>, <code>perspectives</code>, <code>discussions_and_forums</code>, <code>compare_sites</code>, <code>ai_overview</code><p><strong>note</strong> that this array contains all types of search results found in the returned SERP;<br>however, this endpoint provides data for <code>featured_snippet</code>, <code>organic</code> and <code>paid</code> types only;<br>to get all items (including SERP features and rich snippets) found in the returned SERP, please refer to the <a href="https://docs.dataforseo.com/v3/serp/google/organic/live/advanced/?php">Google Organiс Advanced SERP</a> endpoint'
          nullable: true
        se_results_count:
          type: integer
          description: <em>total number of results in SERP</em>
          format: int64
          nullable: true
        pages_count:
          type: integer
          description: <em>total search results pages retrieved</em><br>total number of retrieved SERPs in the result
          format: int64
          nullable: true
        items_count:
          type: integer
          description: <em>the number of results returned in the <strong><code>items</code></strong> array</em>
          format: int64
          nullable: true
        items:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/BaseSerpApiElementItem'
            nullable: true
          description: <em>items in SERP</em>
          nullable: true
    SerpGoogleOrganicTaskGetRegularTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleOrganicTaskGetRegularResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    SerpGoogleOrganicTaskGetRegularResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleOrganicTaskGetRegularTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    KnowledgeGraphListElement:
      type: object
      properties:
        type:
          type: string
          description: type of element
          nullable: true
        title:
          type: string
          description: <em>title of the result in SERP</em>
          nullable: true
        subtitle:
          type: string
          description: <em>subtitle of the item</em>
          nullable: true
        url:
          type: string
          description: <em>sitelink URL</em>
          nullable: true
        domain:
          type: string
          description: <em>domain in SERP</em>
          nullable: true
        image_url:
          type: string
          description: <em>URL of the image</em><br>the URL leading to the image on the original resource or DataForSEO storage (in case the original source is not available)
          nullable: true
        xpath:
          type: string
          description: <em>the <a href="https://en.wikipedia.org/wiki/XPath">XPath</a> of the element</em>
          nullable: true
    SerpApiKnowledgeGraphCarouselItemElementItem:
      type: object
      allOf:
        - type: object
          oneOf:
            - $ref: '#/components/schemas/BaseSerpApiKnowledgeGraphElementItem'
          nullable: true
        - type: object
          properties:
            rank_group:
              type: integer
              description: <em>group rank in SERP</em><br>position within a group of elements with identical <code>type</code> values<br>positions of elements with different <code>type</code> values are omitted from <code>rank_group</code>
              nullable: true
            rank_absolute:
              type: integer
              description: <em>absolute rank in SERP</em><br>absolute position among all the elements in SERP
              nullable: true
            title:
              type: string
              description: <em>title of the result in SERP</em>
              nullable: true
            data_attrid:
              type: string
              description: <em>google defined data attribute ID</em><br>example:<br><code>action:listen_artist</code>
              nullable: true
            link:
              type: object
              oneOf:
                - $ref: '#/components/schemas/LinkElement'
              description: <em>link of the element</em>
              nullable: true
            items:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/KnowledgeGraphListElement'
                nullable: true
              description: <em>elements of search results found in SERP</em>
              nullable: true
    SerpApiKnowledgeGraphDescriptionItemElementItem:
      type: object
      allOf:
        - type: object
          oneOf:
            - $ref: '#/components/schemas/BaseSerpApiKnowledgeGraphElementItem'
          nullable: true
        - type: object
          properties:
            rank_group:
              type: integer
              description: <em>group rank in SERP</em><br>position within a group of elements with identical <code>type</code> values<br>positions of elements with different <code>type</code> values are omitted from <code>rank_group</code>
              nullable: true
            rank_absolute:
              type: integer
              description: <em>absolute rank in SERP</em><br>absolute position among all the elements in SERP
              nullable: true
            text:
              type: string
              description: <em>text or description of the element in SERP</em>
              nullable: true
            links:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/LinkElement'
                nullable: true
              description: '<em>sitelinks</em><br>the links shown below some of Google''s search results<br>if there are none, equals <code>null</code>'
              nullable: true
    KnowledgeGraphImagesElement:
      type: object
      properties:
        type:
          type: string
          description: type of element
          nullable: true
        url:
          type: string
          description: <em> relevant URL of the Ad element in SERP</em>
          nullable: true
        domain:
          type: string
          description: <em>domain in SERP</em>
          nullable: true
        alt:
          type: string
          description: <i>alt tag of the image</i>
          nullable: true
        image_url:
          type: string
          description: <em>URL of the image</em><br>the URL leading to the image on the original resource or DataForSEO storage (in case the original source is not available)
          nullable: true
        xpath:
          type: string
          description: <em>the <a href="https://en.wikipedia.org/wiki/XPath">XPath</a> of the element</em>
          nullable: true
    SerpApiKnowledgeGraphImagesItemElementItem:
      type: object
      allOf:
        - type: object
          oneOf:
            - $ref: '#/components/schemas/BaseSerpApiKnowledgeGraphElementItem'
          nullable: true
        - type: object
          properties:
            rank_group:
              type: integer
              description: <em>group rank in SERP</em><br>position within a group of elements with identical <code>type</code> values<br>positions of elements with different <code>type</code> values are omitted from <code>rank_group</code>
              nullable: true
            rank_absolute:
              type: integer
              description: <em>absolute rank in SERP</em><br>absolute position among all the elements in SERP
              nullable: true
            link:
              type: object
              oneOf:
                - $ref: '#/components/schemas/LinkElement'
              description: <em>link of the element</em>
              nullable: true
            items:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/KnowledgeGraphImagesElement'
                nullable: true
              description: '<em>additional items present in the element</em><br>if there are none, equals <code>null</code>'
              nullable: true
    SerpApiKnowledgeGraphListItemElementItem:
      type: object
      allOf:
        - type: object
          oneOf:
            - $ref: '#/components/schemas/BaseSerpApiKnowledgeGraphElementItem'
          nullable: true
        - type: object
          properties:
            rank_group:
              type: integer
              description: <em>group rank in SERP</em><br>position within a group of elements with identical <code>type</code> values<br>positions of elements with different <code>type</code> values are omitted from <code>rank_group</code>
              nullable: true
            rank_absolute:
              type: integer
              description: <em>absolute rank in SERP</em><br>absolute position among all the elements in SERP
              nullable: true
            title:
              type: string
              description: <em>title of the item</em>
              nullable: true
            data_attrid:
              type: string
              description: <em>google defined data attribute ID</em><br>example:<br><code>ss:/webfacts:net_worth</code>
              nullable: true
            link:
              type: object
              oneOf:
                - $ref: '#/components/schemas/LinkElement'
              description: <em>link of the element</em>
              nullable: true
            items:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/KnowledgeGraphListElement'
                nullable: true
              description: '<em>additional items present in the element</em><br>if there are none, equals <code>null</code>'
              nullable: true
    SerpApiKnowledgeGraphRowItemElementItem:
      type: object
      allOf:
        - type: object
          oneOf:
            - $ref: '#/components/schemas/BaseSerpApiKnowledgeGraphElementItem'
          nullable: true
        - type: object
          properties:
            rank_group:
              type: integer
              description: <em>group rank in SERP</em><br>position within a group of elements with identical <code>type</code> values<br>positions of elements with different <code>type</code> values are omitted from <code>rank_group</code>
              nullable: true
            rank_absolute:
              type: integer
              description: <em>absolute rank in SERP</em><br>absolute position among all the elements in SERP
              nullable: true
            title:
              type: string
              description: <em>title of the link</em>
              nullable: true
            data_attrid:
              type: string
              description: <em>google defined data attribute ID</em><br>example:<br><code>kc:/common/topic:social media presence</code>
              nullable: true
            text:
              type: string
              description: <em>reference text</em><br>text snippet from the page that was used to generate the <code>ai_overview_element</code>
              nullable: true
            links:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/LinkElement'
                nullable: true
              description: '<em>sitelinks</em><br>the links shown below some of Google''s search results<br>if there are none, equals <code>null</code>'
              nullable: true
    AiModeImagesElementInfo:
      type: object
      properties:
        type:
          type: string
          description: type of element
          nullable: true
        alt:
          type: string
          description: <i>alt tag of the image</i>
          nullable: true
        url:
          type: string
          description: <em>relevant URL</em>
          nullable: true
        image_url:
          type: string
          description: <em>URL of the image</em><br>the URL leading to the image on the original resource or DataForSEO storage (in case the original source is not available)
          nullable: true
    KnowledgeGraphExpandedElement:
      type: object
      properties:
        type:
          type: string
          description: type of element
          nullable: true
        featured_title:
          type: string
          description: <em>title of a given element</em>
          nullable: true
        url:
          type: string
          description: <em>relevant URL </em>
          nullable: true
        domain:
          type: string
          description: <em>domain where a link points</em>
          nullable: true
        title:
          type: string
          description: <em>title of the result in SERP</em>
          nullable: true
        snippet:
          type: string
          description: <em>text alongside the link title</em>
          nullable: true
        images:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/AiModeImagesElementInfo'
            nullable: true
          description: '<em>images of the element</em><br>if there are none, equals <code>null</code>'
          nullable: true
        timestamp:
          type: string
          description: '<em>date and time when the result was published</em><br>in the UTC format: "yyyy-mm-dd hh-mm-ss +00:00"<br>example:<br><code class="long-string">2019-11-15 12:57:46 +00:00</code>'
          nullable: true
        table:
          type: object
          oneOf:
            - $ref: '#/components/schemas/Table'
          description: <em>table present in the element</em><br>the header and content of the table present in the element
          nullable: true
    SerpApiKnowledgeGraphExpandedItemElementItem:
      type: object
      allOf:
        - type: object
          oneOf:
            - $ref: '#/components/schemas/BaseSerpApiKnowledgeGraphElementItem'
          nullable: true
        - type: object
          properties:
            rank_group:
              type: integer
              description: <em>group rank in SERP</em><br>position within a group of elements with identical <code>type</code> values<br>positions of elements with different <code>type</code> values are omitted from <code>rank_group</code>
              nullable: true
            rank_absolute:
              type: integer
              description: <em>absolute rank in SERP</em><br>absolute position among all the elements in SERP
              nullable: true
            title:
              type: string
              description: <em>title of the result in SERP</em>
              nullable: true
            data_attrid:
              type: string
              description: <em>google defined data attribute ID</em><br>example:<br><code>kc:/local:place qa</code>
              nullable: true
            expanded_element:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/KnowledgeGraphExpandedElement'
                nullable: true
              description: <em>link of the element</em>
              nullable: true
    SerpApiKnowledgeGraphPartItemElementItem:
      type: object
      allOf:
        - type: object
          oneOf:
            - $ref: '#/components/schemas/BaseSerpApiKnowledgeGraphElementItem'
          nullable: true
        - type: object
          properties:
            rank_group:
              type: integer
              description: <em>group rank in SERP</em><br>position within a group of elements with identical <code>type</code> values<br>positions of elements with different <code>type</code> values are omitted from <code>rank_group</code>
              nullable: true
            rank_absolute:
              type: integer
              description: <em>absolute rank in SERP</em><br>absolute position among all the elements in SERP
              nullable: true
            title:
              type: string
              description: <em>title of the place</em>
              nullable: true
            data_attrid:
              type: string
              description: <em>google defined data attribute ID</em><br>example:<br><code>kc:/local:place qa</code>
              nullable: true
            text:
              type: string
              description: <em>reference text</em><br>text snippet from the page that was used to generate the <code>ai_overview_element</code>
              nullable: true
            links:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/LinkElement'
                nullable: true
              description: '<em>sitelinks</em><br>the links shown below some of Google''s search results<br>if there are none, equals <code>null</code>'
              nullable: true
    KnowledgeGraphShoppingElement:
      type: object
      properties:
        type:
          type: string
          description: type of element
          nullable: true
        title:
          type: string
          description: <em>title of the element</em>
          nullable: true
        url:
          type: string
          description: <em>URL</em>
          nullable: true
        domain:
          type: string
          description: <em>domain where a link points</em>
          nullable: true
        price:
          type: object
          oneOf:
            - $ref: '#/components/schemas/PriceInfo'
          description: '<em>pricing details</em><br>contains the pricing details of the product or service featured in the result;<br>if there is none, equals <code>null</code>'
          nullable: true
        source:
          type: string
          description: <em>reference source name or title</em>
          nullable: true
        snippet:
          type: string
          description: <em>text alongside the link title</em>
          nullable: true
        marketplace:
          type: string
          description: <em>merchant account provider</em><br>ecommerce site that hosts products or websites of individual sellers under the same merchant account<br>example:<br><code>by Google</code>
          nullable: true
        marketplace_url:
          type: string
          description: <em>URL to the merchant account provider</em><br>ecommerce site that hosts products or websites of individual sellers under the same merchant account
          nullable: true
    SerpApiKnowledgeGraphShoppingItemElementItem:
      type: object
      allOf:
        - type: object
          oneOf:
            - $ref: '#/components/schemas/BaseSerpApiKnowledgeGraphElementItem'
          nullable: true
        - type: object
          properties:
            rank_group:
              type: integer
              description: <em>group rank in SERP</em><br>position within a group of elements with identical <code>type</code> values<br>positions of elements with different <code>type</code> values are omitted from <code>rank_group</code>
              nullable: true
            rank_absolute:
              type: integer
              description: <em>absolute rank in SERP</em><br>absolute position among all the elements in SERP
              nullable: true
            title:
              type: string
              description: <em>title of a given link element</em>
              nullable: true
            data_attrid:
              type: string
              description: <em>google defined data attribute ID</em><br>example:<br><code>kc:/shopping/gpc:organic-offers</code>
              nullable: true
            items:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/KnowledgeGraphShoppingElement'
                nullable: true
              description: '<em>keywords relevant to the initial search query</em><br>if there are none, equals <code>null</code>'
              nullable: true
    KnowledgeGraphHotelsBookingElement:
      type: object
      properties:
        type:
          type: string
          description: type of element
          nullable: true
        source:
          type: string
          description: <em>name of the source of the video</em>
          nullable: true
        description:
          type: string
          description: <em>description of the results element in SERP</em>
          nullable: true
        url:
          type: string
          description: <em>image source URL</em>
          nullable: true
        domain:
          type: string
          description: <em>website domain</em>
          nullable: true
        price:
          type: object
          oneOf:
            - $ref: '#/components/schemas/PriceInfo'
          description: <em>pricing details</em><br>contains the pricing details of the product or service featured in the result
          nullable: true
        is_paid:
          type: boolean
          description: <em>indicates whether the element is an ad</em>
          nullable: true
    SerpApiKnowledgeGraphHotelsBookingItemElementItem:
      type: object
      allOf:
        - type: object
          oneOf:
            - $ref: '#/components/schemas/BaseSerpApiKnowledgeGraphElementItem'
          nullable: true
        - type: object
          properties:
            rank_group:
              type: integer
              description: <em>group rank in SERP</em><br>position within a group of elements with identical <code>type</code> values<br>positions of elements with different <code>type</code> values are omitted from <code>rank_group</code>
              nullable: true
            rank_absolute:
              type: integer
              description: <em>absolute rank in SERP</em><br>absolute position among all the elements in SERP
              nullable: true
            title:
              type: string
              description: <em>title of a given link element</em>
              nullable: true
            date_from:
              type: string
              description: <em>starting date of stay</em><br>in the format “year-month-date”<br>example:<br>2019-11-15
              nullable: true
            date_to:
              type: string
              description: <em>ending date of stay</em><br>in the format “year-month-date”<br>example:<br>2019-11-17
              nullable: true
            data_attrid:
              type: string
              description: <em>google defined data attribute ID</em><br>example:<br><code>kc:/local:hotel booking</code>
              nullable: true
            items:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/KnowledgeGraphHotelsBookingElement'
                nullable: true
              description: '<em>popular keywords relevant to the initial search query</em><br>if there are none, equals <code>null</code>'
              nullable: true
    AiModeAiOverviewReferenceInfo:
      type: object
      properties:
        type:
          type: string
          description: type of element
          nullable: true
        position:
          type: string
          description: '<em>the alignment of the element in SERP</em><br>can take the following values:<br><code>left</code>, <code>right</code>'
          nullable: true
        source:
          type: string
          description: <em>reference source name or title</em>
          nullable: true
        domain:
          type: string
          description: <em>domain name of the reference</em>
          nullable: true
        url:
          type: string
          description: <em>link URL</em>
          nullable: true
        title:
          type: string
          description: <em>link anchor text</em>
          nullable: true
        text:
          type: string
          description: <em>text of the component</em>
          nullable: true
    SerpApiAiOverviewElementItem:
      type: object
      allOf:
        - type: object
          oneOf:
            - $ref: '#/components/schemas/BaseSerpApiAiOverviewElementItem'
          nullable: true
        - type: object
          properties:
            title:
              type: string
              description: <em>title of the element</em>
              nullable: true
            text:
              type: string
              description: <em>additional text of the element in SERP</em>
              nullable: true
            markdown:
              type: string
              description: <em>content of the element in markdown format</em>
              nullable: true
            links:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/LinkElement'
                nullable: true
              description: <em>website links featured in the element</em>
              nullable: true
            images:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AiModeImagesElementInfo'
                nullable: true
              description: '<em>images of the element</em><br>if there is none, equals <code>null</code>'
              nullable: true
            references:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AiModeAiOverviewReferenceInfo'
                nullable: true
              description: <em>references relevant to the element</em><br>includes references to webpages that were used to generate the <code>ai_overview_element</code>
              nullable: true
    AiOverviewExpandedComponent:
      type: object
      properties:
        type:
          type: string
          description: type of element
          nullable: true
        title:
          type: string
          description: <em>reference page title</em>
          nullable: true
        text:
          type: string
          description: <em>reference text</em><br>text snippet from the page that was used to generate the <code>ai_overview_element</code>
          nullable: true
        markdown:
          type: string
          description: <em>content of the element in markdown format</em>
          nullable: true
        images:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/AiModeImagesElementInfo'
            nullable: true
          description: '<em>images of the element</em><br>if there is none, equals <code>null</code>'
          nullable: true
        links:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/LinkElement'
            nullable: true
          description: '<em>sitelinks</em><br>the links shown below some of Google''s search results<br>if there are none, equals <code>null</code>'
          nullable: true
        references:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/AiModeAiOverviewReferenceInfo'
            nullable: true
          description: <em>references relevant to the element</em><br>includes references to webpages that were used to generate the <code>ai_overview_element</code>
          nullable: true
    SerpApiAiOverviewExpandedElementItem:
      type: object
      allOf:
        - type: object
          oneOf:
            - $ref: '#/components/schemas/BaseSerpApiAiOverviewElementItem'
          nullable: true
        - type: object
          properties:
            title:
              type: string
              description: <em>title of the element</em>
              nullable: true
            text:
              type: string
              description: <em>additional text of the element in SERP</em>
              nullable: true
            components:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AiOverviewExpandedComponent'
                nullable: true
              description: <em>array of components of the element</em>
              nullable: true
            references:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AiModeAiOverviewReferenceInfo'
                nullable: true
              description: <em>references relevant to the element</em><br>includes references to webpages that were used to generate the <code>ai_overview_element</code>
              nullable: true
    SerpApiAiOverviewVideoElementItem:
      type: object
      allOf:
        - type: object
          oneOf:
            - $ref: '#/components/schemas/BaseSerpApiAiOverviewElementItem'
          nullable: true
        - type: object
          properties:
            title:
              type: string
              description: <em>title of the element</em>
              nullable: true
            snippet:
              type: string
              description: <em>additional information for the video</em>
              nullable: true
            url:
              type: string
              description: <em>reference page URL</em>
              nullable: true
            domain:
              type: string
              description: <em>domain in link</em>
              nullable: true
            image_url:
              type: string
              description: <em>URL of the image</em>
              nullable: true
            source:
              type: string
              description: <em>web source of the shopping element</em><br>indicates the source of information included in the element
              nullable: true
            date:
              type: string
              description: '<em>date when the video was published or indexed</em><br>example: <br><code>Apr 26, 2024</code>'
              nullable: true
            timestamp:
              type: string
              description: '<em>date and time when the video was published or indexed</em><br>in the UTC format: "yyyy-mm-dd hh-mm-ss +00:00"<br>example:<br><code class="long-string">2019-11-15 12:57:46 +00:00</code>'
              nullable: true
    SerpApiAiOverviewTableElementItem:
      type: object
      allOf:
        - type: object
          oneOf:
            - $ref: '#/components/schemas/BaseSerpApiAiOverviewElementItem'
          nullable: true
        - type: object
          properties:
            markdown:
              type: string
              description: <em>content of the element in markdown format</em>
              nullable: true
            table:
              type: object
              oneOf:
                - $ref: '#/components/schemas/Table'
              description: <em>table element</em>
              nullable: true
    SerpApiKnowledgeGraphAiOverviewItemElementItem:
      type: object
      allOf:
        - type: object
          oneOf:
            - $ref: '#/components/schemas/BaseSerpApiKnowledgeGraphElementItem'
          nullable: true
        - type: object
          properties:
            asynchronous_ai_overview:
              type: boolean
              description: '<em>indicates whether the element is loaded asynchronously</em><br>if <code>true</code>, the <code>ai_overview</code> element is loaded asynchronously;<br>if <code>false</code>, the <code>ai_overview</code> element is loaded from cache;<br>to obtain the content of <code>ai_overview</code> elements, use the <code>load_async_ai_overview</code> parameter in the POST request'
              nullable: true
            items:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/BaseSerpApiAiOverviewElementItem'
                nullable: true
              description: <em>contains results featured in the 'hotels_pack' element of SERP</em>
              nullable: true
            references:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AiModeAiOverviewReferenceInfo'
                nullable: true
              description: <em>additional references relevant to the item</em><br>includes references to webpages that may have been used to generate the <code>ai_overview</code>
              nullable: true
    KnowledgeGraphSerpElementItem:
      type: object
      allOf:
        - type: object
          oneOf:
            - $ref: '#/components/schemas/BaseSerpApiElementItem'
          nullable: true
        - type: object
          properties:
            rank_group:
              type: integer
              description: <em>group rank in SERP</em><br>position within a group of elements with identical <code>type</code> values<br>positions of elements with different <code>type</code> values are omitted from <code>rank_group</code>
              nullable: true
            rank_absolute:
              type: integer
              description: <em>absolute rank in SERP</em><br>absolute position among all the elements in SERP
              nullable: true
            title:
              type: string
              description: <em>title of the result in SERP</em>
              nullable: true
            subtitle:
              type: string
              description: <em>subtitle of the item</em>
              nullable: true
            description:
              type: string
              description: <em>description of the results element in SERP</em>
              nullable: true
            card_id:
              type: string
              description: <em>card id</em>
              nullable: true
            url:
              type: string
              description: <em> relevant URL in SERP</em>
              nullable: true
            image_url:
              type: string
              description: <em>URL of the image</em><br>the URL leading to the image on the original resource or DataForSEO storage (in case the original source is not available)
              nullable: true
            logo_url:
              type: string
              description: <em>URL of the logo from knowledge graph</em>
              nullable: true
            cid:
              type: string
              description: <em>google-defined client id</em><br>unique id of a local establishment;<br>can be used with <a href="/v3/reviews/google/overview/?php" target="_blank" rel="noopener noreferrer">Google Reviews API</a> to get a full list of reviews
              nullable: true
            items:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/BaseSerpApiKnowledgeGraphElementItem'
                nullable: true
              description: '<em>additional items present in the element</em><br>if there are none, equals <code>null</code>'
              nullable: true
    AdLinkElement:
      type: object
      properties:
        type:
          type: string
          description: type of element
          nullable: true
        title:
          type: string
          description: <em>title of the element in SERP</em>
          nullable: true
        description:
          type: string
          description: <em>description of the link</em>
          nullable: true
        url:
          type: string
          description: <em>reference page URL</em>
          nullable: true
        domain:
          type: string
          description: <em>domain where a link points</em>
          nullable: true
        ad_aclk:
          type: string
          description: <em>the identifier of the ad</em>
          nullable: true
    FaqBoxElement:
      type: object
      properties:
        type:
          type: string
          description: type of element
          nullable: true
        title:
          type: string
          description: <em>title of the link</em>
          nullable: true
        description:
          type: string
          description: <em>description of the hotel booking element</em>
          nullable: true
        links:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/LinkElement'
            nullable: true
          description: <em>link of the element</em>
          nullable: true
      deprecated: true
    FaqBox:
      type: object
      properties:
        type:
          type: string
          description: type of element
          nullable: true
        items:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/FaqBoxElement'
            nullable: true
          description: <em>contains arrays of specific images</em>
          nullable: true
      deprecated: true
    RelatedResult:
      type: object
      properties:
        type:
          type: string
          description: type of element
          nullable: true
        page:
          type: integer
          description: <em>search results page number</em><br>indicates the number of the SERP page on which the element is located
          nullable: true
        xpath:
          type: string
          description: <em>the <a href="https://en.wikipedia.org/wiki/XPath">XPath</a> of the element</em>
          nullable: true
        domain:
          type: string
          description: <em>website domain</em>
          nullable: true
        title:
          type: string
          description: <em>title of a given link element</em>
          nullable: true
        url:
          type: string
          description: <em>URL</em>
          nullable: true
        cache_url:
          type: string
          description: <em>cached version of the page</em>
          nullable: true
        related_search_url:
          type: string
          description: <em>URL to a similar search</em><br>URL to a new search for the same keyword(s) <a href="https://support.google.com/websearch/answer/2466433?hl=en#:~:text=Search%20for%20related%20sites">on related sites</a>
          nullable: true
        breadcrumb:
          type: string
          description: <em>breadcrumb in SERP</em>
          nullable: true
        website_name:
          type: string
          description: <em>name of the website in the ad element</em>
          nullable: true
        is_image:
          type: boolean
          description: <em>indicates whether the element contains an_<code class="prettyprint">image</code></em><br><strong>Note:</strong> this check no longer appears in SERPn
          nullable: true
        is_video:
          type: boolean
          description: <em>indicates whether the element contains a <code class="prettyprint">video</code></em><br><strong>Note:</strong> this check no longer appears in SERP
          nullable: true
        checks:
          type: array
          items:
            type: string
            description: <em>indicates whether the element contains an_<code class="prettyprint">image</code></em><br><strong>Note:</strong> this check no longer appears in SERPn
            nullable: true
          description: '<em>array of properties detected for the SERP element</em><br>lists the properties that are true for this element<br>each value in the array represents a detected property <br>example:<br>if <code>is_image</code> is present in the array, the element contains an image<br>possible values in the array:<br><code>is_image</code>, <code>is_video</code>, <code>is_featured_snippet</code>, <code>amp_version</code>, <code>is_malicious</code>, <code>is_web_story</code>, <code>is_highly_cited</code><br>equals <code>null</code> if none of the properties are detected for the element<br>learn more about the <code>checks</code> array in <a href="https://dataforseo.com/help-center/whats-a-checks-array-in-the-google-organic-serp-api" target="_blank">this Help Center article</a>'
          nullable: true
        description:
          type: string
          description: <em>description of the results element in SERP</em>
          nullable: true
        pre_snippet:
          type: string
          description: <em>includes additional information appended before the result description in SERP</em>
          nullable: true
        extended_snippet:
          type: string
          description: <em>includes additional information appended after the result description in SERP</em>
          nullable: true
        images:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/AiModeImagesElementInfo'
            nullable: true
          description: '<em>images of the component</em><br>if there are none, equals <code>null</code>'
          nullable: true
        amp_version:
          type: boolean
          description: <em>Accelerated Mobile Pages</em><br>indicates whether an item has the Accelerated Mobile Page (AMP) version
          nullable: true
        rating:
          type: object
          oneOf:
            - $ref: '#/components/schemas/RatingInfo'
          description: '<em>the item''s rating </em><br>the popularity rate based on reviews and displayed in SERP;<br>if there is none, equals <code>null</code>'
          nullable: true
        price:
          type: object
          oneOf:
            - $ref: '#/components/schemas/PriceInfo'
          description: <em>price of booking a place for the specified dates of stay</em>
          nullable: true
        highlighted:
          type: array
          items:
            type: string
            nullable: true
          description: <em>words highlighted in bold within the results <code>description</code></em>
          nullable: true
        about_this_result:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AboutThisResultElement'
          description: <em>contains information from the 'About this result' panel</em><br><strong>Note:</strong> this object is deprecated and always returns <code>null</code>
          nullable: true
          deprecated: true
        timestamp:
          type: string
          description: '<em>date and time when the result was published</em><br>in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”<br>example:<br><code class="long-string">2019-11-15 12:57:46 +00:00</code>'
          nullable: true
    TopStoriesElement:
      type: object
      properties:
        type:
          type: string
          description: type of element
          nullable: true
        source:
          type: string
          description: <em>reference source name or title</em>
          nullable: true
        domain:
          type: string
          description: <em>domain where a link points</em>
          nullable: true
        title:
          type: string
          description: <em>title of a given link element</em>
          nullable: true
        date:
          type: string
          description: <em>the date when the page source of the element was published</em>
          nullable: true
        amp_version:
          type: boolean
          description: <em>Accelerated Mobile Pages</em><br>indicates whether an item has the Accelerated Mobile Page (AMP) version
          nullable: true
        timestamp:
          type: string
          description: '<em>date and time when the result was published</em><br>in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”<br>example:<br><code class="long-string">2019-11-15 12:57:46 +00:00</code>'
          nullable: true
        url:
          type: string
          description: <em>source URL</em>
          nullable: true
        image_url:
          type: string
          description: <em>URL of the image</em><br>the URL leading to the image on the original resource or DataForSEO storage (in case the original source is not available)
          nullable: true
        badges:
          type: array
          items:
            type: string
            nullable: true
          description: <em>badges relevant to the element</em>
          nullable: true
    TopStoriesSerpElementItem:
      type: object
      allOf:
        - type: object
          oneOf:
            - $ref: '#/components/schemas/BaseSerpApiElementItem'
          nullable: true
        - type: object
          properties:
            rank_group:
              type: integer
              description: <em>group rank in SERP</em><br>position within a group of elements with identical <code>type</code> values;<br>positions of elements with different <code>type</code> values are omitted from <code>rank_group</code>;<br>always equals <code>0</code> for <code>desktop</code>
              nullable: true
            rank_absolute:
              type: integer
              description: <em>absolute rank in SERP</em><br>absolute position among all the elements in SERP<br>always equals <code>0</code> for <code>desktop</code>
              nullable: true
            title:
              type: string
              description: <em>title of the row</em>
              nullable: true
            items:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/TopStoriesElement'
                nullable: true
              description: <em>contains arrays of elements available in the list</em>
              nullable: true
    SerpApiPeopleAlsoAskExpandedElementItem:
      type: object
      allOf:
        - type: object
          oneOf:
            - $ref: '#/components/schemas/BaseSerpApiPeopleAlsoAskExpandedElementItem'
          nullable: true
        - type: object
          properties:
            featured_title:
              type: string
              description: <em>the title of the featured snippets source page</em>
              nullable: true
            url:
              type: string
              description: <em>relevant URL</em>
              nullable: true
            domain:
              type: string
              description: <em>source domain</em>
              nullable: true
            title:
              type: string
              description: <em>title of the carousel item</em>
              nullable: true
            description:
              type: string
              description: <i>description</i>
              nullable: true
            images:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AiModeImagesElementInfo'
                nullable: true
              description: <em>images of the element</em>
              nullable: true
            timestamp:
              type: string
              description: '<em>date and time when the result was published</em><br>in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”<br>example:<br><code class="long-string">2019-11-15 12:57:46 +00:00</code>'
              nullable: true
            table:
              type: object
              oneOf:
                - $ref: '#/components/schemas/Table'
              description: '<em>results table</em><br>if there are none, equals <code>null</code>'
              nullable: true
    SerpApiPeopleAlsoAskAiOverviewExpandedElementItem:
      type: object
      allOf:
        - type: object
          oneOf:
            - $ref: '#/components/schemas/BaseSerpApiPeopleAlsoAskExpandedElementItem'
          nullable: true
        - type: object
          properties:
            items:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/BaseSerpApiAiOverviewElementItem'
                nullable: true
              description: <em>items present in the element</em>
              nullable: true
            references:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AiModeAiOverviewReferenceInfo'
                nullable: true
              description: <em>additional references relevant to the item</em><br>includes references to webpages that may have been used to generate the <code>ai_overview</code>
              nullable: true
            asynchronous_ai_overview:
              type: boolean
              description: '<em>indicates whether the element is loaded asynchronously</em><br>if <code>true</code>, the <code>people_also_ask_ai_overview_expanded_element</code> element is loaded asynchronously;<br>if <code>false</code>, the <code>people_also_ask_ai_overview_expanded_element</code> element is loaded from cache'
              nullable: true
    PeopleAlsoAskElement:
      type: object
      properties:
        type:
          type: string
          description: type of element
          nullable: true
        title:
          type: string
          description: <em>title of a given link element</em>
          nullable: true
        seed_question:
          type: string
          description: <em>question that triggered additional expanded elements</em>
          nullable: true
        xpath:
          type: string
          description: <em>the <a href="https://en.wikipedia.org/wiki/XPath">XPath</a> of the element</em>
          nullable: true
        expanded_element:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/BaseSerpApiPeopleAlsoAskExpandedElementItem'
            nullable: true
          description: <em>expanded element</em>
          nullable: true
    PeopleAlsoAskSerpElementItem:
      type: object
      allOf:
        - type: object
          oneOf:
            - $ref: '#/components/schemas/BaseSerpApiElementItem'
          nullable: true
        - type: object
          properties:
            rank_group:
              type: integer
              description: <em>group rank in SERP</em><br>position within a group of elements with identical <code>type</code> values;<br>positions of elements with different <code>type</code> values are omitted from <code>rank_group</code>;<br>always equals <code>0</code> for <code>desktop</code>
              nullable: true
            rank_absolute:
              type: integer
              description: <em>absolute rank in SERP</em><br>absolute position among all the elements in SERP<br>always equals <code>0</code> for <code>desktop</code>
              nullable: true
            items:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/PeopleAlsoAskElement'
                nullable: true
              description: <em>contains arrays of elements available in the list</em>
              nullable: true
    PeopleAlsoSearchSerpElementItem:
      type: object
      allOf:
        - type: object
          oneOf:
            - $ref: '#/components/schemas/BaseSerpApiElementItem'
          nullable: true
        - type: object
          properties:
            rank_group:
              type: integer
              description: <em>group rank in SERP</em><br>position within a group of elements with identical <code>type</code> values;<br>positions of elements with different <code>type</code> values are omitted from <code>rank_group</code>;<br>always equals <code>0</code> for <code>desktop</code>
              nullable: true
            rank_absolute:
              type: integer
              description: <em>absolute rank in SERP</em><br>absolute position among all the elements in SERP<br>always equals <code>0</code> for <code>desktop</code>
              nullable: true
            title:
              type: string
              description: <em>title of the row</em>
              nullable: true
            items:
              type: array
              items:
                type: string
                nullable: true
              description: <em>contains arrays of elements available in the list</em>
              nullable: true
    RelatedImageSearchesElement:
      type: object
      properties:
        type:
          type: string
          description: type of element
          nullable: true
        title:
          type: string
          description: <em>title of the result in SERP</em>
          nullable: true
        alt:
          type: string
          description: <i>alt tag of the image</i>
          nullable: true
        url:
          type: string
          description: <em>URL</em>
          nullable: true
        image_url:
          type: string
          description: <em>URL of the image</em><br>the URL leading to the image on the original resource or DataForSEO storage (in case the original source is not available)
          nullable: true
      deprecated: true
    ImagesSerpElementItem:
      type: object
      allOf:
        - type: object
          oneOf:
            - $ref: '#/components/schemas/BaseSerpApiElementItem'
          nullable: true
        - type: object
          properties:
            rank_group:
              type: integer
              description: <em>group rank in SERP</em><br>position within a group of elements with identical <code>type</code> values;<br>positions of elements with different <code>type</code> values are omitted from <code>rank_group</code>;<br>always equals <code>0</code> for <code>desktop</code>
              nullable: true
            rank_absolute:
              type: integer
              description: <em>absolute rank in SERP</em><br>absolute position among all the elements in SERP<br>always equals <code>0</code> for <code>desktop</code>
              nullable: true
            title:
              type: string
              description: <em>title of the row</em>
              nullable: true
            url:
              type: string
              description: <i>URL of the third-party review source</i>
              nullable: true
            items:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AiModeImagesElementInfo'
                nullable: true
              description: <em>contains arrays of elements available in the list</em>
              nullable: true
            related_image_searches:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/RelatedImageSearchesElement'
                nullable: true
              description: <em>contains keywords and images related to the specified search term</em><br><strong>Note:</strong> this array is deprecated and always returns <code>null</code>
              nullable: true
              deprecated: true
    TwitterElement:
      type: object
      properties:
        type:
          type: string
          description: type of element
          nullable: true
        tweet:
          type: string
          description: <i>tweet message</i>
          nullable: true
        date:
          type: string
          description: <em>the date when the page source of the element was published</em>
          nullable: true
        timestamp:
          type: string
          description: '<em>date and time when the result was published</em><br>in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”<br>example:<br><code class="long-string">2019-11-15 12:57:46 +00:00</code>'
          nullable: true
        url:
          type: string
          description: <em>source URL</em>
          nullable: true
    TwitterSerpElementItem:
      type: object
      allOf:
        - type: object
          oneOf:
            - $ref: '#/components/schemas/BaseSerpApiElementItem'
          nullable: true
        - type: object
          properties:
            rank_group:
              type: integer
              description: <em>group rank in SERP</em><br>position within a group of elements with identical <code>type</code> values;<br>positions of elements with different <code>type</code> values are omitted from <code>rank_group</code>;<br>always equals <code>0</code> for <code>desktop</code>
              nullable: true
            rank_absolute:
              type: integer
              description: <em>absolute rank in SERP</em><br>absolute position among all the elements in SERP<br>always equals <code>0</code> for <code>desktop</code>
              nullable: true
            title:
              type: string
              description: <em>title of the row</em>
              nullable: true
            url:
              type: string
              description: <i>URL of the third-party review source</i>
              nullable: true
            items:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/TwitterElement'
                nullable: true
              description: <em>contains arrays of elements available in the list</em>
              nullable: true
    GoogleReviewsSerpElementItem:
      type: object
      allOf:
        - type: object
          oneOf:
            - $ref: '#/components/schemas/BaseSerpApiElementItem'
          nullable: true
        - type: object
          properties:
            rank_group:
              type: integer
              description: <em>group rank in SERP</em><br>position within a group of elements with identical <code>type</code> values;<br>positions of elements with different <code>type</code> values are omitted from <code>rank_group</code>;<br>always equals <code>0</code> for <code>desktop</code>
              nullable: true
            rank_absolute:
              type: integer
              description: <em>absolute rank in SERP</em><br>absolute position among all the elements in SERP<br>always equals <code>0</code> for <code>desktop</code>
              nullable: true
            reviews_count:
              type: integer
              description: <i>the number of reviews</i>
              format: int64
              nullable: true
            rating:
              type: object
              oneOf:
                - $ref: '#/components/schemas/RatingInfo'
              description: '<em>the element''s rating</em><br>the popularity rate based on reviews and displayed in SERP;<br>if there is none, equals <code>null</code>'
              nullable: true
            place_id:
              type: string
              description: <em>the identifier of a place</em>
              nullable: true
            feature:
              type: string
              description: <i>the additional feature of the review</i>
              nullable: true
            cid:
              type: string
              description: <em>google-defined client id</em>
              nullable: true
    JobsElement:
      type: object
      properties:
        type:
          type: string
          description: type of element
          nullable: true
        title:
          type: string
          description: <em>title of a given link element</em>
          nullable: true
        description:
          type: string
          description: <em>link description</em>
          nullable: true
        location:
          type: string
          description: <em>location for which the job vacancy is posted</em>
          nullable: true
        author:
          type: string
          description: <em>author</em>
          nullable: true
        job_posted_time:
          type: string
          description: <i>the time when the job was posted</i>
          nullable: true
        timestamp:
          type: string
          description: '<em>date and time when the result was published</em><br>in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”<br>example:<br><code class="long-string">2019-11-15 12:57:46 +00:00</code>'
          nullable: true
        contract_type:
          type: string
          description: <em>contract type</em>
          nullable: true
        salary:
          type: string
          description: <i>salary</i>
          nullable: true
        url:
          type: string
          description: <em>source URL</em>
          nullable: true
    JobsSerpElementItem:
      type: object
      allOf:
        - type: object
          oneOf:
            - $ref: '#/components/schemas/BaseSerpApiElementItem'
          nullable: true
        - type: object
          properties:
            rank_group:
              type: integer
              description: <em>group rank in SERP</em><br>position within a group of elements with identical <code>type</code> values;<br>positions of elements with different <code>type</code> values are omitted from <code>rank_group</code>;<br>always equals <code>0</code> for <code>desktop</code>
              nullable: true
            rank_absolute:
              type: integer
              description: <em>absolute rank in SERP</em><br>absolute position among all the elements in SERP<br>always equals <code>0</code> for <code>desktop</code>
              nullable: true
            title:
              type: string
              description: <em>title of the row</em>
              nullable: true
            url:
              type: string
              description: <i>URL of the third-party review source</i>
              nullable: true
            items:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/JobsElement'
                nullable: true
              description: <em>contains arrays of elements available in the list</em>
              nullable: true
    MapSerpElementItem:
      type: object
      allOf:
        - type: object
          oneOf:
            - $ref: '#/components/schemas/BaseSerpApiElementItem'
          nullable: true
        - type: object
          properties:
            rank_group:
              type: integer
              description: <em>group rank in SERP</em><br>position within a group of elements with identical <code>type</code> values;<br>positions of elements with different <code>type</code> values are omitted from <code>rank_group</code>;<br>always equals <code>0</code> for <code>desktop</code>
              nullable: true
            rank_absolute:
              type: integer
              description: <em>absolute rank in SERP</em><br>absolute position among all the elements in SERP<br>always equals <code>0</code> for <code>desktop</code>
              nullable: true
            title:
              type: string
              description: <em>title of the row</em>
              nullable: true
            url:
              type: string
              description: <i>URL of the third-party review source</i>
              nullable: true
    AppElement:
      type: object
      properties:
        type:
          type: string
          description: type of element
          nullable: true
        title:
          type: string
          description: <em>title of a given link element</em>
          nullable: true
        description:
          type: string
          description: <em>link description</em>
          nullable: true
        url:
          type: string
          description: <em>source URL</em>
          nullable: true
        price:
          type: object
          oneOf:
            - $ref: '#/components/schemas/PriceInfo'
          description: <em>price indicated in the element</em>
          nullable: true
    AppSerpElementItem:
      type: object
      allOf:
        - type: object
          oneOf:
            - $ref: '#/components/schemas/BaseSerpApiElementItem'
          nullable: true
        - type: object
          properties:
            rank_group:
              type: integer
              description: <em>group rank in SERP</em><br>position within a group of elements with identical <code>type</code> values;<br>positions of elements with different <code>type</code> values are omitted from <code>rank_group</code>;<br>always equals <code>0</code> for <code>desktop</code>
              nullable: true
            rank_absolute:
              type: integer
              description: <em>absolute rank in SERP</em><br>absolute position among all the elements in SERP<br>always equals <code>0</code> for <code>desktop</code>
              nullable: true
            items:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AppElement'
                nullable: true
              description: <em>contains arrays of elements available in the list</em>
              nullable: true
    LocalPackSerpElementItem:
      type: object
      allOf:
        - type: object
          oneOf:
            - $ref: '#/components/schemas/BaseSerpApiElementItem'
          nullable: true
        - type: object
          properties:
            rank_group:
              type: integer
              description: <em>group rank in SERP</em><br>position within a group of elements with identical <code>type</code> values;<br>positions of elements with different <code>type</code> values are omitted from <code>rank_group</code>;<br>always equals <code>0</code> for <code>desktop</code>
              nullable: true
            rank_absolute:
              type: integer
              description: <em>absolute rank in SERP</em><br>absolute position among all the elements in SERP<br>always equals <code>0</code> for <code>desktop</code>
              nullable: true
            title:
              type: string
              description: <em>title of the row</em>
              nullable: true
            description:
              type: string
              description: <em>description of the link</em>
              nullable: true
            domain:
              type: string
              description: <em>domain of the website hosting the video</em>
              nullable: true
            phone:
              type: string
              description: <em>phone number</em>
              nullable: true
            booking_url:
              type: string
              description: <em>URL of the booking page</em>
              nullable: true
            url:
              type: string
              description: <i>URL of the third-party review source</i>
              nullable: true
            is_paid:
              type: boolean
              description: <em>indicates whether the element is an ad</em>
              nullable: true
            rating:
              type: object
              oneOf:
                - $ref: '#/components/schemas/RatingInfo'
              description: '<em>the element''s rating</em><br>the popularity rate based on reviews and displayed in SERP;<br>if there is none, equals <code>null</code>'
              nullable: true
            cid:
              type: string
              description: <em>google-defined client id</em>
              nullable: true
    SerpApiCarouselElement:
      type: object
      properties:
        type:
          type: string
          description: type of element
          nullable: true
        title:
          type: string
          description: <em>title of a given link element</em>
          nullable: true
        subtitle:
          type: string
          description: <em>subtitle of the element</em>
          nullable: true
        image_url:
          type: string
          description: <em>URL of the image</em><br>the URL leading to the image on the original resource or DataForSEO storage (in case the original source is not available)
          nullable: true
    CarouselSerpElementItem:
      type: object
      allOf:
        - type: object
          oneOf:
            - $ref: '#/components/schemas/BaseSerpApiElementItem'
          nullable: true
        - type: object
          properties:
            rank_group:
              type: integer
              description: <em>group rank in SERP</em><br>position within a group of elements with identical <code>type</code> values;<br>positions of elements with different <code>type</code> values are omitted from <code>rank_group</code>;<br>always equals <code>0</code> for <code>desktop</code>
              nullable: true
            rank_absolute:
              type: integer
              description: <em>absolute rank in SERP</em><br>absolute position among all the elements in SERP<br>always equals <code>0</code> for <code>desktop</code>
              nullable: true
            title:
              type: string
              description: <em>title of the row</em>
              nullable: true
            items:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpApiCarouselElement'
                nullable: true
              description: <em>contains arrays of elements available in the list</em>
              nullable: true
    VideoSerpElementItem:
      type: object
      allOf:
        - type: object
          oneOf:
            - $ref: '#/components/schemas/BaseSerpApiElementItem'
          nullable: true
        - type: object
          properties:
            rank_group:
              type: integer
              description: <em>group rank in SERP</em><br>position within a group of elements with identical <code>type</code> values;<br>positions of elements with different <code>type</code> values are omitted from <code>rank_group</code>;<br>always equals <code>0</code> for <code>desktop</code>
              nullable: true
            rank_absolute:
              type: integer
              description: <em>absolute rank in SERP</em><br>absolute position among all the elements in SERP<br>always equals <code>0</code> for <code>desktop</code>
              nullable: true
            items:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/VideoElement'
                nullable: true
              description: <em>contains arrays of elements available in the list</em>
              nullable: true
    AnswerBoxSerpElementItem:
      type: object
      allOf:
        - type: object
          oneOf:
            - $ref: '#/components/schemas/BaseSerpApiElementItem'
          nullable: true
        - type: object
          properties:
            rank_group:
              type: integer
              description: <em>group rank in SERP</em><br>position within a group of elements with identical <code>type</code> values;<br>positions of elements with different <code>type</code> values are omitted from <code>rank_group</code>;<br>always equals <code>0</code> for <code>desktop</code>
              nullable: true
            rank_absolute:
              type: integer
              description: <em>absolute rank in SERP</em><br>absolute position among all the elements in SERP<br>always equals <code>0</code> for <code>desktop</code>
              nullable: true
            text:
              type: array
              items:
                type: string
                nullable: true
              description: '<em>text</em><br>if there is none, equals <code>null</code>'
              nullable: true
            links:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/LinkElement'
                nullable: true
              description: '<em>sitelinks</em><br>the links shown below some of Google''s search results<br>if there are none, equals <code>null</code>'
              nullable: true
    ShoppingElement:
      type: object
      properties:
        type:
          type: string
          description: type of element
          nullable: true
        title:
          type: string
          description: <em>title of a given link element</em>
          nullable: true
        price:
          type: object
          oneOf:
            - $ref: '#/components/schemas/PriceInfo'
          description: <em>price indicated in the element</em>
          nullable: true
        source:
          type: string
          description: <em>reference source name or title</em>
          nullable: true
        description:
          type: string
          description: <em>link description</em>
          nullable: true
        marketplace:
          type: string
          description: <em>merchant account provider</em><br>commerce site that hosts products or websites of individual sellers under the same merchant account<br>example:<br><code>by Google</code>
          nullable: true
        marketplace_url:
          type: string
          description: <em>relevant marketplace URL</em><br>URL of the page on the marketplace website where the product is hosted
          nullable: true
        url:
          type: string
          description: <em>source URL</em>
          nullable: true
        rating:
          type: object
          oneOf:
            - $ref: '#/components/schemas/RatingInfo'
          description: '<em>the item''s rating </em><br>the popularity rate based on reviews and displayed in SERP;<br>if there is none, equals <code>null</code>'
          nullable: true
    ShoppingSerpElementItem:
      type: object
      allOf:
        - type: object
          oneOf:
            - $ref: '#/components/schemas/BaseSerpApiElementItem'
          nullable: true
        - type: object
          properties:
            rank_group:
              type: integer
              description: <em>group rank in SERP</em><br>position within a group of elements with identical <code>type</code> values;<br>positions of elements with different <code>type</code> values are omitted from <code>rank_group</code>;<br>always equals <code>0</code> for <code>desktop</code>
              nullable: true
            rank_absolute:
              type: integer
              description: <em>absolute rank in SERP</em><br>absolute position among all the elements in SERP<br>always equals <code>0</code> for <code>desktop</code>
              nullable: true
            title:
              type: string
              description: <em>title of the row</em>
              nullable: true
            items:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/ShoppingElement'
                nullable: true
              description: <em>contains arrays of elements available in the list</em>
              nullable: true
    GoogleFlightsElement:
      type: object
      properties:
        type:
          type: string
          description: type of element
          nullable: true
        description:
          type: string
          description: <em>link description</em>
          nullable: true
        url:
          type: string
          description: <em>source URL</em>
          nullable: true
    GoogleFlightsSerpElementItem:
      type: object
      allOf:
        - type: object
          oneOf:
            - $ref: '#/components/schemas/BaseSerpApiElementItem'
          nullable: true
        - type: object
          properties:
            rank_group:
              type: integer
              description: <em>group rank in SERP</em><br>position within a group of elements with identical <code>type</code> values;<br>positions of elements with different <code>type</code> values are omitted from <code>rank_group</code>;<br>always equals <code>0</code> for <code>desktop</code>
              nullable: true
            rank_absolute:
              type: integer
              description: <em>absolute rank in SERP</em><br>absolute position among all the elements in SERP<br>always equals <code>0</code> for <code>desktop</code>
              nullable: true
            title:
              type: string
              description: <em>title of the row</em>
              nullable: true
            url:
              type: string
              description: <i>URL of the third-party review source</i>
              nullable: true
            items:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/GoogleFlightsElement'
                nullable: true
              description: <em>contains arrays of elements available in the list</em>
              nullable: true
    EventsElement:
      type: object
      properties:
        type:
          type: string
          description: type of element
          nullable: true
        title:
          type: string
          description: <em>title of a given link element</em>
          nullable: true
        snippet:
          type: string
          description: <em>text alongside the link title</em>
          nullable: true
        url:
          type: string
          description: <em>source URL</em>
          nullable: true
    EventsSerpElementItem:
      type: object
      allOf:
        - type: object
          oneOf:
            - $ref: '#/components/schemas/BaseSerpApiElementItem'
          nullable: true
        - type: object
          properties:
            rank_group:
              type: integer
              description: <em>group rank in SERP</em><br>position within a group of elements with identical <code>type</code> values;<br>positions of elements with different <code>type</code> values are omitted from <code>rank_group</code>;<br>always equals <code>0</code> for <code>desktop</code>
              nullable: true
            rank_absolute:
              type: integer
              description: <em>absolute rank in SERP</em><br>absolute position among all the elements in SERP<br>always equals <code>0</code> for <code>desktop</code>
              nullable: true
            title:
              type: string
              description: <em>title of the row</em>
              nullable: true
            url:
              type: string
              description: <i>URL of the third-party review source</i>
              nullable: true
            items:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/EventsElement'
                nullable: true
              description: <em>contains arrays of elements available in the list</em>
              nullable: true
    RelatedSearchesSerpElementItem:
      type: object
      allOf:
        - type: object
          oneOf:
            - $ref: '#/components/schemas/BaseSerpApiElementItem'
          nullable: true
        - type: object
          properties:
            rank_group:
              type: integer
              description: <em>group rank in SERP</em><br>position within a group of elements with identical <code>type</code> values;<br>positions of elements with different <code>type</code> values are omitted from <code>rank_group</code>;<br>always equals <code>0</code> for <code>desktop</code>
              nullable: true
            rank_absolute:
              type: integer
              description: <em>absolute rank in SERP</em><br>absolute position among all the elements in SERP<br>always equals <code>0</code> for <code>desktop</code>
              nullable: true
            items:
              type: array
              items:
                type: string
                nullable: true
              description: <em>contains arrays of elements available in the list</em>
              nullable: true
    MultiCarouselElement:
      type: object
      properties:
        type:
          type: string
          description: type of element
          nullable: true
        title:
          type: string
          description: <em>title of a given link element</em>
          nullable: true
        multi_carousel_snippets:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/SerpApiCarouselElement'
            nullable: true
          description: '<em><code>multi_carousel_snippet</code> results</em><br>if there are none, equals <code>null</code>'
          nullable: true
    MultiCarouselSerpElementItem:
      type: object
      allOf:
        - type: object
          oneOf:
            - $ref: '#/components/schemas/BaseSerpApiElementItem'
          nullable: true
        - type: object
          properties:
            rank_group:
              type: integer
              description: <em>group rank in SERP</em><br>position within a group of elements with identical <code>type</code> values;<br>positions of elements with different <code>type</code> values are omitted from <code>rank_group</code>;<br>always equals <code>0</code> for <code>desktop</code>
              nullable: true
            rank_absolute:
              type: integer
              description: <em>absolute rank in SERP</em><br>absolute position among all the elements in SERP<br>always equals <code>0</code> for <code>desktop</code>
              nullable: true
            items:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/MultiCarouselElement'
                nullable: true
              description: <em>contains arrays of elements available in the list</em>
              nullable: true
    RecipesElement:
      type: object
      properties:
        type:
          type: string
          description: type of element
          nullable: true
        title:
          type: string
          description: <em>title of a given link element</em>
          nullable: true
        url:
          type: string
          description: <em>source URL</em>
          nullable: true
        domain:
          type: string
          description: <em>domain where a link points</em>
          nullable: true
        source:
          type: string
          description: <em>reference source name or title</em>
          nullable: true
        description:
          type: string
          description: <em>link description</em>
          nullable: true
        time:
          type: string
          description: <em>the total time it takes to prepare the cook the dish</em>
          nullable: true
        rating:
          type: object
          oneOf:
            - $ref: '#/components/schemas/RatingInfo'
          description: '<em>the item''s rating </em><br>the popularity rate based on reviews and displayed in SERP;<br>if there is none, equals <code>null</code>'
          nullable: true
    RecipesSerpElementItem:
      type: object
      allOf:
        - type: object
          oneOf:
            - $ref: '#/components/schemas/BaseSerpApiElementItem'
          nullable: true
        - type: object
          properties:
            rank_group:
              type: integer
              description: <em>group rank in SERP</em><br>position within a group of elements with identical <code>type</code> values;<br>positions of elements with different <code>type</code> values are omitted from <code>rank_group</code>;<br>always equals <code>0</code> for <code>desktop</code>
              nullable: true
            rank_absolute:
              type: integer
              description: <em>absolute rank in SERP</em><br>absolute position among all the elements in SERP<br>always equals <code>0</code> for <code>desktop</code>
              nullable: true
            items:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/RecipesElement'
                nullable: true
              description: <em>contains arrays of elements available in the list</em>
              nullable: true
    TopSightsElement:
      type: object
      properties:
        type:
          type: string
          description: type of element
          nullable: true
        title:
          type: string
          description: <em>title of a given link element</em>
          nullable: true
        url:
          type: string
          description: <em>source URL</em>
          nullable: true
        description:
          type: string
          description: <em>link description</em>
          nullable: true
        rating:
          type: object
          oneOf:
            - $ref: '#/components/schemas/RatingInfo'
          description: '<em>the item''s rating </em><br>the popularity rate based on reviews and displayed in SERP;<br>if there is none, equals <code>null</code>'
          nullable: true
    TopSightsSerpElementItem:
      type: object
      allOf:
        - type: object
          oneOf:
            - $ref: '#/components/schemas/BaseSerpApiElementItem'
          nullable: true
        - type: object
          properties:
            rank_group:
              type: integer
              description: <em>group rank in SERP</em><br>position within a group of elements with identical <code>type</code> values;<br>positions of elements with different <code>type</code> values are omitted from <code>rank_group</code>;<br>always equals <code>0</code> for <code>desktop</code>
              nullable: true
            rank_absolute:
              type: integer
              description: <em>absolute rank in SERP</em><br>absolute position among all the elements in SERP<br>always equals <code>0</code> for <code>desktop</code>
              nullable: true
            title:
              type: string
              description: <em>title of the row</em>
              nullable: true
            items:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/TopSightsElement'
                nullable: true
              description: <em>contains arrays of elements available in the list</em>
              nullable: true
    ScholarlyArticlesElement:
      type: object
      properties:
        type:
          type: string
          description: type of element
          nullable: true
        title:
          type: string
          description: <em>title of a given link element</em>
          nullable: true
        url:
          type: string
          description: <em>source URL</em>
          nullable: true
        author:
          type: string
          description: <em>author</em>
          nullable: true
        description:
          type: string
          description: <em>link description</em>
          nullable: true
    ScholarlyArticlesSerpElementItem:
      type: object
      allOf:
        - type: object
          oneOf:
            - $ref: '#/components/schemas/BaseSerpApiElementItem'
          nullable: true
        - type: object
          properties:
            rank_group:
              type: integer
              description: <em>group rank in SERP</em><br>position within a group of elements with identical <code>type</code> values;<br>positions of elements with different <code>type</code> values are omitted from <code>rank_group</code>;<br>always equals <code>0</code> for <code>desktop</code>
              nullable: true
            rank_absolute:
              type: integer
              description: <em>absolute rank in SERP</em><br>absolute position among all the elements in SERP<br>always equals <code>0</code> for <code>desktop</code>
              nullable: true
            title:
              type: string
              description: <em>title of the row</em>
              nullable: true
            url:
              type: string
              description: <i>URL of the third-party review source</i>
              nullable: true
            items:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/ScholarlyArticlesElement'
                nullable: true
              description: <em>contains arrays of elements available in the list</em>
              nullable: true
    ProductIdentifiers:
      type: object
      properties:
        product_id:
          type: string
          description: <em>unique product identifier on Google Shopping</em><br>example:<br><code>4485466949985702538</code><br>learn more about the parameter in <a href="https://dataforseo.com/help-center/product-id-google-shopping" rel="noopener noreferrer" target="_blank">this help center guide</a>
          nullable: true
        data_docid:
          type: string
          description: <em>unique identifier of the SERP data element</em><br>example:<br><code>17363035694596624076</code>
          nullable: true
        gid:
          type: string
          description: <em>global product identifier on Google Shopping</em><br>example:<br><code>4702526954592161872</code><br>learn more about the parameter in <a href="https://dataforseo.com/help-center/whats-a-gid-in-google-shopping-api" rel="noopener noreferrer" target="_blank">this help center guide</a>
          nullable: true
    PopularProductsElement:
      type: object
      properties:
        type:
          type: string
          description: type of element
          nullable: true
        title:
          type: string
          description: <em>title of a given link element</em>
          nullable: true
        url:
          type: string
          description: <em>source URL</em>
          nullable: true
        domain:
          type: string
          description: <em>domain where a link points</em>
          nullable: true
        description:
          type: string
          description: <em>link description</em>
          nullable: true
        more_sellers:
          type: boolean
          description: <em>indicates whether the product is sold by multiple sellers</em>
          nullable: true
        seller:
          type: string
          description: <em>seller of the product</em>
          nullable: true
        image_url:
          type: string
          description: <em>URL of the image</em><br>the URL leading to the image on the original resource or DataForSEO storage (in case the original source is not available)
          nullable: true
        price:
          type: object
          oneOf:
            - $ref: '#/components/schemas/PriceInfo'
          description: <em>price indicated in the element</em>
          nullable: true
        rating:
          type: object
          oneOf:
            - $ref: '#/components/schemas/RatingInfo'
          description: '<em>the item''s rating </em><br>the popularity rate based on reviews and displayed in SERP;<br>if there is none, equals <code>null</code>'
          nullable: true
        product_identifiers:
          type: object
          oneOf:
            - $ref: '#/components/schemas/ProductIdentifiers'
          description: '<em>identifiers of the product</em><br>can include the following identifiers: <code>product_id</code>, <code>data_docid</code>, <code>gid</code>'
          nullable: true
    PopularProductsSerpElementItem:
      type: object
      allOf:
        - type: object
          oneOf:
            - $ref: '#/components/schemas/BaseSerpApiElementItem'
          nullable: true
        - type: object
          properties:
            rank_group:
              type: integer
              description: <em>group rank in SERP</em><br>position within a group of elements with identical <code>type</code> values;<br>positions of elements with different <code>type</code> values are omitted from <code>rank_group</code>;<br>always equals <code>0</code> for <code>desktop</code>
              nullable: true
            rank_absolute:
              type: integer
              description: <em>absolute rank in SERP</em><br>absolute position among all the elements in SERP<br>always equals <code>0</code> for <code>desktop</code>
              nullable: true
            title:
              type: string
              description: <em>title of the row</em>
              nullable: true
            items:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/PopularProductsElement'
                nullable: true
              description: <em>contains arrays of elements available in the list</em>
              nullable: true
    GraphElement:
      type: object
      properties:
        type:
          type: string
          description: type of element
          nullable: true
        date:
          type: string
          description: '<em>date when the video was published or indexed</em><br>example: <br><code>Apr 26, 2024</code>'
          nullable: true
        value:
          type: number
          description: <em>the value of the rating</em>
          nullable: true
    Graph:
      type: object
      properties:
        items:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/GraphElement'
            nullable: true
          description: <em>contains arrays of elements available in the list</em>
          nullable: true
        previous_items:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/GraphElement'
            nullable: true
          description: <em>previous close data</em><br>contains stock price data based on the preceding time period
          nullable: true
    StocksBoxSerpElementItem:
      type: object
      allOf:
        - type: object
          oneOf:
            - $ref: '#/components/schemas/BaseSerpApiElementItem'
          nullable: true
        - type: object
          properties:
            rank_group:
              type: integer
              description: <em>group rank in SERP</em><br>position within a group of elements with identical <code>type</code> values;<br>positions of elements with different <code>type</code> values are omitted from <code>rank_group</code>;<br>always equals <code>0</code> for <code>desktop</code>
              nullable: true
            rank_absolute:
              type: integer
              description: <em>absolute rank in SERP</em><br>absolute position among all the elements in SERP<br>always equals <code>0</code> for <code>desktop</code>
              nullable: true
            title:
              type: string
              description: <em>title of the row</em>
              nullable: true
            source:
              type: string
              description: <i>source of the element</i><br>indicates the source of information included in the <code>recipes_element</code>
              nullable: true
            snippet:
              type: string
              description: <em>text alongside the link title</em>
              nullable: true
            price:
              type: object
              oneOf:
                - $ref: '#/components/schemas/PriceInfo'
              description: <em>price indicated in the element</em>
              nullable: true
            url:
              type: string
              description: <i>URL of the third-party review source</i>
              nullable: true
            domain:
              type: string
              description: <em>domain of the website hosting the video</em>
              nullable: true
            table:
              type: object
              oneOf:
                - $ref: '#/components/schemas/Table'
              description: <em>table present in the element</em><br>the header and content of the table present in the element
              nullable: true
            graph:
              type: object
              oneOf:
                - $ref: '#/components/schemas/Graph'
              description: <em>contains data provided in the graph of the element</em>
              nullable: true
    FindResultsOnElement:
      type: object
      properties:
        type:
          type: string
          description: type of element
          nullable: true
        title:
          type: string
          description: <em>title of a given link element</em>
          nullable: true
        domain:
          type: string
          description: <em>domain where a link points</em>
          nullable: true
        url:
          type: string
          description: <em>source URL</em>
          nullable: true
        source:
          type: string
          description: <em>reference source name or title</em>
          nullable: true
    FindResultsOnSerpElementItem:
      type: object
      allOf:
        - type: object
          oneOf:
            - $ref: '#/components/schemas/BaseSerpApiElementItem'
          nullable: true
        - type: object
          properties:
            rank_group:
              type: integer
              description: <em>group rank in SERP</em><br>position within a group of elements with identical <code>type</code> values;<br>positions of elements with different <code>type</code> values are omitted from <code>rank_group</code>;<br>always equals <code>0</code> for <code>desktop</code>
              nullable: true
            rank_absolute:
              type: integer
              description: <em>absolute rank in SERP</em><br>absolute position among all the elements in SERP<br>always equals <code>0</code> for <code>desktop</code>
              nullable: true
            items:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/FindResultsOnElement'
                nullable: true
              description: <em>contains arrays of elements available in the list</em>
              nullable: true
    QuestionsAndAnswersElement:
      type: object
      properties:
        type:
          type: string
          description: type of element
          nullable: true
        url:
          type: string
          description: <em>source URL</em>
          nullable: true
        question_text:
          type: string
          description: <em>question included in the item</em>
          nullable: true
        answer_text:
          type: string
          description: <em>answer included in the item</em>
          nullable: true
        source:
          type: string
          description: <em>reference source name or title</em>
          nullable: true
        domain:
          type: string
          description: <em>domain where a link points</em>
          nullable: true
        votes:
          type: integer
          description: <em>answer upvotes from the source</em>
          nullable: true
    QuestionsAndAnswersSerpElementItem:
      type: object
      allOf:
        - type: object
          oneOf:
            - $ref: '#/components/schemas/BaseSerpApiElementItem'
          nullable: true
        - type: object
          properties:
            rank_group:
              type: integer
              description: <em>group rank in SERP</em><br>position within a group of elements with identical <code>type</code> values;<br>positions of elements with different <code>type</code> values are omitted from <code>rank_group</code>;<br>always equals <code>0</code> for <code>desktop</code>
              nullable: true
            rank_absolute:
              type: integer
              description: <em>absolute rank in SERP</em><br>absolute position among all the elements in SERP<br>always equals <code>0</code> for <code>desktop</code>
              nullable: true
            items:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/QuestionsAndAnswersElement'
                nullable: true
              description: <em>contains arrays of elements available in the list</em>
              nullable: true
    HotelsPackElement:
      type: object
      properties:
        type:
          type: string
          description: type of element
          nullable: true
        price:
          type: object
          oneOf:
            - $ref: '#/components/schemas/PriceInfo'
          description: <em>price indicated in the element</em>
          nullable: true
        title:
          type: string
          description: <em>title of a given link element</em>
          nullable: true
        description:
          type: string
          description: <em>link description</em>
          nullable: true
        hotel_identifier:
          type: string
          description: '<em>unique hotel identifier</em><br>unique hotel identifier assigned by Google;<br>example: <code>"CgoIjaeSlI6CnNpVEAE"</code>'
          nullable: true
        domain:
          type: string
          description: <em>domain where a link points</em>
          nullable: true
        url:
          type: string
          description: <em>source URL</em>
          nullable: true
        is_paid:
          type: boolean
          description: <em>indicates whether the element is an ad</em>
          nullable: true
        rating:
          type: object
          oneOf:
            - $ref: '#/components/schemas/RatingInfo'
          description: '<em>the item''s rating </em><br>the popularity rate based on reviews and displayed in SERP;<br>if there is none, equals <code>null</code>'
          nullable: true
    HotelsPackSerpElementItem:
      type: object
      allOf:
        - type: object
          oneOf:
            - $ref: '#/components/schemas/BaseSerpApiElementItem'
          nullable: true
        - type: object
          properties:
            rank_group:
              type: integer
              description: <em>group rank in SERP</em><br>position within a group of elements with identical <code>type</code> values;<br>positions of elements with different <code>type</code> values are omitted from <code>rank_group</code>;<br>always equals <code>0</code> for <code>desktop</code>
              nullable: true
            rank_absolute:
              type: integer
              description: <em>absolute rank in SERP</em><br>absolute position among all the elements in SERP<br>always equals <code>0</code> for <code>desktop</code>
              nullable: true
            title:
              type: string
              description: <em>title of the row</em>
              nullable: true
            date_from:
              type: string
              description: <em>starting date of stay</em><br>in the format "year-month-date"<br>example:<br>2019-11-15
              nullable: true
            date_to:
              type: string
              description: <em>ending date of stay</em><br>in the format "year-month-date"<br>example:<br>2019-11-17
              nullable: true
            items:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/HotelsPackElement'
                nullable: true
              description: <em>contains arrays of elements available in the list</em>
              nullable: true
    CommercialUnitsElement:
      type: object
      properties:
        type:
          type: string
          description: type of element
          nullable: true
        title:
          type: string
          description: <em>title of a given link element</em>
          nullable: true
        url:
          type: string
          description: <em>source URL</em>
          nullable: true
        domain:
          type: string
          description: <em>domain where a link points</em>
          nullable: true
        price:
          type: object
          oneOf:
            - $ref: '#/components/schemas/PriceInfo'
          description: <em>price indicated in the element</em>
          nullable: true
        source:
          type: string
          description: <em>reference source name or title</em>
          nullable: true
        rating:
          type: object
          oneOf:
            - $ref: '#/components/schemas/RatingInfo'
          description: '<em>the item''s rating </em><br>the popularity rate based on reviews and displayed in SERP;<br>if there is none, equals <code>null</code>'
          nullable: true
    CommercialUnitsSerpElementItem:
      type: object
      allOf:
        - type: object
          oneOf:
            - $ref: '#/components/schemas/BaseSerpApiElementItem'
          nullable: true
        - type: object
          properties:
            rank_group:
              type: integer
              description: <em>group rank in SERP</em><br>position within a group of elements with identical <code>type</code> values;<br>positions of elements with different <code>type</code> values are omitted from <code>rank_group</code>;<br>always equals <code>0</code> for <code>desktop</code>
              nullable: true
            rank_absolute:
              type: integer
              description: <em>absolute rank in SERP</em><br>absolute position among all the elements in SERP<br>always equals <code>0</code> for <code>desktop</code>
              nullable: true
            title:
              type: string
              description: <em>title of the row</em>
              nullable: true
            items:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/CommercialUnitsElement'
                nullable: true
              description: <em>contains arrays of elements available in the list</em>
              nullable: true
    LocalServicesElement:
      type: object
      properties:
        type:
          type: string
          description: type of element
          nullable: true
        title:
          type: string
          description: <em>title of a given link element</em>
          nullable: true
        url:
          type: string
          description: <em>source URL</em>
          nullable: true
        domain:
          type: string
          description: <em>domain where a link points</em>
          nullable: true
        description:
          type: string
          description: <em>link description</em>
          nullable: true
        rating:
          type: object
          oneOf:
            - $ref: '#/components/schemas/RatingInfo'
          description: '<em>the item''s rating </em><br>the popularity rate based on reviews and displayed in SERP;<br>if there is none, equals <code>null</code>'
          nullable: true
        profile_image_url:
          type: string
          description: <em>URL of the image featured in the element</em>
          nullable: true
    LocalServicesSerpElementItem:
      type: object
      allOf:
        - type: object
          oneOf:
            - $ref: '#/components/schemas/BaseSerpApiElementItem'
          nullable: true
        - type: object
          properties:
            rank_group:
              type: integer
              description: <em>group rank in SERP</em><br>position within a group of elements with identical <code>type</code> values;<br>positions of elements with different <code>type</code> values are omitted from <code>rank_group</code>;<br>always equals <code>0</code> for <code>desktop</code>
              nullable: true
            rank_absolute:
              type: integer
              description: <em>absolute rank in SERP</em><br>absolute position among all the elements in SERP<br>always equals <code>0</code> for <code>desktop</code>
              nullable: true
            title:
              type: string
              description: <em>title of the row</em>
              nullable: true
            url:
              type: string
              description: <i>URL of the third-party review source</i>
              nullable: true
            domain:
              type: string
              description: <em>domain of the website hosting the video</em>
              nullable: true
            items:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/LocalServicesElement'
                nullable: true
              description: <em>contains arrays of elements available in the list</em>
              nullable: true
    GoogleHotelsSerpElementItem:
      type: object
      allOf:
        - type: object
          oneOf:
            - $ref: '#/components/schemas/BaseSerpApiElementItem'
          nullable: true
        - type: object
          properties:
            rank_group:
              type: integer
              description: <em>group rank in SERP</em><br>position within a group of elements with identical <code>type</code> values;<br>positions of elements with different <code>type</code> values are omitted from <code>rank_group</code>;<br>always equals <code>0</code> for <code>desktop</code>
              nullable: true
            rank_absolute:
              type: integer
              description: <em>absolute rank in SERP</em><br>absolute position among all the elements in SERP<br>always equals <code>0</code> for <code>desktop</code>
              nullable: true
            hotel_identifier:
              type: string
              description: '<em>unique hotel identifier</em><br>unique hotel identifier assigned by Google;<br>example: <code>"CgoIjaeSlI6CnNpVEAE"</code>'
              nullable: true
            url:
              type: string
              description: <i>URL of the third-party review source</i>
              nullable: true
            cid:
              type: string
              description: <em>google-defined client id</em>
              nullable: true
    MathSolverExpandedElement:
      type: object
      properties:
        type:
          type: string
          description: type of element
          nullable: true
        title:
          type: string
          description: <em>title of the carousel item</em>
          nullable: true
        solution:
          type: array
          items:
            type: string
            nullable: true
          description: <em>solution of the element</em><br>displays steps to solve the mathematical equation as specified in the element
          nullable: true
    MathSolverElement:
      type: object
      properties:
        type:
          type: string
          description: type of element
          nullable: true
        title:
          type: string
          description: <em>title of a given link element</em>
          nullable: true
        expanded_element:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/MathSolverExpandedElement'
            nullable: true
          description: <em>expanded element</em>
          nullable: true
    MathSolverSerpElementItem:
      type: object
      allOf:
        - type: object
          oneOf:
            - $ref: '#/components/schemas/BaseSerpApiElementItem'
          nullable: true
        - type: object
          properties:
            rank_group:
              type: integer
              description: <em>group rank in SERP</em><br>position within a group of elements with identical <code>type</code> values;<br>positions of elements with different <code>type</code> values are omitted from <code>rank_group</code>;<br>always equals <code>0</code> for <code>desktop</code>
              nullable: true
            rank_absolute:
              type: integer
              description: <em>absolute rank in SERP</em><br>absolute position among all the elements in SERP<br>always equals <code>0</code> for <code>desktop</code>
              nullable: true
            title:
              type: string
              description: <em>title of the row</em>
              nullable: true
            result:
              type: string
              description: <em>solution to the equation</em><br>solution to the mathematical equation specified in the <code>keyword</code> field when setting a task
              nullable: true
            items:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/MathSolverElement'
                nullable: true
              description: <em>contains arrays of elements available in the list</em>
              nullable: true
            links:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/LinkElement'
                nullable: true
              description: '<em>sitelinks</em><br>the links shown below some of Google''s search results<br>if there are none, equals <code>null</code>'
              nullable: true
    CurrencyBoxSerpElementItem:
      type: object
      allOf:
        - type: object
          oneOf:
            - $ref: '#/components/schemas/BaseSerpApiElementItem'
          nullable: true
        - type: object
          properties:
            rank_group:
              type: integer
              description: <em>group rank in SERP</em><br>position within a group of elements with identical <code>type</code> values;<br>positions of elements with different <code>type</code> values are omitted from <code>rank_group</code>;<br>always equals <code>0</code> for <code>desktop</code>
              nullable: true
            rank_absolute:
              type: integer
              description: <em>absolute rank in SERP</em><br>absolute position among all the elements in SERP<br>always equals <code>0</code> for <code>desktop</code>
              nullable: true
            value:
              type: number
              description: <em>the value of the rating</em>
              nullable: true
            converted_value:
              type: number
              description: <i>value converted to a requested currency</i><br>indicates the exact value based on Google Fincance data at the time when our API pulled the results<br>note that exchange rates displayed in the <code>currency_box</code> element may be delayed according to <a href="https://www.google.com/intl/en_us/googlefinance/disclaimer/">the Google Finance disclaimer</a>
              nullable: true
            currency:
              type: string
              description: <i>currency of the listed price</i><br>ISO code of the currency applied to the price
              nullable: true
            converted_currency:
              type: string
              description: <em>converted currency</em>
              nullable: true
            timestamp:
              type: string
              description: '<em>date and time when the result was published</em><br>in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”<br>example:<br><code class="long-string">2019-11-15 12:57:46 +00:00</code>'
              nullable: true
            table:
              type: object
              oneOf:
                - $ref: '#/components/schemas/Table'
              description: <em>table present in the element</em><br>the header and content of the table present in the element
              nullable: true
            graph:
              type: object
              oneOf:
                - $ref: '#/components/schemas/Graph'
              description: <em>contains data provided in the graph of the element</em>
              nullable: true
    SerpApiProductConsiderationsExpandedElementItem:
      type: object
      allOf:
        - type: object
          oneOf:
            - $ref: '#/components/schemas/BaseSerpApiProductConsiderationExpandedElementItem'
          nullable: true
        - type: object
          properties:
            title:
              type: string
              description: <em>title of the carousel item</em>
              nullable: true
            featured_title:
              type: string
              description: <em>the title of the featured snippets source page</em>
              nullable: true
            breadcrumb:
              type: string
              description: <em>breadcrumb of the Ad element in SERP</em>
              nullable: true
            snippet:
              type: string
              description: <em>text alongside the link title</em>
              nullable: true
            domain:
              type: string
              description: <em>source domain</em>
              nullable: true
            url:
              type: string
              description: <em>relevant URL</em>
              nullable: true
            timestamp:
              type: string
              description: '<em>date and time when the result was published</em><br>in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”<br>example:<br><code class="long-string">2019-11-15 12:57:46 +00:00</code>'
              nullable: true
            related_searches:
              type: array
              items:
                type: string
                nullable: true
              nullable: true
            about_this_result:
              type: object
              oneOf:
                - $ref: '#/components/schemas/AboutThisResultElement'
              description: <em>contains information from the 'About this result' panel</em><br><strong>Note:</strong> this object is deprecated and always returns <code>null</null>
              nullable: true
              deprecated: true
    AiOverviewElement:
      type: object
      properties:
        type:
          type: string
          description: type of element
          nullable: true
        title:
          type: string
          description: <em>title of a given link element</em>
          nullable: true
        text:
          type: string
          description: <em>content within the item</em>
          nullable: true
        images:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/AiModeImagesElementInfo'
            nullable: true
          description: <em>images of the element</em>
          nullable: true
        references:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/AiModeAiOverviewReferenceInfo'
            nullable: true
          description: <em>references relevant to the element</em><br>includes references to webpages that were used to generate the <code>ai_overview_element</code>
          nullable: true
    SerpApiProductConsiderationsAiOverviewExpandedElementItem:
      type: object
      allOf:
        - type: object
          oneOf:
            - $ref: '#/components/schemas/BaseSerpApiProductConsiderationExpandedElementItem'
          nullable: true
        - type: object
          properties:
            items:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AiOverviewElement'
                nullable: true
              description: <em>items present in the element</em>
              nullable: true
            references:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AiModeAiOverviewReferenceInfo'
                nullable: true
              description: <em>additional references relevant to the item</em><br>includes references to webpages that may have been used to generate the <code>ai_overview</code>
              nullable: true
    ProductConsiderationsElement:
      type: object
      properties:
        type:
          type: string
          description: type of element
          nullable: true
        title:
          type: string
          description: <em>title of a given link element</em>
          nullable: true
        consideration_category:
          type: string
          description: <em>category of the consideration element</em><br>the category is indicated just above the title fo the consideration element
          nullable: true
        expanded_element:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/BaseSerpApiProductConsiderationExpandedElementItem'
            nullable: true
          description: <em>expanded element</em>
          nullable: true
    ProductConsiderationsSerpElementItem:
      type: object
      allOf:
        - type: object
          oneOf:
            - $ref: '#/components/schemas/BaseSerpApiElementItem'
          nullable: true
        - type: object
          properties:
            rank_group:
              type: integer
              description: <em>group rank in SERP</em><br>position within a group of elements with identical <code>type</code> values;<br>positions of elements with different <code>type</code> values are omitted from <code>rank_group</code>;<br>always equals <code>0</code> for <code>desktop</code>
              nullable: true
            rank_absolute:
              type: integer
              description: <em>absolute rank in SERP</em><br>absolute position among all the elements in SERP<br>always equals <code>0</code> for <code>desktop</code>
              nullable: true
            title:
              type: string
              description: <em>title of the row</em>
              nullable: true
            items:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/ProductConsiderationsElement'
                nullable: true
              description: <em>contains arrays of elements available in the list</em>
              nullable: true
    ShortVideosElement:
      type: object
      properties:
        type:
          type: string
          description: type of element
          nullable: true
        title:
          type: string
          description: <em>title of a given link element</em>
          nullable: true
        url:
          type: string
          description: <em>source URL</em>
          nullable: true
        domain:
          type: string
          description: <em>domain where a link points</em>
          nullable: true
        source:
          type: string
          description: <em>reference source name or title</em>
          nullable: true
    ShortVideosSerpElementItem:
      type: object
      allOf:
        - type: object
          oneOf:
            - $ref: '#/components/schemas/BaseSerpApiElementItem'
          nullable: true
        - type: object
          properties:
            rank_group:
              type: integer
              description: <em>group rank in SERP</em><br>position within a group of elements with identical <code>type</code> values;<br>positions of elements with different <code>type</code> values are omitted from <code>rank_group</code>;<br>always equals <code>0</code> for <code>desktop</code>
              nullable: true
            rank_absolute:
              type: integer
              description: <em>absolute rank in SERP</em><br>absolute position among all the elements in SERP<br>always equals <code>0</code> for <code>desktop</code>
              nullable: true
            title:
              type: string
              description: <em>title of the row</em>
              nullable: true
            items:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/ShortVideosElement'
                nullable: true
              description: <em>contains arrays of elements available in the list</em>
              nullable: true
    RefineProductsElement:
      type: object
      properties:
        type:
          type: string
          description: type of element
          nullable: true
        title:
          type: string
          description: <em>title of a given link element</em>
          nullable: true
        image_url:
          type: string
          description: <em>URL of the image</em><br>the URL leading to the image on the original resource or DataForSEO storage (in case the original source is not available)
          nullable: true
        keyword:
          type: string
          description: <em>keyword for the related refined search</em>
          nullable: true
        refine_type:
          type: string
          description: <em>type of search refinement</em>
          nullable: true
        xpath:
          type: string
          description: <em>the <a href="https://en.wikipedia.org/wiki/XPath">XPath</a> of the element</em>
          nullable: true
    RefineProductsSerpElementItem:
      type: object
      allOf:
        - type: object
          oneOf:
            - $ref: '#/components/schemas/BaseSerpApiElementItem'
          nullable: true
        - type: object
          properties:
            rank_group:
              type: integer
              description: <em>group rank in SERP</em><br>position within a group of elements with identical <code>type</code> values;<br>positions of elements with different <code>type</code> values are omitted from <code>rank_group</code>;<br>always equals <code>0</code> for <code>desktop</code>
              nullable: true
            rank_absolute:
              type: integer
              description: <em>absolute rank in SERP</em><br>absolute position among all the elements in SERP<br>always equals <code>0</code> for <code>desktop</code>
              nullable: true
            title:
              type: string
              description: <em>title of the row</em>
              nullable: true
            items:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/RefineProductsElement'
                nullable: true
              description: <em>contains arrays of elements available in the list</em>
              nullable: true
    PerspectivesElement:
      type: object
      properties:
        type:
          type: string
          description: type of element
          nullable: true
        title:
          type: string
          description: <em>title of a given link element</em>
          nullable: true
        description:
          type: string
          description: <em>link description</em>
          nullable: true
        url:
          type: string
          description: <em>source URL</em>
          nullable: true
        domain:
          type: string
          description: <em>domain where a link points</em>
          nullable: true
        date:
          type: string
          description: <em>the date when the page source of the element was published</em>
          nullable: true
        source:
          type: string
          description: <em>reference source name or title</em>
          nullable: true
        timestamp:
          type: string
          description: '<em>date and time when the result was published</em><br>in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”<br>example:<br><code class="long-string">2019-11-15 12:57:46 +00:00</code>'
          nullable: true
    PerspectivesSerpElementItem:
      type: object
      allOf:
        - type: object
          oneOf:
            - $ref: '#/components/schemas/BaseSerpApiElementItem'
          nullable: true
        - type: object
          properties:
            rank_group:
              type: integer
              description: <em>group rank in SERP</em><br>position within a group of elements with identical <code>type</code> values;<br>positions of elements with different <code>type</code> values are omitted from <code>rank_group</code>;<br>always equals <code>0</code> for <code>desktop</code>
              nullable: true
            rank_absolute:
              type: integer
              description: <em>absolute rank in SERP</em><br>absolute position among all the elements in SERP<br>always equals <code>0</code> for <code>desktop</code>
              nullable: true
            title:
              type: string
              description: <em>title of the row</em>
              nullable: true
            items:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/PerspectivesElement'
                nullable: true
              description: <em>contains arrays of elements available in the list</em>
              nullable: true
    DiscussionsAndForumsElement:
      type: object
      properties:
        type:
          type: string
          description: type of element
          nullable: true
        title:
          type: string
          description: <em>title of a given link element</em>
          nullable: true
        url:
          type: string
          description: <em>source URL</em>
          nullable: true
        domain:
          type: string
          description: <em>domain where a link points</em>
          nullable: true
        source:
          type: string
          description: <em>reference source name or title</em>
          nullable: true
        description:
          type: string
          description: <em>link description</em>
          nullable: true
        timestamp:
          type: string
          description: '<em>date and time when the result was published</em><br>in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”<br>example:<br><code class="long-string">2019-11-15 12:57:46 +00:00</code>'
          nullable: true
        posts_count:
          type: integer
          description: <em>number of posts from the discussion on the related source</em>
          format: int64
          nullable: true
    DiscussionsAndForumsSerpElementItem:
      type: object
      allOf:
        - type: object
          oneOf:
            - $ref: '#/components/schemas/BaseSerpApiElementItem'
          nullable: true
        - type: object
          properties:
            rank_group:
              type: integer
              description: <em>group rank in SERP</em><br>position within a group of elements with identical <code>type</code> values;<br>positions of elements with different <code>type</code> values are omitted from <code>rank_group</code>;<br>always equals <code>0</code> for <code>desktop</code>
              nullable: true
            rank_absolute:
              type: integer
              description: <em>absolute rank in SERP</em><br>absolute position among all the elements in SERP<br>always equals <code>0</code> for <code>desktop</code>
              nullable: true
            title:
              type: string
              description: <em>title of the row</em>
              nullable: true
            items:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/DiscussionsAndForumsElement'
                nullable: true
              description: <em>contains arrays of elements available in the list</em>
              nullable: true
    CompareSitesElement:
      type: object
      properties:
        type:
          type: string
          description: type of element
          nullable: true
        title:
          type: string
          description: <em>title of a given link element</em>
          nullable: true
        url:
          type: string
          description: <em>source URL</em>
          nullable: true
        domain:
          type: string
          description: <em>domain where a link points</em>
          nullable: true
        image_url:
          type: string
          description: <em>URL of the image</em><br>the URL leading to the image on the original resource or DataForSEO storage (in case the original source is not available)
          nullable: true
        source:
          type: string
          description: <em>reference source name or title</em>
          nullable: true
    CompareSitesSerpElementItem:
      type: object
      allOf:
        - type: object
          oneOf:
            - $ref: '#/components/schemas/BaseSerpApiElementItem'
          nullable: true
        - type: object
          properties:
            rank_group:
              type: integer
              description: <em>group rank in SERP</em><br>position within a group of elements with identical <code>type</code> values;<br>positions of elements with different <code>type</code> values are omitted from <code>rank_group</code>;<br>always equals <code>0</code> for <code>desktop</code>
              nullable: true
            rank_absolute:
              type: integer
              description: <em>absolute rank in SERP</em><br>absolute position among all the elements in SERP<br>always equals <code>0</code> for <code>desktop</code>
              nullable: true
            title:
              type: string
              description: <em>title of the row</em>
              nullable: true
            items:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/CompareSitesElement'
                nullable: true
              description: <em>contains arrays of elements available in the list</em>
              nullable: true
    KnowledgeGraphCarouselItemSerpElementItem:
      type: object
      allOf:
        - type: object
          oneOf:
            - $ref: '#/components/schemas/BaseSerpApiElementItem'
          nullable: true
        - type: object
          properties:
            rank_group:
              type: integer
              description: <em>group rank in SERP</em><br>position within a group of elements with identical <code>type</code> values;<br>positions of elements with different <code>type</code> values are omitted from <code>rank_group</code>;<br>always equals <code>0</code> for <code>desktop</code>
              nullable: true
            rank_absolute:
              type: integer
              description: <em>absolute rank in SERP</em><br>absolute position among all the elements in SERP<br>always equals <code>0</code> for <code>desktop</code>
              nullable: true
            title:
              type: string
              description: <em>title of the row</em>
              nullable: true
            data_attrid:
              type: string
              description: <em>google defined data attribute ID</em><br>example:<br><code>action:listen_artist</code>
              nullable: true
            link:
              type: object
              oneOf:
                - $ref: '#/components/schemas/LinkElement'
              description: <em>link of the element</em>
              nullable: true
            items:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/KnowledgeGraphListElement'
                nullable: true
              description: <em>contains arrays of elements available in the list</em>
              nullable: true
    KnowledgeGraphDescriptionItemSerpElementItem:
      type: object
      allOf:
        - type: object
          oneOf:
            - $ref: '#/components/schemas/BaseSerpApiElementItem'
          nullable: true
        - type: object
          properties:
            rank_group:
              type: integer
              description: <em>group rank in SERP</em><br>position within a group of elements with identical <code>type</code> values;<br>positions of elements with different <code>type</code> values are omitted from <code>rank_group</code>;<br>always equals <code>0</code> for <code>desktop</code>
              nullable: true
            rank_absolute:
              type: integer
              description: <em>absolute rank in SERP</em><br>absolute position among all the elements in SERP<br>always equals <code>0</code> for <code>desktop</code>
              nullable: true
            text:
              type: string
              description: <em>reference text</em><br>text snippet from the page that was used to generate the <code>ai_overview_element</code>
              nullable: true
            links:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/LinkElement'
                nullable: true
              description: '<em>sitelinks</em><br>the links shown below some of Google''s search results<br>if there are none, equals <code>null</code>'
              nullable: true
    KnowledgeGraphImagesItemSerpElementItem:
      type: object
      allOf:
        - type: object
          oneOf:
            - $ref: '#/components/schemas/BaseSerpApiElementItem'
          nullable: true
        - type: object
          properties:
            rank_group:
              type: integer
              description: <em>group rank in SERP</em><br>position within a group of elements with identical <code>type</code> values;<br>positions of elements with different <code>type</code> values are omitted from <code>rank_group</code>;<br>always equals <code>0</code> for <code>desktop</code>
              nullable: true
            rank_absolute:
              type: integer
              description: <em>absolute rank in SERP</em><br>absolute position among all the elements in SERP<br>always equals <code>0</code> for <code>desktop</code>
              nullable: true
            link:
              type: object
              oneOf:
                - $ref: '#/components/schemas/LinkElement'
              description: <em>link of the element</em>
              nullable: true
            items:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/KnowledgeGraphImagesElement'
                nullable: true
              description: <em>contains arrays of elements available in the list</em>
              nullable: true
    KnowledgeGraphListItemSerpElementItem:
      type: object
      allOf:
        - type: object
          oneOf:
            - $ref: '#/components/schemas/BaseSerpApiElementItem'
          nullable: true
        - type: object
          properties:
            rank_group:
              type: integer
              description: <em>group rank in SERP</em><br>position within a group of elements with identical <code>type</code> values;<br>positions of elements with different <code>type</code> values are omitted from <code>rank_group</code>;<br>always equals <code>0</code> for <code>desktop</code>
              nullable: true
            rank_absolute:
              type: integer
              description: <em>absolute rank in SERP</em><br>absolute position among all the elements in SERP<br>always equals <code>0</code> for <code>desktop</code>
              nullable: true
            title:
              type: string
              description: <em>title of the row</em>
              nullable: true
            data_attrid:
              type: string
              description: <em>google defined data attribute ID</em><br>example:<br><code>action:listen_artist</code>
              nullable: true
            link:
              type: object
              oneOf:
                - $ref: '#/components/schemas/LinkElement'
              description: <em>link of the element</em>
              nullable: true
            items:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/KnowledgeGraphListElement'
                nullable: true
              description: <em>contains arrays of elements available in the list</em>
              nullable: true
    KnowledgeGraphRowItemSerpElementItem:
      type: object
      allOf:
        - type: object
          oneOf:
            - $ref: '#/components/schemas/BaseSerpApiElementItem'
          nullable: true
        - type: object
          properties:
            rank_group:
              type: integer
              description: <em>group rank in SERP</em><br>position within a group of elements with identical <code>type</code> values;<br>positions of elements with different <code>type</code> values are omitted from <code>rank_group</code>;<br>always equals <code>0</code> for <code>desktop</code>
              nullable: true
            rank_absolute:
              type: integer
              description: <em>absolute rank in SERP</em><br>absolute position among all the elements in SERP<br>always equals <code>0</code> for <code>desktop</code>
              nullable: true
            title:
              type: string
              description: <em>title of the row</em>
              nullable: true
            data_attrid:
              type: string
              description: <em>google defined data attribute ID</em><br>example:<br><code>action:listen_artist</code>
              nullable: true
            text:
              type: string
              description: <em>reference text</em><br>text snippet from the page that was used to generate the <code>ai_overview_element</code>
              nullable: true
            links:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/LinkElement'
                nullable: true
              description: '<em>sitelinks</em><br>the links shown below some of Google''s search results<br>if there are none, equals <code>null</code>'
              nullable: true
    KnowledgeGraphHotelsBookingItemSerpElementItem:
      type: object
      allOf:
        - type: object
          oneOf:
            - $ref: '#/components/schemas/BaseSerpApiElementItem'
          nullable: true
        - type: object
          properties:
            rank_group:
              type: integer
              description: <em>group rank in SERP</em><br>position within a group of elements with identical <code>type</code> values;<br>positions of elements with different <code>type</code> values are omitted from <code>rank_group</code>;<br>always equals <code>0</code> for <code>desktop</code>
              nullable: true
            rank_absolute:
              type: integer
              description: <em>absolute rank in SERP</em><br>absolute position among all the elements in SERP<br>always equals <code>0</code> for <code>desktop</code>
              nullable: true
            title:
              type: string
              description: <em>title of the row</em>
              nullable: true
            date_from:
              type: string
              description: <em>starting date of stay</em><br>in the format "year-month-date"<br>example:<br>2019-11-15
              nullable: true
            date_to:
              type: string
              description: <em>ending date of stay</em><br>in the format "year-month-date"<br>example:<br>2019-11-17
              nullable: true
            data_attrid:
              type: string
              description: <em>google defined data attribute ID</em><br>example:<br><code>action:listen_artist</code>
              nullable: true
            items:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/KnowledgeGraphHotelsBookingElement'
                nullable: true
              description: <em>contains arrays of elements available in the list</em>
              nullable: true
    KnowledgeGraphExpandedItemSerpElementItem:
      type: object
      allOf:
        - type: object
          oneOf:
            - $ref: '#/components/schemas/BaseSerpApiElementItem'
          nullable: true
        - type: object
          properties:
            rank_group:
              type: integer
              description: <em>group rank in SERP</em><br>position within a group of elements with identical <code>type</code> values;<br>positions of elements with different <code>type</code> values are omitted from <code>rank_group</code>;<br>always equals <code>0</code> for <code>desktop</code>
              nullable: true
            rank_absolute:
              type: integer
              description: <em>absolute rank in SERP</em><br>absolute position among all the elements in SERP<br>always equals <code>0</code> for <code>desktop</code>
              nullable: true
            title:
              type: string
              description: <em>title of the row</em>
              nullable: true
            data_attrid:
              type: string
              description: <em>google defined data attribute ID</em><br>example:<br><code>action:listen_artist</code>
              nullable: true
            expanded_element:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/KnowledgeGraphExpandedElement'
                nullable: true
              description: <em>expanded element</em>
              nullable: true
    KnowledgeGraphPartItemSerpElementItem:
      type: object
      allOf:
        - type: object
          oneOf:
            - $ref: '#/components/schemas/BaseSerpApiElementItem'
          nullable: true
        - type: object
          properties:
            rank_group:
              type: integer
              description: <em>group rank in SERP</em><br>position within a group of elements with identical <code>type</code> values;<br>positions of elements with different <code>type</code> values are omitted from <code>rank_group</code>;<br>always equals <code>0</code> for <code>desktop</code>
              nullable: true
            rank_absolute:
              type: integer
              description: <em>absolute rank in SERP</em><br>absolute position among all the elements in SERP<br>always equals <code>0</code> for <code>desktop</code>
              nullable: true
            title:
              type: string
              description: <em>title of the row</em>
              nullable: true
            data_attrid:
              type: string
              description: <em>google defined data attribute ID</em><br>example:<br><code>action:listen_artist</code>
              nullable: true
            text:
              type: string
              description: <em>reference text</em><br>text snippet from the page that was used to generate the <code>ai_overview_element</code>
              nullable: true
            links:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/LinkElement'
                nullable: true
              description: '<em>sitelinks</em><br>the links shown below some of Google''s search results<br>if there are none, equals <code>null</code>'
              nullable: true
    KnowledgeGraphShoppingItemSerpElementItem:
      type: object
      allOf:
        - type: object
          oneOf:
            - $ref: '#/components/schemas/BaseSerpApiElementItem'
          nullable: true
        - type: object
          properties:
            rank_group:
              type: integer
              description: <em>group rank in SERP</em><br>position within a group of elements with identical <code>type</code> values;<br>positions of elements with different <code>type</code> values are omitted from <code>rank_group</code>;<br>always equals <code>0</code> for <code>desktop</code>
              nullable: true
            rank_absolute:
              type: integer
              description: <em>absolute rank in SERP</em><br>absolute position among all the elements in SERP<br>always equals <code>0</code> for <code>desktop</code>
              nullable: true
            title:
              type: string
              description: <em>title of the row</em>
              nullable: true
            data_attrid:
              type: string
              description: <em>google defined data attribute ID</em><br>example:<br><code>action:listen_artist</code>
              nullable: true
            items:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/KnowledgeGraphShoppingElement'
                nullable: true
              description: <em>contains arrays of elements available in the list</em>
              nullable: true
    KnowledgeGraphAiOverviewItemSerpElementItem:
      type: object
      allOf:
        - type: object
          oneOf:
            - $ref: '#/components/schemas/BaseSerpApiElementItem'
          nullable: true
        - type: object
          properties:
            asynchronous_ai_overview:
              type: boolean
              description: '<em>indicates whether the element is loaded asynchronously</em><br>if <code>true</code>, the <code>ai_overview</code> element is loaded asynchronously;<br>if <code>false</code>, the <code>ai_overview</code> element is loaded from cache'
              nullable: true
            items:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/BaseSerpApiAiOverviewElementItem'
                nullable: true
              description: <em>contains arrays of elements available in the list</em>
              nullable: true
            references:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AiModeAiOverviewReferenceInfo'
                nullable: true
              description: <em>references relevant to the element</em><br>includes references to webpages that were used to generate the <code>ai_overview_element</code>
              nullable: true
    AiOverviewSerpElementItem:
      type: object
      allOf:
        - type: object
          oneOf:
            - $ref: '#/components/schemas/BaseSerpApiElementItem'
          nullable: true
        - type: object
          properties:
            rank_group:
              type: integer
              description: <em>group rank in SERP</em><br>position within a group of elements with identical <code>type</code> values;<br>positions of elements with different <code>type</code> values are omitted from <code>rank_group</code>;<br>always equals <code>0</code> for <code>desktop</code>
              nullable: true
            rank_absolute:
              type: integer
              description: <em>absolute rank in SERP</em><br>absolute position among all the elements in SERP<br>always equals <code>0</code> for <code>desktop</code>
              nullable: true
            asynchronous_ai_overview:
              type: boolean
              description: '<em>indicates whether the element is loaded asynchronously</em><br>if <code>true</code>, the <code>ai_overview</code> element is loaded asynchronously;<br>if <code>false</code>, the <code>ai_overview</code> element is loaded from cache;<br>to obtain the content of <code>ai_overview</code> elements, use the <code>load_async_ai_overview</code> parameter in the POST request'
              nullable: true
            markdown:
              type: string
              description: <em>content of the element in markdown format</em><br>the text of the <code>ai_overview</code> formatted in the <a href="https://en.wikipedia.org/wiki/Markdown" target="_blank">markdown markup language</a>
              nullable: true
            items:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/BaseSerpApiAiOverviewElementItem'
                nullable: true
              description: <em>contains arrays of elements available in the list</em>
              nullable: true
            references:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AiModeAiOverviewReferenceInfo'
                nullable: true
              description: <em>references relevant to the element</em><br>includes references to webpages that were used to generate the <code>ai_overview_element</code>
              nullable: true
    ThirdPartyReviewsSerpElementItem:
      type: object
      allOf:
        - type: object
          oneOf:
            - $ref: '#/components/schemas/BaseSerpApiElementItem'
          nullable: true
        - type: object
          properties:
            rank_group:
              type: integer
              description: <em>group rank in SERP</em><br>position within a group of elements with identical <code>type</code> values;<br>positions of elements with different <code>type</code> values are omitted from <code>rank_group</code>;<br>always equals <code>0</code> for <code>desktop</code>
              nullable: true
            rank_absolute:
              type: integer
              description: <em>absolute rank in SERP</em><br>absolute position among all the elements in SERP<br>always equals <code>0</code> for <code>desktop</code>
              nullable: true
            reviews_count:
              type: integer
              description: <i>the number of reviews</i>
              format: int64
              nullable: true
            title:
              type: string
              description: <em>title of the row</em>
              nullable: true
            url:
              type: string
              description: <i>URL of the third-party review source</i>
              nullable: true
            rating:
              type: object
              oneOf:
                - $ref: '#/components/schemas/RatingInfo'
              description: '<em>the element''s rating</em><br>the popularity rate based on reviews and displayed in SERP;<br>if there is none, equals <code>null</code>'
              nullable: true
    SerpGoogleOrganicTaskGetAdvancedResultInfo:
      type: object
      properties:
        keyword:
          type: string
          description: <em>keyword received in a POST array<br></em><strong>the keyword is returned with decoded %## (plus symbol '+' will be decoded to a space character)</strong>
          nullable: true
        type:
          type: string
          description: type of element
          nullable: true
        se_domain:
          type: string
          description: <em>search engine domain in a POST array</em>
          nullable: true
        location_code:
          type: integer
          description: <em>location code in a POST array</em>
          nullable: true
        language_code:
          type: string
          description: <em>language code in a POST array</em>
          nullable: true
        check_url:
          type: string
          description: <em>direct URL to search engine results</em><br>you can use it to make sure that we provided accurate results
          nullable: true
        datetime:
          type: string
          description: '<em>date and time when the result was received</em><br>in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”<br>example:<br><code class="long-string">2019-11-15 12:57:46 +00:00</code>'
          nullable: true
        spell:
          type: object
          oneOf:
            - $ref: '#/components/schemas/SpellInfo'
          description: '<em>autocorrection of the search engine</em><br>if the search engine provided results for a keyword that was corrected, we will specify the keyword corrected by the search engine and the type of autocorrection'
          nullable: true
        refinement_chips:
          type: object
          oneOf:
            - $ref: '#/components/schemas/RefinementChipsInfo'
          description: <em>search refinement chips</em>
          nullable: true
        item_types:
          type: array
          items:
            type: string
            nullable: true
          description: '<em>types of search results in SERP</em><br>contains types of search results (<code>items</code>) found in SERP.<br>possible item types:<br><span><a href="#answer_box"><code>answer_box</code></a>, <a href="#app"><code>app</code></a>, <a href="#carousel"><code>carousel</code></a>, <a href="#multi_carousel"><code>multi_carousel</code></a>, <a href="#featured_snippet"><code>featured_snippet</code></a>, <a href="#google_flights"><code>google_flights</code></a>, <a href="#google_reviews"><code>google_reviews</code></a>, <a href="#third_party_reviews"><code>third_party_reviews</code></a>, <a href="#images"><code>images</code></a>, <a href="#jobs"><code>jobs</code></a>, <a href="#knowledge_graph"><code>knowledge_graph</code></a>, <a href="#local_pack"><code>local_pack</code></a>, <a href="#hotels_pack"><code>hotels_pack</code></a>, <a href="#map"><code>map</code></a>, <a href="#organic"><code>organic</code></a>, <a href="#paid"><code>paid</code></a>, <a href="#people_also_ask"><code>people_also_ask</code></a>, <a href="#related_searches"><code>related_searches</code></a>, <a href="#people_also_search"><code>people_also_search</code></a>, <a href="#shopping"><code>shopping</code></a>, <a href="#top_stories"><code>top_stories</code></a>, <a href="#twitter"><code>twitter</code></a>, <a href="#video"><code>video</code></a>, <a href="#events"><code>events</code></a>, <a href="#recipes"><code>recipes</code></a>, <a href="#top_sights"><code>top_sights</code></a>, <a href="#scholarly_articles"><code>scholarly_articles</code></a>, <a href="#popular_products"><code>popular_products</code></a>,  <a href="#questions_and_answers"><code>questions_and_answers</code></a>, <a href="#find_results_on"><code>find_results_on</code></a>, <a href="#stocks_box"><code>stocks_box</code></a>, <a href="#commercial_units"><code>commercial_units</code></a>, <a href="#local_services"><code>local_services</code></a>, <a href="#google_hotels"><code>google_hotels</code></a>, <a href="#math_solver"><code>math_solver</code></a>, <a href="#currency_box"><code>currency_box</code></a>,<a href="#product_considerations"><code>product_considerations</code></a>, <a href="#short_videos"><code>short_videos</code></a>, <a href="#refine_products"><code>refine_products</code></a>, <a href="#perspectives"><code>perspectives</code></a>, <a href="#discussions_and_forums"><code>discussions_and_forums</code></a></span>, <a href="#compare_sites"><code>compare_sites</code></a></span>, <a href="#ai_overview"><code>ai_overview</code></a></span>'
          nullable: true
        se_results_count:
          type: integer
          description: <em> total number of results in SERP</em>
          format: int64
          nullable: true
        pages_count:
          type: integer
          description: <em>total search results pages retrieved</em><br>total number of retrieved SERPs in the result
          format: int64
          nullable: true
        items_count:
          type: integer
          description: <em>the number of results returned in the <strong><code>items</code></strong> array</em>
          format: int64
          nullable: true
        items:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/BaseSerpApiElementItem'
            nullable: true
          description: <em>link of the element</em>
          nullable: true
    SerpGoogleOrganicTaskGetAdvancedTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleOrganicTaskGetAdvancedResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    SerpGoogleOrganicTaskGetAdvancedResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleOrganicTaskGetAdvancedTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    HtmlItemInfo:
      type: object
      properties:
        page:
          type: integer
          description: <i>serial number of the returned HTML page</i>
          nullable: true
        date:
          type: string
          description: '<em>date and time when the HTML page was scanned</em><br>in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”<br>example:<br><code class="long-string">2019-11-15 12:57:46 +00:00</code>'
          nullable: true
        html:
          type: string
          description: <i>HTML</i> <i>page</i>
          nullable: true
    SerpGoogleOrganicTaskGetHtmlResultInfo:
      type: object
      properties:
        keyword:
          type: string
          description: <em>keyword received in a POST array<br></em><strong>keyword is returned with decoded %## (plus symbol '+' will be decoded to a space character)</strong>
          nullable: true
        type:
          type: string
          description: type of element
          nullable: true
        se_domain:
          type: string
          description: <em>search engine domain in a POST array</em>
          nullable: true
        location_code:
          type: integer
          description: <em>location code in a POST array</em>
          nullable: true
        language_code:
          type: string
          description: <em>language code in a POST array</em>
          nullable: true
        datetime:
          type: string
          description: '<em>date and time when the result was received</em><br>in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”<br>example:<br><code class="long-string">2019-11-15 12:57:46 +00:00</code>'
          nullable: true
        items_count:
          type: integer
          description: <em>the number of results returned in the <strong><code>items</code></strong> array</em>
          format: int64
          nullable: true
        items:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/HtmlItemInfo'
            nullable: true
          description: <em>elements of search results found in SERP</em>
          nullable: true
    SerpGoogleOrganicTaskGetHtmlTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleOrganicTaskGetHtmlResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    SerpGoogleOrganicTaskGetHtmlResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleOrganicTaskGetHtmlTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    SerpGoogleOrganicLiveRegularRequestInfo:
      type: object
      properties:
        keyword:
          type: string
          description: '<p><em>keyword</em><p><strong>required field</strong><p>you can specify <strong>up to 700 characters</strong> in the <code>keyword</code> field<p>all %## will be decoded (plus character ''+'' will be decoded to a space character)<p>if you need to use the "%" character for your <code>keyword</code>, please specify it as "%25";<p>if you need to use the “+” character for your <code>keyword</code>, please specify it as “%2B”;<p>if this field contains such parameters as <em>''allinanchor:'', ''allintext:'', ''allintitle:'', ''allinurl:'', ‘cache:’, ''define:'', ''filetype:'', ''id:'', ''inanchor:'', ''info:'', ''intext:'', ''intitle:'', ''inurl:'', ''link:'', ''site:''</em>, <strong>the charge per task will be multiplied by 5</strong>'
        location_code:
          type: integer
          description: '<p><em>search engine location code</em><p><strong>required field if you don''t specify</strong> <code>location_name</code>&nbsp;or <code>location_coordinate</code><p><strong>if you use this field, you don''t need to specify <code>location_name</code> or <code>location_coordinate</code></strong><p>you can receive the list of available locations of the search engines with their <code>location_code</code> by making a separate request to the <code>https://api.dataforseo.com/v3/serp/google/locations</code><p>example:<p><code class="long-string">2840</code></p>'
        language_code:
          type: string
          description: '<p><em>search engine language code</em><p><strong>required field if you don''t specify</strong> <code>language_name</code><p><strong>if you use this field, you don''t need to specify <code>language_name</code></strong><p>you can receive the list of available languages of the search engine with their <code>language_code</code>&nbsp;by making a separate request to the <code>https://api.dataforseo.com/v3/serp/google/languages</code><em><p></em>example:<em><p></em><code class="long-string">en</code></p>'
        depth:
          type: integer
          description: '<p><em>parsing depth</em><p>optional field<p>number of results in SERP<p><strong>default value: <code>10</code></strong><p>max value: <code>200</code></p><br><strong>Your account will be billed per each SERP containing up to 10 results;</strong><p>Setting depth above 10 may result in additional charges <a href="https://dataforseo.com/help-center/how-many-results-scraped" rel="noopener noreferrer" target="_blank">if the search engine returns more than 10 results</a>;<p>The cost can be calculated on the <a title="Pricing" href="https://dataforseo.com/pricing/serp/google-organic-serp-api" target="_blank" rel="noopener noreferrer">Pricing</a> page.'
          nullable: true
        device:
          type: string
          description: '<p><em>device type</em><p>optional field<p>return results for a specific device type<p>can take the values:<code>desktop</code>, <code>mobile</code><p>default value: <code>desktop</code></p>'
          nullable: true
        location_name:
          type: string
          description: '<p><em>full name of search engine location</em><p><strong>required field if you don''t specify</strong> <code>location_code</code> or <code>location_coordinate</code><p><strong>if you use this field, you don''t need to specify <code>location_code</code> or <code>location_coordinate</code></strong><p>you can receive the list of available locations of the search engine with their <code>location_name</code> by making a separate request to the <code>https://api.dataforseo.com/v3/serp/google/locations</code><p>example:<p><code class="long-string">London,England,United Kingdom</code></p>'
        language_name:
          type: string
          description: '<p><em>full name of search engine language</em><p><strong>required field if you don''t specify</strong> <code>language_code</code><p><strong>if you use this field, you don''t need to specify <code>language_code</code></strong><p>you can receive the list of available languages of the search engine with their <code>language_name</code> by making a separate request to the <code>https://api.dataforseo.com/v3/serp/google/languages</code><p>example:<p><code class="long-string">English</code></p>'
        os:
          type: string
          description: '<p><em>device operating system</em><p>optional field<p>if you specify <code>desktop</code> in the <code>device</code> field, choose from the following values: <code>windows</code>, <code>macos</code><p>default value: <code>windows</code><p>if you specify <code>mobile</code> in the <code>device</code> field, choose from the following values: <code>android</code>, <code>ios</code><p>default value: <code>android</code></p>'
          nullable: true
        tag:
          type: string
          description: <p><em>user-defined task identifier</em><p>optional field<p><em>the character limit is 255</em><p>you can use this parameter to identify the task and match it with the result<p>you will find the specified <code>tag</code> value in the <code>data</code> object of the response</p>
          nullable: true
        stop_crawl_on_match:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/SerpApiStopCrawlOnMatchInfo'
            nullable: true
          description: "array of targets to stop crawling\noptional field\nif specified, the response will contain SERP results up to and including the specified match_value;\nyou can specify up to 10 target values in this array\nexample:\n\"stop_crawl_on_match\":[{\"match_value\":\"dataforseo.com\",\"match_type\":\"with_subdomains\"}]\nlearn more about this parameter on our Help Center - https://dataforseo.com/help-center/using-the-stop_crawl_on_match-parameter-in-serp-api\nYour account will be billed per each SERP crawled through the specified targets"
          nullable: true
        match_type:
          type: string
          description: <p><em>target match type</em><p><strong>required field if <code>stop_crawl_on_match</code> is specified</strong><p>type of match for the <code>match_value</code><p>possible values:<p><code>domain</code> – specific domain or subdomain<p><code>with_subdomains</code> – main domain and subdomains<p><code>wildcard</code> –  wildcard pattern</p>
        match_value:
          type: string
          description: '<p><em>target domain, subdomain, or wildcard value</em><p><strong>required field if <code>stop_crawl_on_match</code> is specified</strong><p>specify a target domain, subdomain, or wildcard value;<p><strong>Note:</strong> domain or subdomain must be specified without a request protocol;<p>example: <code>"match_value": "dataforseo.com"</code>,<p><code>"match_value": "/blog/post-*"</code></p>'
        max_crawl_pages:
          type: integer
          description: '<p><em>page crawl limit</em><p>optional field<p>number of search results pages to crawl<p>max value: <code>100</code><p><strong>Note:</strong> you will be charged for each page crawled (10 organic results per page);<p>learn more about pricing on our <a href="https://dataforseo.com/pricing/serp/google-organic-serp-api" target="_blank">Pricing</a> page;<p><strong>Note#2:</strong> the <code>max_crawl_pages</code> and <code>depth</code> parameters complement each other;<p>learn more at <a href="https://dataforseo.com/help-center/what-is-max-crawl-pages-and-how-does-it-work" rel="noopener noreferrer" target="_blank">our help center</a></p>'
          nullable: true
        search_param:
          type: string
          description: '<p><em>additional parameters of the search query</em><p>optional field<p><a href="https://dataforseo.com/what-are-google-search-parameters-and-how-to-use-them-with-serp-api.html">get the list of available parameters and additional details here</a></p><br><strong>Note:</strong> the following search engine parameters are not supported and will be automatically unset if specified: <code>lr</code>, <code>cr</code>, <code>as_qdr</code>, <code>as_sitesearch</code>, <code>as_occt</code>, <code>as_filetype</code>.'
          nullable: true
        group_organic_results:
          type: boolean
          description: '<p><em>display related results</em><p>optional field<p>if set to <code>true</code>, the <code>related_result</code> element in the response will be provided as a snippet of its parent organic result;<p>if set to <code>false</code>, the <code>related_result</code> element will be provided as a separate organic result;<p>default value: <code>true</code></p>'
          nullable: true
        url:
          type: string
          description: '<p><em>direct URL of the search query</em><p>optional field<p>you can specify a direct URL and we will sort it out to the necessary fields. Note that this method is the most difficult for our API to process and also requires you to specify the exact language and location in the URL. In most cases, we wouldn’t recommend using this method.<p>example:<p><code class="long-string">https://www.google.co.uk/search?q=%20rank%20tracker%20api&amp;hl=en&amp;gl=GB&amp;uule=w+CAIQIFISCXXeIa8LoNhHEZkq1d1aOpZS</code></p><br><strong>Note:</strong> the following search engine parameters are not supported and will be automatically unset if specified in the URL: <code>lr</code>, <code>cr</code>, <code>as_qdr</code>, <code>as_sitesearch</code>, <code>as_occt</code>, <code>as_filetype</code>.'
          nullable: true
        location_coordinate:
          type: string
          description: '<p><em>GPS coordinates of a location</em><p><strong>required field if you don''t specify</strong> <code>location_name</code>&nbsp;or <code>location_code</code><p><strong>if you use this field, you don''t need to specify <code>location_name</code> or <code>location_code</code></strong><p><code>location_coordinate</code> parameter should be specified in the <em>"latitude,longitude,radius"</em> format<p>the maximum number of decimal digits for <em>"latitude"</em> and <em>"longitude"</em>: 7<p>the minimum value for <em>"radius"</em>: 199 (mm)<p>the maximum value for <em>"radius"</em>: 199999 (mm)<p>example:<p><code class="long-string">53.476225,-2.243572,200</code></p>'
        se_domain:
          type: string
          description: '<p><em>search engine domain</em><p>optional field<p>we choose the relevant search engine domain automatically according to the location and language you specify<p>however, you can set a custom search engine domain in this field<p>example:<p><code><em>google.co.uk</em></code>, <code><em>google.com.au</em></code>, <code><em>google.de</em></code>, etc.</p>'
          nullable: true
        target:
          type: string
          description: '<p><em>target domain, subdomain, or webpage to get results for</em><p>optional field<p>a domain or a subdomain should be specified without <code>https://</code> and <code>www.</code><p>note that the results of <code>target</code>-specific tasks will only include SERP elements that contain a <code>url</code> string;<p>you can also use a wildcard (‘*’) character to specify the search pattern in SERP and narrow down the results;<p>examples:<p><strong><code class="long-string">example.com</code></strong>  - returns results for the website''s home page with URLs, such as <code class="long-string">https://example.com</code>, or <code class="long-string">https://www.example.com/</code>, or <code class="long-string">https://example.com/</code>;<p><strong><code class="long-string">example.com*</code></strong> - returns results for the domain, including all its pages;<p><strong><code class="long-string">*example.com*</code></strong> - returns results for the entire domain, including all its pages and subdomains;<p><strong><code class="long-string">*example.com</code></strong>  - returns results for the home page regardless of the subdomain, such as <code class="long-string">https://en.example.com</code>;<p><strong><code class="long-string">example.com/example-page</code></strong>  - returns results for the exact URL;<p><strong><code class="long-string">example.com/example-page*</code></strong>  - returns results for all domain''s URLs that start with the specified string</p>'
          nullable: true
        target_search_mode:
          type: string
          description: '<p><em>target matching mode</em><p>optional field<p>to enable this parameter, <code>stop_crawl_on_match</code> must also be enabled<p>defines how the crawl should stop when multiple targets are specified in <code>stop_crawl_on_match</code><p>possible values: <code>all</code>, <code>any</code><p><code>all</code> – the crawl stops only when all specified targets are found<p><code>any</code> – the crawl stops when any single target is found<p>default value: <code>any</code><p>learn more about this parameter on our <a href="https://dataforseo.com/help-center/how-to-use-new-crawl-control-parameters-in-google-organic-serp-api" target="_blank">Help Center</a></p>'
          nullable: true
        find_targets_in:
          type: array
          items:
            type: string
          description: '<p><em>SERP element types to check for targets</em><p>optional field<p>to enable this parameter, <code>stop_crawl_on_match</code> must also be enabled<p>specifies which SERP element types should be checked for target matches<p>if not specified, all first-level elements with <code>url</code> and <code>domain</code> fields are checked for targets<p>possible values: <code>organic</code>, <code>paid</code>, <code>local_pack</code>, <code>featured_snippet</code>, <code>events</code>, <code>google_flights</code>, <code>images</code>, <code>jobs</code>, <code>knowledge_graph</code>, <code>local_service</code>, <code>map</code>, <code>scholarly_articles</code>, <code>third_party_reviews</code>, <code>twitter</code><p><strong>Note:</strong> cannot contain the same element types as <code>ignore_targets_in</code><p>example:<p><code>"find_targets_in": ["organic", "featured_snippet"]</code><p>learn more about this parameter on our <a href="https://dataforseo.com/help-center/how-to-use-new-crawl-control-parameters-in-google-organic-serp-api" target="_blank">Help Center</a></p>'
          nullable: true
        ignore_targets_in:
          type: array
          items:
            type: string
          description: '<p><em>SERP element types to exclude from target search</em><p>optional field<p>to enable this parameter, <code>stop_crawl_on_match</code> must also be enabled<p>specifies which SERP element types should be excluded when searching for target matches<p>possible values: <code>organic</code>, <code>paid</code>, <code>local_pack</code>, <code>featured_snippet</code>, <code>events</code>, <code>google_flights</code>, <code>images</code>, <code>jobs</code>, <code>knowledge_graph</code>, <code>local_service</code>, <code>map</code>, <code>scholarly_articles</code>, <code>third_party_reviews</code>, <code>twitter</code><p><strong>Note:</strong> cannot contain the same element types as <code>find_targets_in</code><p>example:<p><code>"ignore_targets_in": ["paid", "images"]</code><p>learn more about this parameter on our <a href="https://dataforseo.com/help-center/how-to-use-new-crawl-control-parameters-in-google-organic-serp-api" target="_blank">Help Center</a></p>'
          nullable: true
      example:
        - language_code: en
          location_code: 2840
          keyword: albert einstein
    SerpGoogleOrganicLiveRegularResultInfo:
      type: object
      properties:
        keyword:
          type: string
          description: <em>keyword received in a POST array</em><br><strong>keyword is returned with decoded %## (plus character '+' will be decoded to a space character)</strong>
          nullable: true
        type:
          type: string
          description: type of element
          nullable: true
        se_domain:
          type: string
          description: <em>search engine domain in a POST array</em>
          nullable: true
        location_code:
          type: integer
          description: <em>location code in a POST array</em>
          nullable: true
        language_code:
          type: string
          description: <em>language code in a POST array</em>
          nullable: true
        check_url:
          type: string
          description: <em>direct URL to search engine results<br></em>you can use it to make sure that we provided exact results
          nullable: true
        datetime:
          type: string
          description: '<em>date and time when the result was received</em><br>in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”<br>example:<br><code class="long-string">2019-11-15 12:57:46 +00:00</code>'
          nullable: true
        spell:
          type: object
          oneOf:
            - $ref: '#/components/schemas/SpellInfo'
          description: '<em>autocorrection of the search engine</em><br>if the search engine provided results for a keyword that was corrected, we will specify the keyword corrected by the search engine and the type of autocorrection'
          nullable: true
        refinement_chips:
          type: object
          oneOf:
            - $ref: '#/components/schemas/RefinementChipsInfo'
          description: <em>search refinement chips</em>
          nullable: true
        item_types:
          type: array
          items:
            type: string
            nullable: true
          description: '<em>types of search results found in SERP</em><br>contains types of all search results (<code>items</code>) found in the returned SERP<br>possible item types:<br><code>answer_box</code>, <code>app</code>, <code>carousel</code>, <code>multi_carousel</code>, <code>featured_snippet</code>, <code>google_flights</code>, <code>google_reviews</code>, <code>third_party_reviews</code>,  <code>images</code>, <code>jobs</code>, <code>knowledge_graph</code>, <code>local_pack</code>, <code>hotels_pack</code>, <code>map</code>, <code>organic</code>, <code>paid</code>, <code>people_also_ask</code>, <code>related_searches</code>, <code>people_also_search</code>, <code>shopping</code>, <code>top_stories</code>, <code>twitter</code>, <code>video</code>, <code>events</code>, <code>recipes</code>, <code>top_sights</code>, <code>scholarly_articles</code>, <code>popular_products</code>, <code>questions_and_answers</code>, <code>find_results_on</code>, <code>stocks_box</code>, <code>commercial_units</code>, <code>local_services</code>, <code>google_hotels</code>, <code>math_solver</code>, <code>currency_box</code>, <code>product_considerations</code>, <code>short_videos</code>, <code>refine_products</code>, <code>perspectives</code>, <code>discussions_and_forums</code>, <code>compare_sites</code>, <code>ai_overview</code><p><strong>note</strong> that this array contains all types of search results found in the returned SERP;<br>however, this endpoint provides data for <code>featured_snippet</code>, <code>organic</code> and <code>paid</code> types only<br>to get all items (inlcuding SERP features and rich snippets) found in the returned SERP, please refer to the <a href="https://docs.dataforseo.com/v3/serp/google/organic/live/advanced/?php">Google Organiс Advanced SERP</a> endpoint'
          nullable: true
        se_results_count:
          type: integer
          description: <em>total number of results in SERP</em>
          format: int64
          nullable: true
        pages_count:
          type: integer
          description: <em>total search results pages retrieved</em><br>total number of retrieved SERPs in the result
          format: int64
          nullable: true
        items_count:
          type: integer
          description: <em>the number of results returned in the <strong><code>items</code></strong> array</em>
          format: int64
          nullable: true
        items:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/BaseSerpApiElementItem'
            nullable: true
          description: <em>items of the element</em>
          nullable: true
    SerpGoogleOrganicLiveRegularTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleOrganicLiveRegularResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    SerpGoogleOrganicLiveRegularResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleOrganicLiveRegularTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    SerpGoogleOrganicLiveAdvancedRequestInfo:
      type: object
      properties:
        keyword:
          type: string
          description: 'keywordrequired fieldyou can specify up to 700 characters in the keyword fieldall %## will be decoded (plus character ‘+’ will be decoded to a space character)if you need to use the “%” character for your keyword, please specify it as “%25”;if you need to use the “+” character for your keyword, please specify it as “%2B”;if this field contains such parameters as ‘allinanchor:’, ‘allintext:’, ‘allintitle:’, ‘allinurl:’, ‘cache:’, ‘define:’, ‘definition:’, ‘filetype:’, ‘id:’, ‘inanchor:’, ‘info:’, ‘intext:’, ‘intitle:’, ‘inurl:’, ‘link:’, ‘site:’, the charge per task will be multiplied by 5learn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article'
        location_code:
          type: integer
          description: 'search engine location coderequired field if you don''t specify location_name or location_coordinateif you use this field, you don''t need to specify location_name or location_coordinateyou can receive the list of available locations of the search engines with their location_code by making a separate request to the https://api.dataforseo.com/v3/serp/google/locationsexample:2840'
          nullable: true
        language_code:
          type: string
          description: 'search engine language codeoptional field if you specify language_nameif you use this field, you don''t need to specify language_nameyou can receive the list of available languages of the search engine with their language_code by making a separate request to the https://api.dataforseo.com/v3/serp/google/languagesexample:en'
          nullable: true
        depth:
          type: integer
          description: 'parsing depthoptional fieldnumber of results in SERPdefault value: 10max value: 200Your account will be billed per each SERP containing up to 10 results;Setting depth above 10 may result in additional charges if the search engine returns more than 10 results;The cost can be calculated on the Pricing page.'
          nullable: true
        device:
          type: string
          description: 'device typeoptional fieldreturn results for a specific device typecan take the values:desktop, mobiledefault value: desktop'
          nullable: true
        load_async_ai_overview:
          type: boolean
          description: 'load asynchronous ai overviewoptional fieldset to true to obtain ai_overview items is SERPs even if they are loaded asynchronously;if set to false, you will only obtain ai_overview items from cache;default value: falseNote: you will be charged extra $0.002 for using this parameter;if the element is absent or contains "asynchronous_ai_overview": false, all extra charges will be returned to your account balance'
          nullable: true
        location_name:
          type: string
          description: 'full name of search engine locationrequired field if you don''t specify location_code or location_coordinateif you use this field, you don''t need to specify location_code or location_coordinateyou can receive the list of available locations of the search engine with their location_name by making a separate request to the https://api.dataforseo.com/v3/serp/google/locationsexample:London,England,United Kingdom'
          nullable: true
        language_name:
          type: string
          description: 'full name of search engine languageoptional field if you specify language_codeif you use this field, you don''t need to specify language_codeyou can receive the list of available languages of the search engine with their language_name by making a separate request to the https://api.dataforseo.com/v3/serp/google/languagesexample:English'
          nullable: true
        os:
          type: string
          description: 'device operating systemoptional fieldif you specify desktop in the device field, choose from the following values: windows, macosdefault value: windowsif you specify mobile in the device field, choose from the following values: android, iosdefault value: android'
          nullable: true
        tag:
          type: string
          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
          nullable: true
        stop_crawl_on_match:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/SerpApiStopCrawlOnMatchInfo'
            nullable: true
          description: "array of targets to stop crawling\noptional field\nif specified, the response will contain SERP results up to and including the specified match_value;\nyou can specify up to 10 target values in this array\nexample:\n\"stop_crawl_on_match\":[{\"match_value\":\"dataforseo.com\",\"match_type\":\"with_subdomains\"}]\nlearn more about this parameter on our Help Center - https://dataforseo.com/help-center/using-the-stop_crawl_on_match-parameter-in-serp-api\nYour account will be billed per each SERP crawled through the specified targets"
          nullable: true
        match_type:
          type: string
          description: target match typerequired field if stop_crawl_on_match is specifiedtype of match for the match_valuepossible values:domain – specific domain or subdomainwith_subdomains – main domain and subdomainswildcard –  wildcard pattern
          nullable: true
        match_value:
          type: string
          description: 'target domain, subdomain, or wildcard valuerequired field if stop_crawl_on_match is specifiedspecify a target domain, subdomain, or wildcard value;Note: domain or subdomain must be specified without a request protocol;example: "match_value": "dataforseo.com","match_value": "/blog/post-*"'
          nullable: true
        max_crawl_pages:
          type: integer
          description: 'page crawl limitoptional fieldnumber of search results pages to crawlmax value: 100Note: you will be charged for each page crawled (10 organic results per page);learn more about pricing on our Pricing page;Note#2: the max_crawl_pages and depth parameters complement each other;learn more at our help center'
          nullable: true
        search_param:
          type: string
          description: 'additional parameters of the search queryoptional fieldget the list of available parameters and additional details hereNote: the following search engine parameters are not supported and will be automatically unset if specified: lr, cr, as_qdr, as_sitesearch, as_occt, as_filetype.'
          nullable: true
        remove_from_url:
          type: array
          items:
            type: string
          description: 'remove specific parameters from URLsoptional fieldusing this field, you can specify up to 10 parameters to remove from URLs in the resultexample:"remove_from_url": ["srsltid"]Note: if the target field is specified, the specified URL parameters will be removed before the search'
          nullable: true
        people_also_ask_click_depth:
          type: integer
          description: 'clicks on the corresponding elementoptional fieldspecify the click depth on the people_also_ask element to get additional people_also_ask_element items;Note your account will be billed $0.00015 extra for each click;if the element is absent or we perform fewer clicks than you specified, all extra charges will be returned to your account balancepossible values: from 1 to 4'
          nullable: true
        group_organic_results:
          type: boolean
          description: 'display related resultsoptional fieldif set to true, the related_result element in the response will be provided as a snippet of its parent organic result;if set to false, the related_result element will be provided as a separate organic result;default value: true'
          nullable: true
        calculate_rectangles:
          type: boolean
          description: 'calcualte pixel rankings for SERP elements in advanced resultsoptional fieldpixel ranking refers to the distance between the result snippet and top left corner of the screen;Visit Help Center to learn more>>by default, the parameter is set to false;Note: you will be charged extra $0.002 for using this parameter'
          nullable: true
        browser_screen_width:
          type: integer
          description: 'browser screen widthoptional fieldyou can set a custom browser screen width to calculate pixel rankings for a particular device;can be specified within the following range: 240-9999;by default, the parameter is set to:1920 for desktop;360 for mobile on android;375 for mobile on iOS;Note: to use this parameter, set calculate_rectangles to true'
          format: int64
          nullable: true
        browser_screen_height:
          type: integer
          description: 'browser screen heightoptional fieldyou can set a custom browser screen height to calculate pixel rankings for a particular device;can be specified within the following range: 240-9999;by default, the parameter is set to:1080 for desktop;640 for mobile on android;812 for mobile on iOS;Note: to use this parameter, set calculate_rectangles to true'
          nullable: true
        browser_screen_resolution_ratio:
          type: integer
          description: 'browser screen resolution ratiooptional fieldyou can set a custom browser screen resolution ratio to calculate pixel rankings for a particular device;can be specified within the following range: 0.5-3;by default, the parameter is set to:1 for desktop;3 for mobile on android;3 for mobile on iOS;Note: to use this parameter, set calculate_rectangles to true'
          nullable: true
        url:
          type: string
          description: 'direct URL of the search queryoptional fieldyou can specify a direct URL and we will sort it out to the necessary fields. Note that this method is the most difficult for our API to process and also requires you to specify the exact language and location in the URL. In most cases, we wouldn’t recommend using this method.example:https://www.google.co.uk/search?q=%20rank%20tracker%20api&hl=en&gl=GB&uule=w+CAIQIFISCXXeIa8LoNhHEZkq1d1aOpZSNote: the following search engine parameters are not supported and will be automatically unset if specified in the URL: lr, cr, as_qdr, as_sitesearch, as_occt, as_filetype.'
          nullable: true
        location_coordinate:
          type: string
          description: 'GPS coordinates of a locationoptional field if you specify location_name or location_codeif you use this field, you don''t need to specify location_name or location_codelocation_coordinate parameter should be specified in the "latitude,longitude,radius" formatthe maximum number of decimal digits for "latitude" and "longitude": 7the minimum value for "radius": 199 (mm)the maximum value for "radius": 199999 (mm)example:53.476225,-2.243572,200'
          nullable: true
        se_domain:
          type: string
          description: 'search engine domainoptional fieldwe choose the relevant search engine domain automatically according to the location and language you specifyhowever, you can set a custom search engine domain in this fieldexample:google.co.uk, google.com.au, google.de, etc.'
          nullable: true
        target:
          type: string
          description: 'target domain, subdomain, or webpage to get results foroptional fielda domain or a subdomain should be specified without https:// and www.note that the results of target-specific tasks will only include SERP elements that contain a url string;you can also use a wildcard (‘*’) character to specify the search pattern in SERP and narrow down the results;examples:example.com - returns results for the website''s home page with URLs, such as https://example.com, or https://www.example.com/, or https://example.com/;example.com* - returns results for the domain, including all its pages;*example.com* - returns results for the entire domain, including all its pages and subdomains;*example.com - returns results for the home page regardless of the subdomain, such as https://en.example.com;example.com/example-page - returns results for the exact URL;example.com/example-page* - returns results for all domain''s URLs that start with the specified string'
          nullable: true
        target_search_mode:
          type: string
          description: 'target matching modeoptional fieldto enable this parameter, stop_crawl_on_match must also be enableddefines how the crawl should stop when multiple targets are specified in stop_crawl_on_matchpossible values: all, anyall – the crawl stops only when all specified targets are foundany – the crawl stops when any single target is founddefault value: anylearn more about this parameter on our Help Center'
          nullable: true
        find_targets_in:
          type: array
          items:
            type: string
          description: 'SERP element types to check for targetsoptional fieldto enable this parameter, stop_crawl_on_match must also be enabledspecifies which SERP element types should be checked for target matchesif not specified, all first-level elements with url and domain fields are checked for targetspossible values: organic, paid, local_pack, featured_snippet, events, google_flights, images, jobs, knowledge_graph, local_service, map, scholarly_articles, third_party_reviews, twitterNote: cannot contain the same element types as ignore_targets_inexample:"find_targets_in": ["organic", "featured_snippet"]learn more about this parameter on our Help Center'
          nullable: true
        ignore_targets_in:
          type: array
          items:
            type: string
          description: 'SERP element types to exclude from target searchoptional fieldto enable this parameter, stop_crawl_on_match must also be enabledspecifies which SERP element types should be excluded when searching for target matchespossible values: organic, paid, local_pack, featured_snippet, events, google_flights, images, jobs, knowledge_graph, local_service, map, scholarly_articles, third_party_reviews, twitterNote: cannot contain the same element types as find_targets_inexample:"ignore_targets_in": ["paid", "images"]learn more about this parameter on our Help Center'
          nullable: true
      example:
        - language_code: en
          location_code: 2840
          keyword: albert einstein
          calculate_rectangles: true
    SerpGoogleOrganicLiveAdvancedResultInfo:
      type: object
      properties:
        keyword:
          type: string
          description: keyword received in a POST arraythe keyword is returned with decoded %## (plus character '+' will be decoded to a space character)
          nullable: true
        type:
          type: string
          description: type of element
          nullable: true
        se_domain:
          type: string
          description: search engine domain in a POST array
          nullable: true
        location_code:
          type: integer
          description: location code in a POST array
          nullable: true
        language_code:
          type: string
          description: language code in a POST array
          nullable: true
        check_url:
          type: string
          description: direct URL to search engine resultsyou can use it to make sure that we provided accurate results
          nullable: true
        datetime:
          type: string
          description: 'date and time when the result was receivedin the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”example:2019-11-15 12:57:46 +00:00'
          nullable: true
        spell:
          type: object
          oneOf:
            - $ref: '#/components/schemas/SpellInfo'
          description: 'autocorrection of the search engineif the search engine provided results for a keyword that was corrected, we will specify the keyword corrected by the search engine and the type of autocorrection'
          nullable: true
        refinement_chips:
          type: object
          oneOf:
            - $ref: '#/components/schemas/RefinementChipsInfo'
          description: search refinement chips
          nullable: true
        item_types:
          type: array
          items:
            type: string
            nullable: true
          description: 'types of search results in SERPcontains types of search results (items) found in SERP.possible item types:answer_box, app, carousel, multi_carousel, featured_snippet, google_flights, google_reviews, third_party_reviews, images, jobs, knowledge_graph, local_pack, hotels_pack, map, organic, paid, people_also_ask, related_searches, people_also_search, shopping, top_stories, twitter, video, events, recipes, top_sights, scholarly_articles, popular_products,  questions_and_answers, find_results_on, stocks_box, commercial_units, local_services, google_hotels, math_solver, currency_box,product_considerations, short_videos, refine_products, perspectives, discussions_and_forums, compare_sites, ai_overview'
          nullable: true
        se_results_count:
          type: integer
          description: total number of results in SERP
          format: int64
          nullable: true
        pages_count:
          type: integer
          description: total search results pages retrievedtotal number of retrieved SERPs in the result
          format: int64
          nullable: true
        items_count:
          type: integer
          description: the number of results returned in the items array
          format: int64
          nullable: true
        items:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/BaseSerpApiElementItem'
            nullable: true
          description: items of the element
          nullable: true
    SerpGoogleOrganicLiveAdvancedTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleOrganicLiveAdvancedResultInfo'
                nullable: true
              description: array of results
              nullable: true
    SerpGoogleOrganicLiveAdvancedResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleOrganicLiveAdvancedTaskInfo'
                nullable: true
              description: array of tasks
              nullable: true
    SerpGoogleOrganicLiveHtmlRequestInfo:
      type: object
      properties:
        keyword:
          type: string
          description: '<p><em>keyword</em><p><strong>required field</strong><p>you can specify <strong>up to 700 characters</strong> in the <code>keyword</code> field<p>all %## will be decoded (plus character ''+'' will be decoded to a space character)<p>if you need to use the "%" character for your <code>keyword</code>, please specify it as "%25";<p>if you need to use the “+” character for your <code>keyword</code>, please specify it as “%2B”;<p>if this field contains such parameters as <em>''allinanchor:'', ''allintext:'', ''allintitle:'', ''allinurl:'', ‘cache:’, ''define:'', ''filetype:'', ''id:'', ''inanchor:'', ''info:'', ''intext:'', ''intitle:'', ''inurl:'', ''link:'', ''related:'', ''site:''</em>, <strong>the charge per task will be multiplied by 5</strong>'
        location_code:
          type: integer
          description: '<p><em>search engine location code</em><p><strong>required field if you don''t specify</strong> <code>location_name</code>&nbsp;or <code>location_coordinate</code><p><strong>if you use this field, you don''t need to specify <code>location_name</code> or <code>location_coordinate</code></strong><p>you can receive the list of available locations of the search engines with their <code>location_code</code> by making a separate request to the <code>https://api.dataforseo.com/v3/serp/google/locations</code><p>example:<p><code class="long-string">2840</code></p>'
        language_code:
          type: string
          description: '<p><em>search engine language code</em><p><strong>required field if you don''t specify</strong> <code>language_name</code><p><strong>if you use this field, you don''t need to specify <code>language_name</code></strong><p>you can receive the list of available languages of the search engine with their <code>language_code</code>&nbsp;by making a separate request to the <code>https://api.dataforseo.com/v3/serp/google/languages</code><em><p></em>example:<em><p></em><code class="long-string">en</code></p>'
        depth:
          type: integer
          description: '<p><em>parsing depth</em><p>optional field<p>number of results in SERP<p><strong>default value: <code>10</code></strong><p>max value: <code>200</code></p><br><strong>Your account will be billed per each SERP containing up to 10 results;</strong><p>Setting depth above 10 may result in additional charges <a href="https://dataforseo.com/help-center/how-many-results-scraped" rel="noopener noreferrer" target="_blank">if the search engine returns more than 10 results</a>;<p>The cost can be calculated on the <a title="Pricing" href="https://dataforseo.com/pricing/serp/google-organic-serp-api" target="_blank" rel="noopener noreferrer">Pricing</a> page.'
          nullable: true
        device:
          type: string
          description: '<p><em>device type</em><p>optional field<p>return results for a specific device type<p>can take the values:<code>desktop</code>, <code>mobile</code><p>default value: <code>desktop</code></p>'
          nullable: true
        load_async_ai_overview:
          type: boolean
          description: '<p><em>load asynchronous ai overview</em><p>optional field<p>set to <code>true</code> to obtain <code>ai_overview</code> items is SERPs even if they are loaded asynchronously;<p>if set to <code>false</code>, you will only obtain <code>ai_overview</code> items from cache;<p>default value: <code>false</code><p><strong>Note</strong> your account will be billed $0.002 extra for each request;<p>if the element is absent or contains <code>"asynchronous_ai_overview": false</code>, all extra charges will be returned to your account balance</p>'
          nullable: true
        location_name:
          type: string
          description: '<p><em>full name of search engine location</em><p><strong>required field if you don''t specify</strong> <code>location_code</code> or <code>location_coordinate</code><p><strong>if you use this field, you don''t need to specify <code>location_code</code> or <code>location_coordinate</code></strong><p>you can receive the list of available locations of the search engine with their <code>location_name</code> by making a separate request to the <code>https://api.dataforseo.com/v3/serp/google/locations</code><p>example:<p><code class="long-string">London,England,United Kingdom</code></p>'
        language_name:
          type: string
          description: '<p><em>full name of search engine language</em><p><strong>required field if you don''t specify</strong> <code>language_code</code><p><strong>if you use this field, you don''t need to specify <code>language_code</code></strong><p>you can receive the list of available languages of the search engine with their <code>language_name</code> by making a separate request to the <code>https://api.dataforseo.com/v3/serp/google/languages</code><p>example:<p><code class="long-string">English</code></p>'
        os:
          type: string
          description: '<p><em>device operating system</em><p>optional field<p>if you specify <code>desktop</code> in the <code>device</code> field, choose from the following values: <code>windows</code>, <code>macos</code><p>default value: <code>windows</code><p>if you specify <code>mobile</code> in the <code>device</code> field, choose from the following values: <code>android</code>, <code>ios</code><p>default value: <code>android</code></p>'
          nullable: true
        tag:
          type: string
          description: <p><em>user-defined task identifier</em><p>optional field<p><em>the character limit is 255</em><p>you can use this parameter to identify the task and match it with the result<p>you will find the specified <code>tag</code> value in the <code>data</code> object of the response</p>
          nullable: true
        stop_crawl_on_match:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/SerpApiStopCrawlOnMatchInfo'
            nullable: true
          description: "array of targets to stop crawling\noptional field\nif specified, the response will contain SERP results up to and including the specified match_value;\nyou can specify up to 10 target values in this array\nexample:\n\"stop_crawl_on_match\":[{\"match_value\":\"dataforseo.com\",\"match_type\":\"with_subdomains\"}]\nlearn more about this parameter on our Help Center - https://dataforseo.com/help-center/using-the-stop_crawl_on_match-parameter-in-serp-api\nYour account will be billed per each SERP crawled through the specified targets"
          nullable: true
        match_type:
          type: string
          description: <p><em>target match type</em><p><strong>required field if <code>stop_crawl_on_match</code> is specified</strong><p>type of match for the <code>match_value</code><p>possible values:<p><code>domain</code> – specific domain or subdomain<p><code>with_subdomains</code> – main domain and subdomains<p><code>wildcard</code> –  wildcard pattern</p>
        match_value:
          type: string
          description: '<p><em>target domain, subdomain, or wildcard value</em><p><strong>required field if <code>stop_crawl_on_match</code> is specified</strong><p>specify a target domain, subdomain, or wildcard value;<p><strong>Note:</strong> domain or subdomain must be specified without a request protocol;<p>example: <code>"match_value": "dataforseo.com"</code>,<p><code>"match_value": "/blog/post-*"</code></p>'
        max_crawl_pages:
          type: integer
          description: '<p><em>page crawl limit</em><p>optional field<p>number of search results pages to crawl<p>max value: <code>100</code><p><strong>Note:</strong> you will be charged for each page crawled (10 organic results per page);<p>learn more about pricing on our <a href="https://dataforseo.com/pricing/serp/google-organic-serp-api" target="_blank">Pricing</a> page;<p><strong>Note#2:</strong> the <code>max_crawl_pages</code> and <code>depth</code> parameters complement each other;<p>learn more at <a href="https://dataforseo.com/help-center/what-is-max-crawl-pages-and-how-does-it-work" rel="noopener noreferrer" target="_blank">our help center</a></p>'
          nullable: true
        search_param:
          type: string
          description: '<p><em>additional parameters of the search query</em><p>optional field<p><a href="https://dataforseo.com/what-are-google-search-parameters-and-how-to-use-them-with-serp-api.html">get the list of available parameters and additional details here</a></p><br><strong>Note:</strong> the following search engine parameters are not supported and will be automatically unset if specified: <code>lr</code>, <code>cr</code>, <code>as_qdr</code>, <code>as_sitesearch</code>, <code>as_occt</code>, <code>as_filetype</code>.'
          nullable: true
        expand_ai_overview:
          type: boolean
          description: '<p><em>expand ai overview</em><p>optional field<p>set to <code>true</code> to expand the <code>ai_overview</code> item;<p>default value: <code>false</code></p>'
          nullable: true
        url:
          type: string
          description: '<p><em>direct URL of the search query</em><p>optional field<p>you can specify a direct URL and we will sort it out to the necessary fields. Note that this method is the most difficult for our API to process and also requires you to specify the exact language and location in the URL. In most cases, we wouldn’t recommend using this method.<p>example:<p><code class="long-string">https://www.google.co.uk/search?q=%20rank%20tracker%20api&amp;hl=en&amp;gl=GB&amp;uule=w+CAIQIFISCXXeIa8LoNhHEZkq1d1aOpZS</code></p><br><strong>Note:</strong> the following search engine parameters are not supported and will be automatically unset if specified in the URL: <code>lr</code>, <code>cr</code>, <code>as_qdr</code>, <code>as_sitesearch</code>, <code>as_occt</code>, <code>as_filetype</code>.'
          nullable: true
        location_coordinate:
          type: string
          description: '<p><em>GPS coordinates of a location</em><p><strong>required field if you don''t specify</strong> <code>location_name</code>&nbsp;or <code>location_code</code><p><strong>if you use this field, you don''t need to specify <code>location_name</code> or <code>location_code</code></strong><p><code>location_coordinate</code> parameter should be specified in the <em>"latitude,longitude,radius"</em> format<p>the maximum number of decimal digits for <em>"latitude"</em> and <em>"longitude"</em>: 7<p>the minimum value for <em>"radius"</em>: 199 (mm)<p>the maximum value for <em>"radius"</em>: 199999 (mm)<p>example:<p><code class="long-string">53.476225,-2.243572,200</code></p>'
        se_domain:
          type: string
          description: '<p><em>search engine domain</em><p>optional field<p>we choose the relevant search engine domain automatically according to the location and language you specify<p>however, you can set a custom search engine domain in this field<p>example:<p><code><em>google.co.uk</em></code>, <code><em>google.com.au</em></code>, <code><em>google.de</em></code>, etc.</p>'
          nullable: true
        target_search_mode:
          type: string
          description: '<p><em>target matching mode</em><p>optional field<p>to enable this parameter, <code>stop_crawl_on_match</code> must also be enabled<p>defines how the crawl should stop when multiple targets are specified in <code>stop_crawl_on_match</code><p>possible values: <code>all</code>, <code>any</code><p><code>all</code> – the crawl stops only when all specified targets are found<p><code>any</code> – the crawl stops when any single target is found<p>default value: <code>any</code><p>learn more about this parameter on our <a href="https://dataforseo.com/help-center/how-to-use-new-crawl-control-parameters-in-google-organic-serp-api" target="_blank">Help Center</a></p>'
          nullable: true
        find_targets_in:
          type: array
          items:
            type: string
          description: '<p><em>SERP element types to check for targets</em><p>optional field<p>to enable this parameter, <code>stop_crawl_on_match</code> must also be enabled<p>specifies which SERP element types should be checked for target matches<p>if not specified, all first-level elements with <code>url</code> and <code>domain</code> fields are checked for targets<p>possible values: <code>organic</code>, <code>paid</code>, <code>local_pack</code>, <code>featured_snippet</code>, <code>events</code>, <code>google_flights</code>, <code>images</code>, <code>jobs</code>, <code>knowledge_graph</code>, <code>local_service</code>, <code>map</code>, <code>scholarly_articles</code>, <code>third_party_reviews</code>, <code>twitter</code><p><strong>Note:</strong> cannot contain the same element types as <code>ignore_targets_in</code><p>example:<p><code>"find_targets_in": ["organic", "featured_snippet"]</code><p>learn more about this parameter on our <a href="https://dataforseo.com/help-center/how-to-use-new-crawl-control-parameters-in-google-organic-serp-api" target="_blank">Help Center</a></p>'
          nullable: true
        ignore_targets_in:
          type: array
          items:
            type: string
          description: '<p><em>SERP element types to exclude from target search</em><p>optional field<p>to enable this parameter, <code>stop_crawl_on_match</code> must also be enabled<p>specifies which SERP element types should be excluded when searching for target matches<p>possible values: <code>organic</code>, <code>paid</code>, <code>local_pack</code>, <code>featured_snippet</code>, <code>events</code>, <code>google_flights</code>, <code>images</code>, <code>jobs</code>, <code>knowledge_graph</code>, <code>local_service</code>, <code>map</code>, <code>scholarly_articles</code>, <code>third_party_reviews</code>, <code>twitter</code><p><strong>Note:</strong> cannot contain the same element types as <code>find_targets_in</code><p>example:<p><code>"ignore_targets_in": ["paid", "images"]</code><p>learn more about this parameter on our <a href="https://dataforseo.com/help-center/how-to-use-new-crawl-control-parameters-in-google-organic-serp-api" target="_blank">Help Center</a></p>'
          nullable: true
      example:
        - language_code: en
          location_code: 2840
          keyword: albert einstein
    SerpGoogleOrganicLiveHtmlResultInfo:
      type: object
      properties:
        keyword:
          type: string
          description: <em>keyword received in a POST array<br></em><strong>keyword is returned with decoded %## (plus character '+' will be decoded to a space character)</strong>
          nullable: true
        type:
          type: string
          description: type of element
          nullable: true
        se_domain:
          type: string
          description: <em>search engine domain in a POST array</em>
          nullable: true
        location_code:
          type: integer
          description: <em>location code in a POST array</em>
          nullable: true
        language_code:
          type: string
          description: <em>language code in a POST array</em>
          nullable: true
        datetime:
          type: string
          description: '<em>date and time when the result was received</em><br>in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”<br>example:<br><code class="long-string">2019-11-15 12:57:46 +00:00</code>'
          nullable: true
        items_count:
          type: integer
          description: <em>the number of results returned in the <strong><code>items</code></strong> array</em>
          format: int64
          nullable: true
        items:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/HtmlItemInfo'
            nullable: true
          description: <em>elements of search results found in SERP</em>
          nullable: true
    SerpGoogleOrganicLiveHtmlTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleOrganicLiveHtmlResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    SerpGoogleOrganicLiveHtmlResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleOrganicLiveHtmlTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    SerpGoogleAiModeLanguagesResultInfo:
      type: object
      properties:
        language_name:
          type: string
          description: <em>language name</em>
          nullable: true
        language_code:
          type: string
          description: <em>language code according to <a href="https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes" target="_blank" rel="noopener noreferrer">ISO 639-1</a></em>
          nullable: true
    SerpGoogleAiModeLanguagesTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleAiModeLanguagesResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    SerpGoogleAiModeLanguagesResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleAiModeLanguagesTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    SerpGoogleAiModeTaskPostRequestInfo:
      type: object
      properties:
        keyword:
          type: string
          description: '<p><em>keyword</em><p><strong>required field</strong><p>you can specify <strong>up to 700 characters</strong> in the <code>keyword</code> field<p>all %## will be decoded (plus character ‘+’ will be decoded to a space character)<p>if you need to use the “%” character for your <code>keyword</code>, please specify it as “%25”;<p>if you need to use the “+” character for your <code>keyword</code>, please specify it as “%2B”</p><br><p>learn more about rules and limitations of <code>keyword</code> and <code>keywords</code> fields in DataForSEO APIs in this <a href="https://dataforseo.com/help-center/rules-and-limitations-of-keyword-and-keywords-fields-in-dataforseo-apis" rel="noopener noreferrer" target="_blank">Help Center article</a></p>'
        location_code:
          type: integer
          description: '<p><em>search engine location code</em><p><strong>required field if you don''t specify</strong> <code>location_name</code>&nbsp;or <code>location_coordinate</code><p><strong>if you use this field, you don''t need to specify <code>location_name</code> or <code>location_coordinate</code></strong><p>you can receive the list of available locations of the search engines with their <code>location_code</code> by making a separate request to the <code>https://api.dataforseo.com/v3/serp/google/locations</code><p><strong>Note:</strong> check <a href="https://support.google.com/websearch/answer/16011537?hl=en&amp;co=GENIE.Platform%3DAndroid#" target="_blank"> Google Search Help</a> for the list of countries where AI Mode is currently available</p>'
        language_code:
          type: string
          description: '<p><em>search engine language code</em><p>required field if you don''t specify <code>language_name</code>;<p>if you use this field, you don''t need to specify <code>language_name</code>;<p>you can receive the list of available languages of the search engine with their <code>language_code</code>&nbsp;by making a separate request to the <code>https://api.dataforseo.com/v3/serp/google/ai_mode/languages</code></p>'
        priority:
          type: integer
          description: <p><em>task priority</em><p>optional field<p>can take the following values:<p>1 – normal execution priority (set by default)<p>2 – high execution priority</p><br>You will be additionally charged for the tasks with high execution priority.<p>The cost can be calculated on the <a title="Pricing" href="https://dataforseo.com/pricing/serp/google-ai-mode-serp-api" target="_blank" rel="noopener noreferrer">Pricing</a> page.
          nullable: true
        device:
          type: string
          description: '<p><em>device type</em><p>optional field<p>return results for a specific device type<p>can take the values:<code>desktop</code>, <code>mobile</code><p>default value: <code>desktop</code></p>'
          nullable: true
        pingback_url:
          type: string
          description: '<p><em>notification URL of a completed task</em><p>optional field<p>when a task is completed we will notify you by GET request sent to the URL you have specified<p>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<p>example:<p><code>http://your-server.com/pingscript?id=$id</code><p><code>http://your-server.com/pingscript?id=$id&amp;tag=$tag</code><p><strong>Note:</strong> special characters in <code>pingback_url</code> will be urlencoded;<p>i.a., the <code>#</code> character will be encoded into <code>%23</code></p><br><p>learn more on our <a href="https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api" target="_blank" rel="noopener noreferrer">Help Center</a></p>'
          nullable: true
        postback_url:
          type: string
          description: '<p><em>URL for sending task results</em><p>optional field<p>once the task is completed, we will send a POST request with its results compressed in the <code>gzip</code> format to the <code>postback_url</code> you specified<p>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<p>example:<p><code>http://your-server.com/postbackscript?id=$id</code><p><code>http://your-server.com/postbackscript?id=$id&amp;tag=$tag</code><p><strong>Note:</strong> special characters in <code>postback_url</code> will be urlencoded;<p>i.a., the <code>#</code> character will be encoded into <code>%23</code></p><br><p>learn more on our <a href="https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api" target="_blank" rel="noopener noreferrer">Help Center</a></p>'
          nullable: true
        postback_data:
          type: string
          description: '<p><em>postback_url datatype</em><p><strong>required field if you specify <code>postback_url</code></strong><p>corresponds to the function you used for setting a task<p>possible values:<p><code>advanced</code>, <code>html</code></p>'
        location_name:
          type: string
          description: '<p><em>full name of search engine location</em><p><strong>required field if you don''t specify</strong> <code>location_code</code> or <code>location_coordinate</code><p><strong>if you use this field, you don''t need to specify <code>location_code</code> or <code>location_coordinate</code></strong><p>you can receive the list of available locations of the search engine with their <code>location_name</code> by making a separate request to the <code>https://api.dataforseo.com/v3/serp/google/locations</code><p><strong>Note:</strong> check <a href="https://support.google.com/websearch/answer/16011537?hl=en&amp;co=GENIE.Platform%3DAndroid#" target="_blank"> Google Search Help</a> for the list of countries where AI Mode is currently available</p>'
        language_name:
          type: string
          description: '<p><em>full name of search engine language</em><p>required field if you don''t specify <code>language_code</code>;<p>if you use this field, you don''t need to specify <code>language_code</code>;<p>you can receive the list of available languages of the search engine with their <code>language_name</code> by making a separate request to the <code>https://api.dataforseo.com/v3/serp/google/ai_mode/languages</code>;</p>'
        os:
          type: string
          description: '<p><em>device operating system</em><p>optional field<p>if you specify <code>desktop</code> in the <code>device</code> field, choose from the following values: <code>windows</code>, <code>macos</code><p>default value: <code>windows</code><p>if you specify <code>mobile</code> in the <code>device</code> field, choose from the following values: <code>android</code>, <code>ios</code><p>default value: <code>android</code></p>'
          nullable: true
        tag:
          type: string
          description: <p><em>user-defined task identifier</em><p>optional field<p><em>the character limit is 255</em><p>you can use this parameter to identify the task and match it with the result<p>you will find the specified <code>tag</code> value in the <code>data</code> object of the response</p>
          nullable: true
        calculate_rectangles:
          type: boolean
          description: '<p><em>calculate pixel rankings for SERP elements in advanced results</em><p>optional field<p>pixel ranking refers to the distance between the result snippet and top left corner of the screen;<p><a href="https://dataforseo.com/help-center/pixel-ranking-in-serp-api">Visit Help Center to learn more&gt;&gt;</a><p>by default, the parameter is set to <code>false</code><p><strong>Note:</strong> if set to <code>true</code>, the charge per task will be multiplied by 2</p>'
          nullable: true
        browser_screen_width:
          type: integer
          description: '<p><em>browser screen width</em><p>optional field<p>you can set a custom browser screen width to calculate pixel rankings for a particular device;<p>can be specified within the following range: <code>240-9999</code>;<p>by default, the parameter is set to:<p><code>1920</code> for <code>desktop</code>;<p><code>360</code> for <code>mobile</code> on <code>android</code>;<p><code>375</code> for <code>mobile</code> on <code>iOS</code>;<p><strong>Note:</strong> to use this parameter, set <code>calculate_rectangles</code> to <code>true</code></p>'
          format: int64
          nullable: true
        browser_screen_height:
          type: integer
          description: '<p><em>browser screen height</em><p>optional field<p>you can set a custom browser screen height to calculate pixel rankings for a particular device;<p>can be specified within the following range: <code>240-9999</code>;<p>by default, the parameter is set to:<p><code>1080</code> for <code>desktop</code>;<p><code>640</code> for <code>mobile</code> on <code>android</code>;<p><code>812</code> for <code>mobile</code> on <code>iOS</code>;<p><strong>Note:</strong> to use this parameter, set <code>calculate_rectangles</code> to <code>true</code></p>'
          nullable: true
        browser_screen_resolution_ratio:
          type: integer
          description: '<p><em>browser screen resolution ratio</em><p>optional field<p>you can set a custom browser screen resolution ratio to calculate pixel rankings for a particular device;<p>can be specified within the following range: <code>0.5-3</code>;<p>by default, the parameter is set to:<p><code>1</code> for <code>desktop</code>;<p><code>3</code> for <code>mobile</code> on <code>android</code>;<p><code>3</code> for <code>mobile</code> on <code>iOS</code>;<p><strong>Note:</strong> to use this parameter, set <code>calculate_rectangles</code> to <code>true</code></p>'
          nullable: true
        location_coordinate:
          type: string
          description: '<p><em>GPS coordinates of a location</em><p><strong>required field if you don''t specify</strong> <code>location_name</code>&nbsp;or <code>location_code</code><p><strong>if you use this field, you don''t need to specify <code>location_name</code> or <code>location_code</code></strong><p><code>location_coordinate</code> parameter should be specified in the <em>"latitude,longitude,zoom"</em> format<p>if <em>"zoom"</em> is not specified, <em>9z</em> will be applied as a default value<p>the maximum number of decimal digits for <em>"latitude"</em> and <em>"longitude"</em>: 7<p>the minimum value for <em>"zoom"</em>: 4z<p>the maximum value for <em>"zoom"</em>: 18z<p>example:<p><code class="long-string">52.6178549,-155.352142,18z</code></p>'
      example:
        - language_code: en
          location_code: 2840
          keyword: what is google ai mode
    SerpGoogleAiModeTaskPostTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: object
              description: '<em>array of results</em><br>in this case, the value will be <code>null</code>'
              nullable: true
    SerpGoogleAiModeTaskPostResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleAiModeTaskPostTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    SerpGoogleAiModeTasksReadyResultInfo:
      type: object
      properties:
        id:
          type: string
          description: <em>task identifier of the completed task</em><br><strong>unique task identifier in our system in the <a href="https://en.wikipedia.org/wiki/Universally_unique_identifier">UUID</a> format</strong>
          nullable: true
        se:
          type: string
          description: <em>search engine specified when setting the task</em>
          nullable: true
        se_type:
          type: string
          description: '<em>type of search engine</em><br>example: <code>{{low_se_type_under}}</code>'
          nullable: true
        date_posted:
          type: string
          description: <em>date when the task was posted (in the UTC format)</em>
          nullable: true
        tag:
          type: string
          description: <em>user-defined task identifier</em>
          nullable: true
        endpoint_regular:
          type: string
          description: '<em>URL for collecting the results of the SERP Regular task</em><br>if SERP Regular is not supported in the specified endpoint, the value will be <code>null</code>'
          nullable: true
        endpoint_advanced:
          type: string
          description: '<em>URL for collecting the results of the SERP Advanced task</em><br>if SERP Advanced is not supported in the specified endpoint, the value will be <code>null</code>'
          nullable: true
        endpoint_html:
          type: string
          description: '<em>URL for collecting the results of the SERP HTML task</em><br>if SERP HTML is not supported in the specified endpoint, the value will be <code>null</code>'
          nullable: true
    SerpGoogleAiModeTasksReadyTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleAiModeTasksReadyResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    SerpGoogleAiModeTasksReadyResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleAiModeTasksReadyTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    SerpGoogleAiModeTasksFixedResultInfo:
      type: object
      properties:
        id:
          type: string
          description: <em>task identifier of the completed task</em><br><strong>unique task identifier in our system in the <a href="https://en.wikipedia.org/wiki/Universally_unique_identifier">UUID</a> format</strong>
          nullable: true
        se:
          type: string
          description: <em>search engine specified when setting the task</em>
          nullable: true
        se_type:
          type: string
          description: '<em>type of search engine</em><br>can take the following values: <code>{{low_se_type_under}}</code>'
          nullable: true
        date_posted:
          type: string
          nullable: true
        tag:
          type: string
          description: <em>user-defined task identifier</em>
          nullable: true
        endpoint_regular:
          type: string
          description: '<em>URL for collecting the results of the SERP Regular task</em><br>if SERP Regular is not supported in the specified endpoint, the value will be <code>null</code>'
          nullable: true
        endpoint_advanced:
          type: string
          description: '<em>URL for collecting the results of the SERP Advanced task</em><br>if SERP Advanced is not supported in the specified endpoint, the value will be <code>null</code>'
          nullable: true
        endpoint_html:
          type: string
          description: '<em>URL for collecting the results of the SERP HTML task</em><br>if SERP HTML is not supported in the specified endpoint, the value will be <code>null</code>'
          nullable: true
    SerpGoogleAiModeTasksFixedTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleAiModeTasksFixedResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    SerpGoogleAiModeTasksFixedResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleAiModeTasksFixedTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    AiModeLinkElementInfo:
      type: object
      properties:
        type:
          type: string
          description: type of element
          nullable: true
        title:
          type: string
          description: <em>title of the element</em>
          nullable: true
        description:
          type: string
          description: <em>link description</em>
          nullable: true
        url:
          type: string
          description: <em>search URL with refinement parameters</em>
          nullable: true
        domain:
          type: string
          description: <em>domain in SERP</em>
          nullable: true
    SerpApiAiModeAiOverviewElementItem:
      type: object
      allOf:
        - type: object
          oneOf:
            - $ref: '#/components/schemas/BaseSerpApiAiModeAiOverviewElementItem'
          nullable: true
        - type: object
          properties:
            title:
              type: string
              description: <em>title of the element</em>
              nullable: true
            text:
              type: string
              description: <em>text or description of the element in SERP</em>
              nullable: true
            markdown:
              type: string
              description: <em>content of the element in markdown format</em>
              nullable: true
            links:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AiModeLinkElementInfo'
                nullable: true
              description: '<em>website links featured in the element</em><br>if there are none, equals <code>null</code>'
              nullable: true
            images:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AiModeImagesElementInfo'
                nullable: true
              description: '<em>images of the element</em><br>if there are none, equals <code>null</code>'
              nullable: true
            references:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AiModeAiOverviewReferenceInfo'
                nullable: true
              description: <em>references relevant to the element</em><br>includes references to webpages that were used to generate the <code>ai_overview_element</code>
              nullable: true
    AiModeAiOverviewExpandedComponentInfo:
      type: object
      properties:
        type:
          type: string
          description: type of element
          nullable: true
        title:
          type: string
          description: <em>reference page title</em>
          nullable: true
        text:
          type: string
          description: <em>additional text of the element in SERP</em>
          nullable: true
        markdown:
          type: string
          description: <em>content of the element in markdown format</em>
          nullable: true
        images:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/AiModeImagesElementInfo'
            nullable: true
          description: '<em>images of the component</em><br>if there are none, equals <code>null</code>'
          nullable: true
        links:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/AiModeLinkElementInfo'
            nullable: true
          description: '<em>sitelinks</em><br>the links shown below some of Google''s search results<br>if there are none, equals <code>null</code>'
          nullable: true
        references:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/AiModeAiOverviewReferenceInfo'
            nullable: true
          description: <em>references relevant to the element</em><br>includes references to webpages that were used to generate the <code>ai_overview_element</code>
          nullable: true
    SerpApiAiModeAiOverviewExpandedElementItem:
      type: object
      allOf:
        - type: object
          oneOf:
            - $ref: '#/components/schemas/BaseSerpApiAiModeAiOverviewElementItem'
          nullable: true
        - type: object
          properties:
            title:
              type: string
              description: <em>link anchor text</em>
              nullable: true
            text:
              type: string
              description: <em>reference text</em><br>text snippet from the page that was used to generate the <code>ai_overview_element</code>
              nullable: true
            components:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AiModeAiOverviewExpandedComponentInfo'
                nullable: true
              description: <em>array of components of the element</em>
              nullable: true
            references:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AiModeAiOverviewReferenceInfo'
                nullable: true
              description: <em>additional references relevant to the item</em><br>includes references to webpages that may have been used to generate the <code>ai_overview</code>
              nullable: true
    SerpApiAiModeAiOverviewVideoElementItem:
      type: object
      allOf:
        - type: object
          oneOf:
            - $ref: '#/components/schemas/BaseSerpApiAiModeAiOverviewElementItem'
          nullable: true
        - type: object
          properties:
            title:
              type: string
              description: <em>title of the element in SERP</em>
              nullable: true
            snippet:
              type: string
              description: <em>additional information for the video</em>
              nullable: true
            url:
              type: string
              description: <em>relevant URL</em>
              nullable: true
            domain:
              type: string
              description: <em>domain name of the reference</em>
              nullable: true
            image_url:
              type: string
              description: <em>URL of the image</em><br>the URL leading to the image on the original resource or DataForSEO storage (in case the original source is not available)
              nullable: true
            source:
              type: string
              description: <em>reference source name or title</em>
              nullable: true
            date:
              type: string
              description: '<em>date when the video was published or indexed</em><br>example: <br><code>Apr 26, 2024</code>'
              nullable: true
            timestamp:
              type: string
              description: '<em>date and time when the video was published or indexed</em><br>in the UTC format: "yyyy-mm-dd hh-mm-ss +00:00"<br>example:<br><code class="long-string">2019-11-15 12:57:46 +00:00</code>'
              nullable: true
    AiModeTableInfo:
      type: object
      properties:
        table_header:
          type: array
          items:
            type: string
            nullable: true
          description: <em>content in the header of the table</em>
          nullable: true
        table_content:
          type: array
          items:
            type: array
            items:
              type: string
              nullable: true
            nullable: true
          description: <em>array of contents of the table present in the element</em><br>each array represents the table row
          nullable: true
    SerpApiAiModeAiOverviewTableElementItem:
      type: object
      allOf:
        - type: object
          oneOf:
            - $ref: '#/components/schemas/BaseSerpApiAiModeAiOverviewElementItem'
          nullable: true
        - type: object
          properties:
            markdown:
              type: string
              description: <em>text of the component in the markdwon format</em>
              nullable: true
            table:
              type: object
              oneOf:
                - $ref: '#/components/schemas/AiModeTableInfo'
              description: <em>table present in the element</em><br>the header and content of the table present in the element
              nullable: true
    AiModeAiOverviewShoppingElementInfo:
      type: object
      properties:
        type:
          type: string
          description: type of element
          nullable: true
        product_id:
          type: string
          description: <em>unique product identifier on Google Shopping</em><br>learn more about the parameter in <a href="https://dataforseo.com/help-center/product-id-google-shopping" rel="noopener noreferrer" target="_blank">this help center guide</a>
          nullable: true
        data_docid:
          type: string
          description: <em>unique identifier of the SERP data element</em>
          nullable: true
        gid:
          type: string
          description: <em>global product identifier on Google Shopping</em><br>learn more about the parameter in <a href="https://dataforseo.com/help-center/whats-a-gid-in-google-shopping-api" rel="noopener noreferrer" target="_blank">this help center guide</a>
          nullable: true
        title:
          type: string
          description: <em>reference page title</em>
          nullable: true
        url:
          type: string
          description: <em>URL in link</em>
          nullable: true
        domain:
          type: string
          description: <em>domain in link</em>
          nullable: true
        rating:
          type: object
          oneOf:
            - $ref: '#/components/schemas/RatingInfo'
          description: '<em>product rating </em><br>the popularity rate based on reviews<br> if there is none, the value will be <code>null</code>'
          nullable: true
        price:
          type: object
          oneOf:
            - $ref: '#/components/schemas/PriceInfo'
          description: '<em>product price</em><br>product price details on the seller''s website;<br> if there is none, the value will be <code>null</code>'
          nullable: true
        seller:
          type: string
          description: <em>product seller</em><br>name of the product's seller as displayed in search results
          nullable: true
        snippet:
          type: string
          description: <em>additional information about the result</em>
          nullable: true
        marketplace:
          type: string
          description: <em>merchant account provider</em><br>e-commerce site that hosts products or websites of individual sellers under the same merchant account<br>example:<br><code>by Google</code>
          nullable: true
        marketplace_url:
          type: string
          description: <em>URL to the merchant account provider</em><br>e-commerce site that hosts products or websites of individual sellers under the same merchant account
          nullable: true
        image_url:
          type: string
          description: <em>URL of the image</em><br>the URL leading to the image on the original resource or DataForSEO storage (in case the original source is not available)
          nullable: true
    SerpApiAiModeAiOverviewShoppingItem:
      type: object
      allOf:
        - type: object
          oneOf:
            - $ref: '#/components/schemas/BaseSerpApiAiModeAiOverviewElementItem'
          nullable: true
        - type: object
          properties:
            title:
              type: string
              description: <em>title of the link</em>
              nullable: true
            markdown:
              type: string
              description: <em>content of the element in markdown format</em><br>the text of the <code>ai_overview</code> formatted in the <a href="https://en.wikipedia.org/wiki/Markdown" target="_blank">markdown markup language</a>
              nullable: true
            items:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AiModeAiOverviewShoppingElementInfo'
                nullable: true
              description: <em>items of the element</em>
              nullable: true
    AiModeAiOverviewPaidElementInfo:
      type: object
      properties:
        type:
          type: string
          description: type of element
          nullable: true
        title:
          type: string
          description: <em>title of the element in SERP</em>
          nullable: true
        url:
          type: string
          description: <em>reference page URL</em>
          nullable: true
        domain:
          type: string
          description: <em>domain name of the reference</em>
          nullable: true
        ad_aclk:
          type: string
          description: <em>unique ad click referral parameter</em><br>using this parameter you can get a URL of the advertisement in <a href="https://docs.dataforseo.com/v3/merchant/google/sellers/ad_url/" rel="noopener noreferrer" target="_blank">Google Shopping Sellers Ad URL</a>
          nullable: true
        website_name:
          type: string
          description: <em>displayed name of the advertiser's website</em>
          nullable: true
        breadcrumb:
          type: string
          description: <em>breadcrumb path displayed in the ad</em>
          nullable: true
        snippet:
          type: string
          description: <em>description text of the ad</em>
          nullable: true
        images:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/AiModeImagesElementInfo'
            nullable: true
          description: '<em>images present in the ad</em><br>if there are none, equals <code>null</code>'
          nullable: true
    SerpApiAiModeAiOverviewPaidItem:
      type: object
      allOf:
        - type: object
          oneOf:
            - $ref: '#/components/schemas/BaseSerpApiAiModeAiOverviewElementItem'
          nullable: true
        - type: object
          properties:
            text:
              type: string
              description: <em>introductory text of the element in the response</em><br>text preceding the paid ad items
              nullable: true
            markdown:
              type: string
              description: <em>content of the element in markdown format</em><br>the text of the <code>ai_overview_paid</code> formatted in the <a href="https://en.wikipedia.org/wiki/Markdown" target="_blank">markdown markup language</a>
              nullable: true
            items:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AiModeAiOverviewPaidElementInfo'
                nullable: true
              description: <em>elements of search results found in SERP</em>
              nullable: true
    AiModeAiOverviewInfo:
      type: object
      properties:
        type:
          type: string
          description: type of element
          nullable: true
        rank_group:
          type: integer
          description: <em>group rank in SERP</em><br>position within a group of elements with identical <code>type</code> values<br>positions of elements with different <code>type</code> values are omitted from <code>rank_group</code>
          nullable: true
        rank_absolute:
          type: integer
          description: <em>absolute rank in SERP</em><br>absolute position among all the elements in SERP
          nullable: true
        page:
          type: integer
          description: <em>SERP page</em><br>SERP page on which the element ranks
          nullable: true
        position:
          type: string
          description: '<em>the alignment of the element in SERP</em><br>can take the following values:<br><code>left</code>, <code>right</code>'
          nullable: true
        xpath:
          type: string
          description: <em>the <a href="https://en.wikipedia.org/wiki/XPath" rel="noopener noreferrer" target="_blank">XPath</a> of the element</em>
          nullable: true
        markdown:
          type: string
          description: <em>content of the element in markdown format</em><br>the text of the <code>ai_overview</code> formatted in the <a href="https://en.wikipedia.org/wiki/Markdown" target="_blank">markdown markup language</a>
          nullable: true
        items:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/BaseSerpApiAiModeAiOverviewElementItem'
            nullable: true
          description: <em>items present in the element</em>
          nullable: true
        references:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/AiModeAiOverviewReferenceInfo'
            nullable: true
          description: <em>additional references relevant to the item</em><br>includes references to webpages that may have been used to generate the <code>ai_overview</code>
          nullable: true
        rectangle:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AiModeRectangleInfo'
          description: <em>rectangle parameters</em><br>contains cartesian coordinates and pixel dimensions of the result's snippet in SERP<br>equals <code>null</code> if <code>calculate_rectangles</code> in the POST request is not set to <code>true</code>
          nullable: true
    SerpGoogleAiModeTaskGetAdvancedResultInfo:
      type: object
      properties:
        keyword:
          type: string
          description: <em>keyword received in a POST array<br></em><strong>the keyword is returned with decoded %## (plus symbol '+' will be decoded to a space character)</strong>
          nullable: true
        type:
          type: string
          description: type of element
          nullable: true
        se_domain:
          type: string
          description: <em>search engine domain in a POST array</em>
          nullable: true
        location_code:
          type: integer
          description: <em>location code in a POST array</em>
          nullable: true
        language_code:
          type: string
          description: <em>language code in a POST array</em>
          nullable: true
        check_url:
          type: string
          description: <em>direct URL to search engine results<br></em>you can use it to make sure that we provided exact results
          nullable: true
        datetime:
          type: string
          description: '<em>date and time when the result was received</em><br>in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”<br>example:<br><code class="long-string">2019-11-15 12:57:46 +00:00</code>'
          nullable: true
        spell:
          type: object
          oneOf:
            - $ref: '#/components/schemas/SpellInfo'
          description: '<em>autocorrection of the search engine</em><br>if the search engine provided results for a keyword that was corrected, we will specify the keyword corrected by the search engine and the type of autocorrection;<br>in this case, the value will be <code>null</code>'
          nullable: true
        refinement_chips:
          type: object
          oneOf:
            - $ref: '#/components/schemas/RefinementChipsInfo'
          description: '<em>search refinement chips</em><br>in this case, the value will be <code>null</code>'
          nullable: true
        item_types:
          type: array
          items:
            type: string
            nullable: true
          description: <em>types of search results in SERP</em><br>contains types of search results (<code>items</code>) found in SERP.<br>possible item types:<br><code>ai_overview</code>
          nullable: true
        se_results_count:
          type: integer
          description: <em> total number of results in SERP</em>
          format: int64
          nullable: true
        items_count:
          type: integer
          description: <em>the number of results returned in the <strong><code>items</code></strong> array</em>
          format: int64
          nullable: true
        items:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/AiModeAiOverviewInfo'
            nullable: true
          description: <em>items present in the element</em>
          nullable: true
    SerpGoogleAiModeTaskGetAdvancedTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleAiModeTaskGetAdvancedResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    SerpGoogleAiModeTaskGetAdvancedResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleAiModeTaskGetAdvancedTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    SerpGoogleAiModeTaskGetHtmlResultInfo:
      type: object
      properties:
        keyword:
          type: string
          description: <em>keyword received in a POST array<br></em><strong>keyword is returned with decoded %## (plus symbol '+' will be decoded to a space character)</strong>
          nullable: true
        type:
          type: string
          description: type of element
          nullable: true
        se_domain:
          type: string
          description: <em>search engine domain in a POST array</em>
          nullable: true
        location_code:
          type: integer
          description: <em>location code in a POST array</em>
          nullable: true
        language_code:
          type: string
          description: <em>language code in a POST array</em>
          nullable: true
        datetime:
          type: string
          description: '<em>date and time when the result was received</em><br>in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”<br>example:<br><code class="long-string">2019-11-15 12:57:46 +00:00</code>'
          nullable: true
        items_count:
          type: integer
          description: <em>the number of results returned in the <strong><code>items</code></strong> array</em>
          format: int64
          nullable: true
        items:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/HtmlItemInfo'
            nullable: true
          description: <em>elements of search results found in SERP</em>
          nullable: true
    SerpGoogleAiModeTaskGetHtmlTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleAiModeTaskGetHtmlResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    SerpGoogleAiModeTaskGetHtmlResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleAiModeTaskGetHtmlTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    SerpGoogleAiModeLiveAdvancedRequestInfo:
      type: object
      properties:
        keyword:
          type: string
          description: '<p><em>keyword</em><p><strong>required field</strong><p>you can specify <strong>up to 700 characters</strong> in the <code>keyword</code> field<p>all %## will be decoded (plus character ‘+’ will be decoded to a space character)<p>if you need to use the “%” character for your <code>keyword</code>, please specify it as “%25”;<p>if you need to use the “+” character for your <code>keyword</code>, please specify it as “%2B”</p><br><p>learn more about rules and limitations of <code>keyword</code> and <code>keywords</code> fields in DataForSEO APIs in this <a href="https://dataforseo.com/help-center/rules-and-limitations-of-keyword-and-keywords-fields-in-dataforseo-apis" rel="noopener noreferrer" target="_blank">Help Center article</a></p>'
        location_code:
          type: integer
          description: '<p><em>search engine location code</em><p><strong>required field if you don''t specify</strong> <code>location_name</code>&nbsp;or <code>location_coordinate</code><p><strong>if you use this field, you don''t need to specify <code>location_name</code> or <code>location_coordinate</code></strong><p>you can receive the list of available locations of the search engines with their <code>location_code</code> by making a separate request to the <code>https://api.dataforseo.com/v3/serp/google/locations</code><p><strong>Note:</strong> check <a href="https://support.google.com/websearch/answer/16011537?hl=en&amp;co=GENIE.Platform%3DAndroid#" target="_blank"> Google Search Help</a> for the list of countries where AI Mode is currently available</p>'
        language_code:
          type: string
          description: '<p><em>search engine language code</em><p>required field if you don''t specify <code>language_name</code>;<p>if you use this field, you don''t need to specify <code>language_name</code>;<p>you can receive the list of available languages of the search engine with their <code>language_code</code>&nbsp;by making a separate request to the <code>https://api.dataforseo.com/v3/serp/google/ai_mode/languages</code></p>'
        device:
          type: string
          description: '<p><em>device type</em><p>optional field<p>return results for a specific device type<p>can take the values:<code>desktop</code>, <code>mobile</code><p>default value: <code>desktop</code></p>'
          nullable: true
        location_name:
          type: string
          description: '<p><em>full name of search engine location</em><p><strong>required field if you don''t specify</strong> <code>location_code</code> or <code>location_coordinate</code><p><strong>if you use this field, you don''t need to specify <code>location_code</code> or <code>location_coordinate</code></strong><p>you can receive the list of available locations of the search engine with their <code>location_name</code> by making a separate request to the <code>https://api.dataforseo.com/v3/serp/google/locations</code><p><strong>Note:</strong> check <a href="https://support.google.com/websearch/answer/16011537?hl=en&amp;co=GENIE.Platform%3DAndroid#" target="_blank"> Google Search Help</a> for the list of countries where AI Mode is currently available</p>'
        language_name:
          type: string
          description: '<p><em>full name of search engine language</em><p>required field if you don''t specify <code>language_code</code>;<p>if you use this field, you don''t need to specify <code>language_code</code>;<p>you can receive the list of available languages of the search engine with their <code>language_name</code> by making a separate request to the <code>https://api.dataforseo.com/v3/serp/google/ai_mode/languages</code>;</p>'
        os:
          type: string
          description: '<p><em>device operating system</em><p>optional field<p>if you specify <code>desktop</code> in the <code>device</code> field, choose from the following values: <code>windows</code>, <code>macos</code><p>default value: <code>windows</code><p>if you specify <code>mobile</code> in the <code>device</code> field, choose from the following values: <code>android</code>, <code>ios</code><p>default value: <code>android</code></p>'
          nullable: true
        tag:
          type: string
          description: <p><em>user-defined task identifier</em><p>optional field<p><em>the character limit is 255</em><p>you can use this parameter to identify the task and match it with the result<p>you will find the specified <code>tag</code> value in the <code>data</code> object of the response</p>
          nullable: true
        calculate_rectangles:
          type: boolean
          description: '<p><em>calculate pixel rankings for SERP elements in advanced results</em><p>optional field<p>pixel ranking refers to the distance between the result snippet and top left corner of the screen;<p><a href="https://dataforseo.com/help-center/pixel-ranking-in-serp-api">Visit Help Center to learn more&gt;&gt;</a><p>by default, the parameter is set to <code>false</code><p><strong>Note:</strong> if set to <code>true</code>, the charge per task will be multiplied by 2</p>'
          nullable: true
        browser_screen_width:
          type: integer
          description: '<p><em>browser screen width</em><p>optional field<p>you can set a custom browser screen width to calculate pixel rankings for a particular device;<p>can be specified within the following range: <code>240-9999</code>;<p>by default, the parameter is set to:<p><code>1920</code> for <code>desktop</code>;<p><code>360</code> for <code>mobile</code> on <code>android</code>;<p><code>375</code> for <code>mobile</code> on <code>iOS</code>;<p><strong>Note:</strong> to use this parameter, set <code>calculate_rectangles</code> to <code>true</code></p>'
          format: int64
          nullable: true
        browser_screen_height:
          type: integer
          description: '<p><em>browser screen height</em><p>optional field<p>you can set a custom browser screen height to calculate pixel rankings for a particular device;<p>can be specified within the following range: <code>240-9999</code>;<p>by default, the parameter is set to:<p><code>1080</code> for <code>desktop</code>;<p><code>640</code> for <code>mobile</code> on <code>android</code>;<p><code>812</code> for <code>mobile</code> on <code>iOS</code>;<p><strong>Note:</strong> to use this parameter, set <code>calculate_rectangles</code> to <code>true</code></p>'
          nullable: true
        browser_screen_resolution_ratio:
          type: integer
          description: '<p><em>browser screen resolution ratio</em><p>optional field<p>you can set a custom browser screen resolution ratio to calculate pixel rankings for a particular device;<p>can be specified within the following range: <code>0.5-3</code>;<p>by default, the parameter is set to:<p><code>1</code> for <code>desktop</code>;<p><code>3</code> for <code>mobile</code> on <code>android</code>;<p><code>3</code> for <code>mobile</code> on <code>iOS</code>;<p><strong>Note:</strong> to use this parameter, set <code>calculate_rectangles</code> to <code>true</code></p>'
          nullable: true
        location_coordinate:
          type: string
          description: '<p><em>GPS coordinates of a location</em><p><strong>required field if you don''t specify</strong> <code>location_name</code>&nbsp;or <code>location_code</code><p><strong>if you use this field, you don''t need to specify <code>location_name</code> or <code>location_code</code></strong><p><code>location_coordinate</code> parameter should be specified in the <em>"latitude,longitude,zoom"</em> format<p>if <em>"zoom"</em> is not specified, <em>9z</em> will be applied as a default value<p>the maximum number of decimal digits for <em>"latitude"</em> and <em>"longitude"</em>: 7<p>the minimum value for <em>"zoom"</em>: 4z<p>the maximum value for <em>"zoom"</em>: 18z<p>example:<p><code class="long-string">52.6178549,-155.352142,18z</code></p>'
      example:
        - language_code: en
          location_code: 2840
          keyword: what is google ai mode
    SerpGoogleAiModeLiveAdvancedResultInfo:
      type: object
      properties:
        keyword:
          type: string
          description: <em>keyword received in a POST array<br></em><strong>the keyword is returned with decoded %## (plus symbol '+' will be decoded to a space character)</strong>
          nullable: true
        type:
          type: string
          description: type of element
          nullable: true
        se_domain:
          type: string
          description: <em>search engine domain in a POST array</em>
          nullable: true
        location_code:
          type: integer
          description: <em>location code in a POST array</em>
          nullable: true
        language_code:
          type: string
          description: <em>language code in a POST array</em>
          nullable: true
        check_url:
          type: string
          description: <em>direct URL to search engine results<br></em>you can use it to make sure that we provided exact results
          nullable: true
        datetime:
          type: string
          description: '<em>date and time when the result was received</em><br>in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”<br>example:<br><code class="long-string">2019-11-15 12:57:46 +00:00</code>'
          nullable: true
        spell:
          type: object
          oneOf:
            - $ref: '#/components/schemas/SpellInfo'
          description: '<em>autocorrection of the search engine</em><br>if the search engine provided results for a keyword that was corrected, we will specify the keyword corrected by the search engine and the type of autocorrection;<br>in this case, the value will be <code>null</code>'
          nullable: true
        refinement_chips:
          type: object
          oneOf:
            - $ref: '#/components/schemas/RefinementChipsInfo'
          description: '<em>search refinement chips</em><br>in this case, the value will be <code>null</code>'
          nullable: true
        item_types:
          type: array
          items:
            type: string
            nullable: true
          description: <em>types of search results in SERP</em><br>contains types of search results (<code>items</code>) found in SERP.<br>possible item types:<br><code>ai_overview</code>
          nullable: true
        se_results_count:
          type: integer
          description: <em> total number of results in SERP</em>
          format: int64
          nullable: true
        items_count:
          type: integer
          description: <em>the number of results returned in the <strong><code>items</code></strong> array</em>
          format: int64
          nullable: true
        items:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/AiModeAiOverviewInfo'
            nullable: true
          description: <em>items of the element</em>
          nullable: true
    SerpGoogleAiModeLiveAdvancedTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleAiModeLiveAdvancedResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    SerpGoogleAiModeLiveAdvancedResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleAiModeLiveAdvancedTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    SerpGoogleAiModeLiveHtmlRequestInfo:
      type: object
      properties:
        keyword:
          type: string
          description: '<em>keyword</em><br><strong>required field</strong><br>you can specify <strong>up to 700 characters</strong> in the <code>keyword</code> field<br>all %## will be decoded (plus character ''+'' will be decoded to a space character)<br>if you need to use the "%" character for your <code>keyword</code>, please specify it as "%25";<br>if you need to use the “+” character for your <code>keyword</code>, please specify it as “%2B”;'
        location_name:
          type: string
          description: '<em>full name of search engine location</em><br><strong>required field if you don''t specify</strong> <code>location_code</code> or <code>location_coordinate</code><br><strong>if you use this field, you don''t need to specify <code>location_code</code> or <code>location_coordinate</code></strong><br>you can receive the list of available locations of the search engine with their <code>location_name</code> by making a separate request to the <code>https://api.dataforseo.com/v3/serp/{{low_se_name}}/locations</code><br>example:<br><code class="long-string">London,England,United Kingdom</code>'
        location_code:
          type: integer
          description: '<em>search engine location code</em><br><strong>required field if you don''t specify</strong> <code>location_name</code>_or <code>location_coordinate</code><br><strong>if you use this field, you don''t need to specify <code>location_name</code> or <code>location_coordinate</code></strong><br>you can receive the list of available locations of the search engines with their <code>location_code</code> by making a separate request to the <code>https://api.dataforseo.com/v3/serp/{{low_se_name}}/locations</code><br>example:<br><code class="long-string">2840</code>n'
        location_coordinate:
          type: string
          description: '<em>GPS coordinates of a location</em><br><strong>required field if you don''t specify</strong> <code>location_name</code>_or <code>location_code</code><br><strong>if you use this field, you don''t need to specify <code>location_name</code> or <code>location_code</code></strong><br><code>location_coordinate</code> parameter should be specified in the <em>"latitude,longitude,radius"</em> format<br>the maximum number of decimal digits for <em>"latitude"</em> and <em>"longitude"</em>: 7<br>the minimum value for <em>"radius"</em>: 199.9 (mm)<br>the maximum value for <em>"radius"</em>: 199999 (mm)<br>example:<br><code class="long-string">53.476225,-2.243572,200</code>n'
        language_name:
          type: string
          description: '<em>full name of search engine language</em><br>required field if you don''t specify <code>language_code</code>;<br>if you use this field, you don''t need to specify <code>language_code</code>;<br>you can receive the list of available languages of the search engine with their <code>language_name</code> by making a separate request to the <code>https://api.dataforseo.com/v3/serp/google/ai_mode/languages</code>;'
        language_code:
          type: string
          description: '<em>search engine language code</em><br>required field if you don''t specify <code>language_name</code>;<br>if you use this field, you don''t need to specify <code>language_name</code>;<br>you can receive the list of available languages of the search engine with their <code>language_code</code>_by making a separate request to the <code>https://api.dataforseo.com/v3/serp/google/ai_mode/languages</code>n'
        device:
          type: string
          description: '<em>device type</em><br>optional field<br>return results for a specific device type<br>can take the values:<code>desktop</code>, <code>mobile</code><br>default value: <code>desktop</code>'
          nullable: true
        os:
          type: string
          description: '<em>device operating system</em><br>optional field<br>if you specify <code>desktop</code> in the <code>device</code> field, choose from the following values: <code>windows</code>, <code>macos</code><br>default value: <code>windows</code><br>if you specify <code>mobile</code> in the <code>device</code> field, choose from the following values: <code>android</code>, <code>ios</code><br>default value: <code>android</code>'
          nullable: true
        tag:
          type: string
          description: <em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response
          nullable: true
      example:
        - language_code: en
          location_code: 2840
          keyword: albert einstein
    SerpGoogleAiModeLiveHtmlResultInfo:
      type: object
      properties:
        keyword:
          type: string
          description: <em>keyword received in a POST array<br></em><strong>keyword is returned with decoded %## (plus character '+' will be decoded to a space character)</strong>
          nullable: true
        type:
          type: string
          description: type of element
          nullable: true
        se_domain:
          type: string
          description: <em>search engine domain in a POST array</em>
          nullable: true
        location_code:
          type: integer
          description: <em>location code in a POST array</em>
          nullable: true
        language_code:
          type: string
          description: <em>language code in a POST array</em>
          nullable: true
        datetime:
          type: string
          description: '<em>date and time when the result was received</em><br>in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”<br>example:<br><code class="long-string">2019-11-15 12:57:46 +00:00</code>'
          nullable: true
        items_count:
          type: integer
          description: <em>the number of results returned in the <strong><code>items</code></strong> array</em>
          format: int64
          nullable: true
        items:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/HtmlItemInfo'
            nullable: true
          description: <em>elements of search results found in SERP</em>
          nullable: true
    SerpGoogleAiModeLiveHtmlTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleAiModeLiveHtmlResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    SerpGoogleAiModeLiveHtmlResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleAiModeLiveHtmlTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    SerpGoogleMapsTaskPostRequestInfo:
      type: object
      properties:
        keyword:
          type: string
          description: '<p><em>keyword</em><p><strong>required field</strong><p>you can specify <strong>up to 700 characters </strong> in the <code>keyword</code> field<p>all %## will be decoded (plus character ‘+’ will be decoded to a space character)<p>if you need to use the “%” character for your <code>keyword</code>, please specify it as “%25”;<p>if you need to use the “+” character for your <code>keyword</code>, please specify it as “%2B”;<p>learn more about rules and limitations of <code>keyword</code> and <code>keywords</code> fields in DataForSEO APIs in this <a href="https://dataforseo.com/help-center/rules-and-limitations-of-keyword-and-keywords-fields-in-dataforseo-apis" rel="noopener noreferrer" target="_blank">Help Center article</a></p>'
        location_code:
          type: integer
          description: '<p><em>search engine location code</em><p><strong>required field if you don''t specify</strong> <code>location_name</code>&nbsp;or <code>location_coordinate</code><p><strong>if you use this field, you don''t need to specify <code>location_name</code> or <code>location_coordinate</code></strong><p>you can receive the list of available locations of the search engines with their <code>location_code</code> by making a separate request to the <code>https://api.dataforseo.com/v3/serp/{{low_se_name}}/locations</code><p>example:<p><code class="long-string">2840</code></p>'
        language_code:
          type: string
          description: '<p><em>search engine language code</em><p><strong>required field if you don''t specify</strong> <code>language_name</code><p><strong>if you use this field, you don''t need to specify <code>language_name</code></strong><p>you can receive the list of available languages of the search engine with their <code>language_code</code>&nbsp;by making a separate request to the <code>https://api.dataforseo.com/v3/serp/{{low_se_name}}/languages</code><em><p></em>example:<em><p></em><code class="long-string">en</code></p>'
        depth:
          type: integer
          description: '<p><em>parsing depth</em><p>optional field<p>number of results in SERP<p>default value: <code>100</code><p>max value: <code>700</code></p><br><strong>Your account will be billed per each SERP containing up to 100 results;</strong><p>Setting depth above 100 may result in additional charges <a href="https://dataforseo.com/help-center/how-many-results-scraped" rel="noopener noreferrer" target="_blank">if the search engine returns more than 100 results</a>;<p>The cost can be calculated on the <a title="Pricing" href="https://dataforseo.com/pricing/serp/google-maps-serp-api" target="_blank" rel="noopener noreferrer">Pricing</a> page.'
          nullable: true
        priority:
          type: integer
          description: <p><em>task priority</em><p>optional field<p>can take the following values:<p>1 – normal execution priority (set by default)<p>2 – high execution priority</p><br>You will be additionally charged for the tasks with high execution priority.<p>The cost can be calculated on the <a title="Pricing" href="https://dataforseo.com/pricing/serp/google-maps-serp-api" target="_blank" rel="noopener noreferrer">Pricing</a> page.
          nullable: true
        device:
          type: string
          description: '<p><em>device type</em><p>optional field<p>return results for a specific device type<p>can take the values:<code>desktop</code>, <code>mobile</code><p>default value: <code>desktop</code><p><strong>note:</strong> for <code>mobile</code> device, only 20 results are returned for every SERP</p>'
          nullable: true
        pingback_url:
          type: string
          description: '<p><em>notification URL of a completed task</em><p>optional field<p>when a task is completed we will notify you by GET request sent to the URL you have specified<p>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<p>example:<p><code>http://your-server.com/pingscript?id=$id</code><p><code>http://your-server.com/pingscript?id=$id&amp;tag=$tag</code><p><strong>Note:</strong> special characters in <code>pingback_url</code> will be urlencoded;<p>i.a., the <code>#</code> character will be encoded into <code>%23</code></p><br><p>learn more on our <a href="https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api" target="_blank" rel="noopener noreferrer">Help Center</a></p>'
          nullable: true
        postback_url:
          type: string
          description: '<p><em>URL for sending task results</em><p>optional field<p>once the task is completed, we will send a POST request with its results compressed in the <code>gzip</code> format to the <code>postback_url</code> you specified<p>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<p>example:<p><code>http://your-server.com/postbackscript?id=$id</code><p><code>http://your-server.com/postbackscript?id=$id&amp;tag=$tag</code><p><strong>Note:</strong> special characters in <code>postback_url</code> will be urlencoded;<p>i.a., the <code>#</code> character will be encoded into <code>%23</code></p><br><p>learn more on our <a href="https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api" target="_blank" rel="noopener noreferrer">Help Center</a></p>'
          nullable: true
        postback_data:
          type: string
          description: <p><em>postback_url datatype</em><p><strong>required field if you specify <code>postback_url</code></strong><p>corresponds to the function you used for setting a task<p>possible values:<p><code>advanced</code></p>
        location_name:
          type: string
          description: '<p><em>full name of search engine location</em><p><strong>required field if you don''t specify</strong> <code>location_code</code> or <code>location_coordinate</code><p><strong>if you use this field, you don''t need to specify <code>location_code</code> or <code>location_coordinate</code></strong><p>you can receive the list of available locations of the search engine with their <code>location_name</code> by making a separate request to the <code>https://api.dataforseo.com/v3/serp/{{low_se_name}}/locations</code><p>example:<p><code class="long-string">London,England,United Kingdom</code></p>'
        language_name:
          type: string
          description: '<p><em>full name of search engine language</em><p><strong>required field if you don''t specify</strong> <code>language_code</code><p><strong>if you use this field, you don''t need to specify <code>language_code</code></strong><p>you can receive the list of available languages of the search engine with their <code>language_name</code> by making a separate request to the <code>https://api.dataforseo.com/v3/serp/{{low_se_name}}/languages</code><p>example:<p><code class="long-string">English</code></p>'
        os:
          type: string
          description: '<p><em>device operating system</em><p>optional field<p>if you specify <code>desktop</code> in the <code>device</code> field, choose from the following values: <code>windows</code>, <code>macos</code><p>default value: <code>windows</code><p>if you specify <code>mobile</code> in the <code>device</code> field, choose from the following values: <code>android</code>, <code>ios</code><p>default value: <code>android</code></p>'
          nullable: true
        max_crawl_pages:
          type: integer
          description: '<p><em>page crawl limit</em><p>optional field<p>number of search results pages to crawl<p>max value: <code>100</code><p><strong>Note:</strong> the <code>max_crawl_pages</code> and <code>depth</code> parameters complement each other;<p>learn more at <a href="https://dataforseo.com/help-center/what-is-max-crawl-pages-and-how-does-it-work" target="_blank" rel="noopener noreferrer">our help center</a></p>'
          nullable: true
        url:
          type: string
          description: '<p><em>direct URL of the search query</em><p>optional field<p>you can specify a direct URL and we will sort it out to the necessary fields. Note that this method is the most difficult for our API to process and also requires you to specify the exact language and location in the URL. In most cases, we wouldn’t recommend using this method.<p>example:<p><code class="long-string">https://google.com/maps/search/pizza/@37.09024,-95.712891,4z</code></p><br><strong>Note:</strong> the following search engine parameters are not supported and will be automatically unset if specified in the URL: <code>allinanchor:</code>, <code>allintext:</code>, <code>allintitle:</code>, <code>allinurl:</code>, <code>cache:</code>, <code>define:</code>, <code>definition:</code>, <code>filetype:</code>, <code>id:</code>, <code>inanchor:</code>, <code>info:</code>, <code>intext:</code>, <code>intitle:</code>, <code>inurl:</code>, <code>link:</code>, <code>site:</code>.'
          nullable: true
        location_coordinate:
          type: string
          description: '<p><em>GPS coordinates of a location</em><p><strong>required field if you don''t specify</strong> <code>location_name</code>&nbsp;or <code>location_code</code><p><strong>if you use this field, you don''t need to specify <code>location_name</code> or <code>location_code</code></strong><p><code>location_coordinate</code> parameter should be specified in the <em>"latitude,longitude,zoom"</em> format<p>if <em>"zoom"</em> is not specified, <em>17z</em> will be applied as a default value<p>the maximum number of decimal digits for <em>"latitude"</em> and <em>"longitude"</em>: 7<p>the minimum value for <em>"zoom"</em>: 3z<p>the maximum value for <em>"zoom"</em>: 21z<p>example:<p><code class="long-string">52.6178549,-155.352142,20z</code></p>'
        se_domain:
          type: string
          description: '<p><em>search engine domain</em><p>optional field<p>we choose the relevant search engine domain automatically according to the location and language you specify<p>however, you can set a custom search engine domain in this field<p>example:<p><code>google.co.uk</code></p>'
          nullable: true
        search_this_area:
          type: boolean
          description: '<p><em>show results from the displayed area</em><p>optional field<p>can take the values:<code>true</code>, <code>false</code><p>default value: <code>true</code><p>if set to <code>false</code>, the <code>search_this_area</code> mode will be turned off<p><strong>Note:</strong> if the <code>search_this_area</code> mode is turned off, Google Maps listings might contain results beyond the displayed area</p>'
          nullable: true
        search_places:
          type: boolean
          description: '<p><em>search places mode</em><p>optional field<p>the search places mode allows to obtain Google Maps results on a certain place (e.g., Apple Store in New York)<p>however, due to the pecularities of our data mining algorithm, this mode might interfere with some local-intent queries - and display results for a location that is different from that specified in the request;<p>to prevent this interference and obtain correct results for keywords with local intent you may set this parameter to <code>false</code>;default value: <code>true</code><p><strong>Note:</strong> if the <code>search_places</code> mode is turned off and no results were found in the search area, the <code>results</code> array will be empty</p>'
          nullable: true
        tag:
          type: string
          description: <p><em>user-defined task identifier</em><p>optional field<p><em>the character limit is 255</em><p>you can use this parameter to identify the task and match it with the result<p>you will find the specified <code>tag</code> value in the <code>data</code> object of the response</p>
          nullable: true
      example:
        - language_code: en
          location_code: 2840
          keyword: albert einstein
    SerpGoogleMapsTaskPostTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: object
              description: '<em>array of results</em><br>in this case, the value will be <code>null</code>'
              nullable: true
    SerpGoogleMapsTaskPostResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleMapsTaskPostTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    SerpGoogleMapsTasksReadyResultInfo:
      type: object
      properties:
        id:
          type: string
          description: <em>task identifier of the completed task</em><br><strong>unique task identifier in our system in the <a href="https://en.wikipedia.org/wiki/Universally_unique_identifier">UUID</a> format</strong>
          nullable: true
        se:
          type: string
          description: <em>search engine specified when setting the task</em>
          nullable: true
        se_type:
          type: string
          description: '<em>type of search engine</em><br>example: <code>{{low_se_type_under}}</code>'
          nullable: true
        date_posted:
          type: string
          description: <em>date when the task was posted (in the UTC format)</em>
          nullable: true
        tag:
          type: string
          description: <em>user-defined task identifier</em>
          nullable: true
        endpoint_regular:
          type: string
          description: '<em>URL for collecting the results of the SERP Regular task</em><br>if SERP Regular is not supported in the specified endpoint, the value will be <code>null</code>'
          nullable: true
        endpoint_advanced:
          type: string
          description: '<em>URL for collecting the results of the SERP Advanced task</em><br>if SERP Advanced is not supported in the specified endpoint, the value will be <code>null</code>'
          nullable: true
        endpoint_html:
          type: string
          description: '<em>URL for collecting the results of the SERP HTML task</em><br>if SERP HTML is not supported in the specified endpoint, the value will be <code>null</code>'
          nullable: true
    SerpGoogleMapsTasksReadyTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleMapsTasksReadyResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    SerpGoogleMapsTasksReadyResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleMapsTasksReadyTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    SerpGoogleMapsTasksFixedResultInfo:
      type: object
      properties:
        id:
          type: string
          description: <em>task identifier of the completed task</em><br><strong>unique task identifier in our system in the <a href="https://en.wikipedia.org/wiki/Universally_unique_identifier">UUID</a> format</strong>
          nullable: true
        se:
          type: string
          description: <em>search engine specified when setting the task</em>
          nullable: true
        se_type:
          type: string
          description: '<em>type of search engine</em><br>can take the following values: <code>{{low_se_type_under}}</code>'
          nullable: true
        date_posted:
          type: string
          nullable: true
        tag:
          type: string
          description: <em>user-defined task identifier</em>
          nullable: true
        endpoint_regular:
          type: string
          description: '<em>URL for collecting the results of the SERP Regular task</em><br>if SERP Regular is not supported in the specified endpoint, the value will be <code>null</code>'
          nullable: true
        endpoint_advanced:
          type: string
          description: '<em>URL for collecting the results of the SERP Advanced task</em><br>if SERP Advanced is not supported in the specified endpoint, the value will be <code>null</code>'
          nullable: true
        endpoint_html:
          type: string
          description: '<em>URL for collecting the results of the SERP HTML task</em><br>if SERP HTML is not supported in the specified endpoint, the value will be <code>null</code>'
          nullable: true
    SerpGoogleMapsTasksFixedTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleMapsTasksFixedResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    SerpGoogleMapsTasksFixedResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleMapsTasksFixedTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    AddressInfo:
      type: object
      properties:
        borough:
          type: string
          description: <em>administrative unit or district the local establishment belongs to</em>
          nullable: true
        address:
          type: string
          description: <em>street address of the local establishment</em>
          nullable: true
        city:
          type: string
          description: <em>name of the city where the local establishment is located</em>
          nullable: true
        zip:
          type: string
          description: <em>ZIP code of the local establishment</em>
          nullable: true
        region:
          type: string
          description: <em>DMA region the local establishment belongs to</em>
          nullable: true
        country_code:
          type: string
          description: <em>ISO country code of the local establishment</em>
          nullable: true
    WorkHours:
      type: object
      properties:
        timetable:
          type: object
          additionalProperties:
            type: array
            items:
              type: object
              oneOf:
                - $ref: '#/components/schemas/WorkDayInfo'
              description: work hours on Sundays
              nullable: true
            nullable: true
          description: <em>work hours timetable</em>
          nullable: true
        current_status:
          type: string
          description: <em>current status of the establishment</em><br>indicates whether the establishment is opened or closed
          nullable: true
    LocalJustificationInfo:
      type: object
      properties:
        type:
          type: string
          description: type of element
          nullable: true
        text:
          type: string
          description: <em>text snippet of local justification</em>
          nullable: true
    SerpApiMapsSearchElementItem:
      type: object
      allOf:
        - type: object
          oneOf:
            - $ref: '#/components/schemas/BaseSerpApiGoogleMapsElementItem'
          nullable: true
        - type: object
          properties:
            original_title:
              type: string
              description: <em>original title of the element</em><br>original title not translated by Google
              nullable: true
            contact_url:
              type: string
              description: <em>URL of the preferred contact page</em>
              nullable: true
            contributor_url:
              type: string
              description: '<em>URL of the user''s or entity''s Local Guides profile, if available</em>'
              nullable: true
            book_online_url:
              type: string
              description: <em>URL in the 'book online' button of the element</em><br>URL directing users to the online booking or order page of the business entity
              nullable: true
            hotel_rating:
              type: number
              description: '<em>hotel class rating</em><br>class ratings range between 1-5 stars, <a href="https://support.google.com/business/answer/7660515?hl=en" rel="noopener noreferrer" target="_blank">learn more</a><br>if there is no hotel class rating information, the value will be <code>null</code>'
              nullable: true
            price_level:
              type: string
              description: '<em>property price level</em><br>can take values: <code>inexpensive</code>, <code>moderate</code>, <code>expensive</code>, <code>very_expensive</code><br>if there is no price level information, the value will be <code>null</code>'
              nullable: true
            snippet:
              type: string
              description: <em>element snippet</em><br>contains the address and other information about the local establishment featured in the element
              nullable: true
            address:
              type: string
              description: <em>address line</em><br>address of the local establishment featured in the element
              nullable: true
            address_info:
              type: object
              oneOf:
                - $ref: '#/components/schemas/AddressInfo'
              description: <em>object containing address components of the local establishment</em>
              nullable: true
            place_id:
              type: string
              description: <em>unique place identifier</em><br><a href="https://developers.google.com/places/place-id">place id</a> of the local establishment featured in the element
              nullable: true
            phone:
              type: string
              description: <em>phone number</em><br>phone number of the local establishment featured in the element
              nullable: true
            main_image:
              type: string
              description: <em>URL of the main image featured in Google My Business profile</em>
              nullable: true
            total_photos:
              type: integer
              description: <em>total count of images featured in Google My Business profile</em>
              format: int64
              nullable: true
            category:
              type: string
              description: <em>business category</em><br>Google My Business general category that best describes the services provided by the business entity
              nullable: true
            additional_categories:
              type: array
              items:
                type: string
                nullable: true
              description: <em>additional business categories</em><br>additional Google My Business categories that describe the services provided by the business entity in more detail
              nullable: true
            category_ids:
              type: array
              items:
                type: string
                nullable: true
              description: <em>global category IDs</em><br>universal category IDs that do not change based on the selected country
              nullable: true
            work_hours:
              type: object
              oneOf:
                - $ref: '#/components/schemas/WorkHours'
              description: <em>open hours</em><br>information about work hours of the local establishment
              nullable: true
            feature_id:
              type: string
              description: <em>the unique identifier of the element in SERP</em>
              nullable: true
            cid:
              type: string
              description: <i>google-defined client id</i><br>unique id of a local establishment;<br>can be used with <a href="/v3/reviews/google/overview/?php" rel="noopener noreferrer" target="_blank">Google Reviews API</a> to get a full list of reviews
              nullable: true
            latitude:
              type: number
              description: '<i>latitude coordinate of the local establishments in google maps</i><br>example:<br><code>"latitude": 51.584091</code>'
              nullable: true
            longitude:
              type: number
              description: '<i>longitude coordinate of the local establishment in google maps</i><br>example:<br><code>"longitude": -0.31365919999999997</code>'
              nullable: true
            is_claimed:
              type: boolean
              description: <i>indicates whether ownership of this local establishment is claimed</i>
              nullable: true
            local_justifications:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/LocalJustificationInfo'
                nullable: true
              description: <i>Google local justifications</i><br>snippets of text that "justify" why the business is showing up for search query
              nullable: true
            is_directory_item:
              type: boolean
              description: <i>indicates whether this local establishment is a directory </i>
              nullable: true
    SerpApiMapsPaidItemElementItem:
      type: object
      allOf:
        - type: object
          oneOf:
            - $ref: '#/components/schemas/BaseSerpApiGoogleMapsElementItem'
          nullable: true
        - type: object
    SerpGoogleMapsTaskGetAdvancedResultInfo:
      type: object
      properties:
        keyword:
          type: string
          description: <em>keyword received in a POST array<br></em><strong>the keyword is returned with decoded %## (plus symbol '+' will be decoded to a space character)</strong>
          nullable: true
        type:
          type: string
          description: type of element
          nullable: true
        se_domain:
          type: string
          description: <em>search engine domain in a POST array</em>
          nullable: true
        location_code:
          type: integer
          description: <em>location code in a POST array</em>
          nullable: true
        language_code:
          type: string
          description: <em>language code in a POST array</em>
          nullable: true
        check_url:
          type: string
          description: '<em>direct URL to search engine results<br></em>you can use it to make sure that we provided exact results<br><strong>Note:</strong> to check location-specific results, follow the provided check url, scroll up and down, then click the <em>"Search this area"</em> button'
          nullable: true
        datetime:
          type: string
          description: '<em>date and time when the result was received</em><br>in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”<br>example:<br><code class="long-string">2019-11-15 12:57:46 +00:00</code>'
          nullable: true
        spell:
          type: object
          oneOf:
            - $ref: '#/components/schemas/SpellInfo'
          description: '<em>autocorrection of the search engine</em><br>if the search engine provided results for a keyword that was corrected, we will specify the keyword corrected by the search engine and the type of autocorrection'
          nullable: true
        refinement_chips:
          type: object
          oneOf:
            - $ref: '#/components/schemas/RefinementChipsInfo'
          description: <em>search refinement chips</em>
          nullable: true
        item_types:
          type: array
          items:
            type: string
            nullable: true
          description: '<em>types of search results in SERP</em><br>contains types of search results (<code>items</code>) found in SERP.<br>possible item types:<br><code>maps_search</code>, <code>maps_paid_item</code>'
          nullable: true
        se_results_count:
          type: integer
          description: <em> total number of results in SERP</em>
          format: int64
          nullable: true
        items_count:
          type: integer
          description: <em>the number of results returned in the <strong><code>items</code></strong> array</em>
          format: int64
          nullable: true
        items:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/BaseSerpApiGoogleMapsElementItem'
            nullable: true
          description: <em>items of the element</em>
          nullable: true
    SerpGoogleMapsTaskGetAdvancedTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleMapsTaskGetAdvancedResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    SerpGoogleMapsTaskGetAdvancedResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleMapsTaskGetAdvancedTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    SerpGoogleMapsLiveAdvancedRequestInfo:
      type: object
      properties:
        keyword:
          type: string
          description: '<p><em>keyword</em><p><strong>required field</strong><p>you can specify <strong>up to 700 characters</strong> in the <code>keyword</code> field<p>all %## will be decoded (plus character ''+'' will be decoded to a space character)<p>if you need to use the "%" character for your <code>keyword</code>, please specify it as "%25";<p>if you need to use the “+” character for your <code>keyword</code>, please specify it as “%2B”;<p>learn more about rules and limitations of <code>keyword</code> and <code>keywords</code> fields in DataForSEO APIs in this <a href="https://dataforseo.com/help-center/rules-and-limitations-of-keyword-and-keywords-fields-in-dataforseo-apis" rel="noopener noreferrer" target="_blank">Help Center article</a></p>'
        location_code:
          type: integer
          description: '<p><em>search engine location code</em><p><strong>required field if you don''t specify</strong> <code>location_name</code>&nbsp;or <code>location_coordinate</code><p><strong>if you use this field, you don''t need to specify <code>location_name</code> or <code>location_coordinate</code></strong><p>you can receive the list of available locations of the search engines with their <code>location_code</code> by making a separate request to the <code>https://api.dataforseo.com/v3/serp/google/locations</code><p>example:<p><code class="long-string">2840</code></p>'
        language_code:
          type: string
          description: '<p><em>search engine language code</em><p><strong>required field if you don''t specify</strong> <code>language_name</code><p><strong>if you use this field, you don''t need to specify <code>language_name</code></strong><p>you can receive the list of available languages of the search engine with their <code>language_code</code>&nbsp;by making a separate request to the <code>https://api.dataforseo.com/v3/serp/google/languages</code><em><p></em>example:<em><p></em><code class="long-string">en</code></p>'
        depth:
          type: integer
          description: '<p><em>parsing depth</em><p>optional field<p>number of results in SERP<p>default value: <code>100</code><p>max value: <code>700</code></p><br><strong>Your account will be billed per each SERP containing up to 100 results;</strong><p>Setting depth above 100 may result in additional charges <a href="https://dataforseo.com/help-center/how-many-results-scraped" rel="noopener noreferrer" target="_blank">if the search engine returns more than 100 results</a>;<p>The cost can be calculated on the <a title="Pricing" href="https://dataforseo.com/pricing/serp/google-maps-serp-api" target="_blank" rel="noopener noreferrer">Pricing</a> page.'
          nullable: true
        device:
          type: string
          description: '<p><em>device type</em><p>optional field<p>return results for a specific device type<p>can take the values:<code>desktop</code>, <code>mobile</code><p>default value: <code>desktop</code><p><strong>note:</strong> for <code>mobile</code> device, only 20 results are returned for every SERP</p>'
          nullable: true
        location_name:
          type: string
          description: '<p><em>full name of search engine location</em><p><strong>required field if you don''t specify</strong> <code>location_code</code> or <code>location_coordinate</code><p><strong>if you use this field, you don''t need to specify <code>location_code</code> or <code>location_coordinate</code></strong><p>you can receive the list of available locations of the search engine with their <code>location_name</code> by making a separate request to the <code>https://api.dataforseo.com/v3/serp/google/locations</code><p>example:<p><code class="long-string">London,England,United Kingdom</code></p>'
        language_name:
          type: string
          description: '<p><em>full name of search engine language</em><p><strong>required field if you don''t specify</strong> <code>language_code</code><p><strong>if you use this field, you don''t need to specify <code>language_code</code></strong><p>you can receive the list of available languages  of the search engine with their <code>language_name</code> by making a separate request to the <code>https://api.dataforseo.com/v3/serp/google/languages</code><p>example:<p><code class="long-string">English</code></p>'
        os:
          type: string
          description: '<p><em>device operating system</em><p>optional field<p>if you specify <code>desktop</code> in the <code>device</code> field, choose from the following values: <code>windows</code>, <code>macos</code><p>default value: <code>windows</code><p>if you specify <code>mobile</code> in the <code>device</code> field, choose from the following values: <code>android</code>, <code>ios</code><p>default value: <code>android</code></p>'
          nullable: true
        tag:
          type: string
          description: <p><em>user-defined task identifier</em><p>optional field<p><em>the character limit is 255</em><p>you can use this parameter to identify the task and match it with the result<p>you will find the specified <code>tag</code> value in the <code>data</code> object of the response</p>
          nullable: true
        max_crawl_pages:
          type: integer
          description: '<p><em>page crawl limit</em><p>optional field<p>number of search results pages to crawl<p>max value: <code>100</code><p><strong>Note:</strong> the <code>max_crawl_pages</code> and <code>depth</code> parameters complement each other;<p>learn more at <a href="https://dataforseo.com/help-center/what-is-max-crawl-pages-and-how-does-it-work" rel="noopener noreferrer" target="_blank">our help center</a></p>'
          nullable: true
        url:
          type: string
          description: '<p><em>direct URL of the search query</em><p>optional field<p>you can specify a direct URL and we will sort it out to the necessary fields. Note that this method is the most difficult for our API to process and also requires you to specify the exact language and location in the URL. In most cases, we wouldn’t recommend using this method.<p>example:<p><code class="long-string">https://google.com/maps/search/pizza/@37.09024,-95.712891,4z</code></p><br><strong>Note:</strong> the following search engine parameters are not supported and will be automatically unset if specified in the URL: <code>allinanchor:</code>, <code>allintext:</code>, <code>allintitle:</code>, <code>allinurl:</code>, <code>cache:</code>, <code>define:</code>, <code>definition:</code>, <code>filetype:</code>, <code>id:</code>, <code>inanchor:</code>, <code>info:</code>, <code>intext:</code>, <code>intitle:</code>, <code>inurl:</code>, <code>link:</code>, <code>site:</code>.'
          nullable: true
        location_coordinate:
          type: string
          description: '<p><em>GPS coordinates of a location</em><p><strong>required field if you don''t specify</strong> <code>location_name</code>&nbsp;or <code>location_code</code><p><strong>if you use this field, you don''t need to specify <code>location_name</code> or <code>location_code</code></strong><p><code>location_coordinate</code> parameter should be specified in the <em>"latitude,longitude,zoom"</em> format<p>if <em>"zoom"</em> is not specified, <em>17z</em> will be applied as a default value<p>the maximum number of decimal digits for <em>"latitude"</em> and <em>"longitude"</em>: 7<p>the minimum value for <em>"zoom"</em>: 3z<p>the maximum value for <em>"zoom"</em>: 21z<p>example:<p><code class="long-string">52.6178549,-155.352142,20z</code></p>'
        se_domain:
          type: string
          description: '<p><em>search engine domain</em><p>optional field<p>we choose the relevant search engine domain automatically according to the location and language you specify<p>however, you can set a custom search engine domain in this field<p>example:<p><code><em>google.co.uk</em></code>, <code><em>google.com.au</em></code>, <code><em>google.de</em></code>, etc.</p>'
          nullable: true
        search_this_area:
          type: boolean
          description: '<p><em>show results from the displayed area</em><p>optional field<p>can take the values:<code>true</code>, <code>false</code><p>default value: <code>true</code></p><br><p>if set to <code>false</code>, the <code>search_this_area</code> mode will be turned off</p><br><p><strong>Note:</strong> if the <code>search_this_area</code> mode is turned off, Google Maps listings might contain results beyond the displayed area</p>'
          nullable: true
        search_places:
          type: boolean
          description: '<p><em>search places mode</em><p>optional field<p>the search places mode allows to obtain Google Maps results on a certain place (e.g., Apple Store in New York)<p>however, due to the pecularities of our data mining algorithm, this mode might interfere with some local-intent queries - and display results for a location that is different from that specified in the request;<p>to prevent this interference and obtain correct results for keywords with local intent you may set this parameter to <code>false</code>;</p><br><p>default value: <code>true</code><p><strong>Note:</strong> if the <code>search_places</code> mode is turned off and no results were found in the search area, the <code>results</code> array will be empty</p>'
          nullable: true
      example:
        - language_code: en
          location_code: 2840
          keyword: albert einstein
    SerpGoogleMapsLiveAdvancedResultInfo:
      type: object
      properties:
        keyword:
          type: string
          description: <em>keyword received in a POST array<br></em><strong>the keyword is returned with decoded %## (plus character '+' will be decoded to a space character)</strong>
          nullable: true
        type:
          type: string
          description: type of element
          nullable: true
        se_domain:
          type: string
          description: <em>search engine domain in a POST array<br></em>
          nullable: true
        location_code:
          type: integer
          description: <em>location code in a POST array</em>
          nullable: true
        language_code:
          type: string
          description: <em>language code in a POST array</em>
          nullable: true
        check_url:
          type: string
          description: '<em>direct URL to search engine results<br></em>you can use it to make sure that we provided exact results<br><strong>Note:</strong> to check location-specific results, follow the provided check url, scroll up and down, then click the <em>"Search this area"</em> button'
          nullable: true
        datetime:
          type: string
          description: '<em>date and time when the result was received</em><br>in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”<br>example:<br><code class="long-string">2019-11-15 12:57:46 +00:00</code>'
          nullable: true
        spell:
          type: object
          oneOf:
            - $ref: '#/components/schemas/SpellInfo'
          description: '<em>autocorrection of the search engine</em><br>if the search engine provided results for a keyword that was corrected, we will specify the keyword corrected by the search engine and the type of autocorrection'
          nullable: true
        refinement_chips:
          type: object
          oneOf:
            - $ref: '#/components/schemas/RefinementChipsInfo'
          description: <em>search refinement chips</em>
          nullable: true
        item_types:
          type: array
          items:
            type: string
            nullable: true
          description: '<em>types of search results in SERP</em><br>contains types of search results (<code>items</code>) found in SERP.<br>possible item types:<br><code>maps_search</code>, <code>maps_paid_item</code>'
          nullable: true
        se_results_count:
          type: integer
          description: <em> total number of results in SERP</em>
          format: int64
          nullable: true
        items_count:
          type: integer
          description: <em>the number of results returned in the <strong><code>items</code></strong> array</em>
          format: int64
          nullable: true
        items:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/BaseSerpApiGoogleMapsElementItem'
            nullable: true
          description: <em>items of the element</em>
          nullable: true
    SerpGoogleMapsLiveAdvancedTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleMapsLiveAdvancedResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    SerpGoogleMapsLiveAdvancedResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleMapsLiveAdvancedTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    SerpGoogleLocalFinderTaskPostRequestInfo:
      type: object
      properties:
        keyword:
          type: string
          description: '<p><em>keyword</em><p><strong>required field</strong><p>you can specify <strong>up to 700 characters</strong> in the <code>keyword</code> field<p>all %## will be decoded (plus character ‘+’ will be decoded to a space character)<p>if you need to use the “%” character for your <code>keyword</code>, please specify it as “%25”;<p>if you need to use the “+” character for your <code>keyword</code>, please specify it as “%2B”</p><br><p>learn more about rules and limitations of <code>keyword</code> and <code>keywords</code> fields in DataForSEO APIs in this <a href="https://dataforseo.com/help-center/rules-and-limitations-of-keyword-and-keywords-fields-in-dataforseo-apis" rel="noopener noreferrer" target="_blank">Help Center article</a></p>'
        location_code:
          type: integer
          description: '<p><em>search engine location code</em><p><strong>required field if you don''t specify</strong> <code>location_name</code>&nbsp;or <code>location_coordinate</code><p><strong>if you use this field, you don''t need to specify <code>location_name</code> or <code>location_coordinate</code></strong><p>you can receive the list of available locations of the search engines with their <code>location_code</code> by making a separate request to the <code>https://api.dataforseo.com/v3/serp/{{low_se_name}}/locations</code><p>example:<p><code class="long-string">2840</code></p>'
        language_code:
          type: string
          description: '<p><em>search engine language code</em><p><strong>required field if you don''t specify</strong> <code>language_name</code><p><strong>if you use this field, you don''t need to specify <code>language_name</code></strong><p>you can receive the list of available languages of the search engine with their <code>language_code</code>&nbsp;by making a separate request to the <code>https://api.dataforseo.com/v3/serp/{{low_se_name}}/languages</code><p>example:<code class="long-string">en</code></p>'
        depth:
          type: integer
          description: '<p><em>parsing depth</em><p>optional field<p>number of results in SERP<p>default value: <code>10</code><p>max value: <code>350</code><br><strong>your account will be billed per each SERP containing up to 10 results;</strong><br>setting depth above 10 may result in additional charges if the search engine returns more than 10 results respectively;<br><p>If the specified depth is higher than the number of results in the response, the difference will be refunded to your account balance automatically<br>The cost can be calculated on the <a title="Pricing" href="https://dataforseo.com/pricing/serp/google-local-finder-serp-api" target="_blank" rel="noopener noreferrer">Pricing</a> page.'
          nullable: true
        priority:
          type: integer
          description: <p><em>task priority</em><p>optional field<p>can take the following values:<p>1 – normal execution priority (set by default)<p>2 – high execution priority</p><br>You will be additionally charged for the tasks with high execution priority.<p>The cost can be calculated on the <a title="Pricing" href="https://dataforseo.com/pricing/serp/google-local-finder-serp-api" target="_blank" rel="noopener noreferrer">Pricing</a> page.
          nullable: true
        device:
          type: string
          description: '<p><em>device type</em><p>optional field<p>return results for a specific device type<p>can take the values:<code>desktop</code>, <code>mobile</code><p>default value: <code>desktop</code></p>'
          nullable: true
        pingback_url:
          type: string
          description: '<p><em>notification URL of a completed task</em><p>optional field<p>when a task is completed we will notify you by GET request sent to the URL you have specified<p>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<p>example:<p><code>http://your-server.com/pingscript?id=$id</code><p><code>http://your-server.com/pingscript?id=$id&amp;tag=$tag</code><p><strong>Note:</strong> special characters in <code>pingback_url</code> will be urlencoded;<p>i.a., the <code>#</code> character will be encoded into <code>%23</code></p><br><p>learn more on our <a href="https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api" target="_blank" rel="noopener noreferrer">Help Center</a></p>'
          nullable: true
        postback_url:
          type: string
          description: '<p><em>URL for sending task results</em><p>optional field<p>once the task is completed, we will send a POST request with its results compressed in the <code>gzip</code> format to the <code>postback_url</code> you specified<p>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<p>example:<p><code>http://your-server.com/postbackscript?id=$id</code><p><code>http://your-server.com/postbackscript?id=$id&amp;tag=$tag</code><p><strong>Note:</strong> special characters in <code>postback_url</code> will be urlencoded;<p>i.a., the <code>#</code> character will be encoded into <code>%23</code></p><br><p>learn more on our <a href="https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api" target="_blank" rel="noopener noreferrer">Help Center</a></p>'
          nullable: true
        postback_data:
          type: string
          description: '<p><em>postback_url datatype</em><p><strong>required field if you specify <code>postback_url</code></strong><p>corresponds to the function you used for setting a task<p>possible values:<p><code>advanced</code>, <code>html</code></p>'
        location_name:
          type: string
          description: '<p><em>full name of search engine location</em><p><strong>required field if you don''t specify</strong> <code>location_code</code> or <code>location_coordinate</code><p><strong>if you use this field, you don''t need to specify <code>location_code</code> or <code>location_coordinate</code></strong><p>you can receive the list of available locations of the search engine with their <code>location_name</code> by making a separate request to the <code>https://api.dataforseo.com/v3/serp/{{low_se_name}}/locations</code><p>example:<p><code class="long-string">London,England,United Kingdom</code></p>'
        language_name:
          type: string
          description: '<p><em>full name of search engine language</em><p><strong>required field if you don''t specify</strong> <code>language_code</code><p><strong>if you use this field, you don''t need to specify <code>language_code</code></strong><p>you can receive the list of available languages of the search engine with their <code>language_name</code> by making a separate request to the <code>https://api.dataforseo.com/v3/serp/{{low_se_name}}/languages</code><p>example:<p><code class="long-string">English</code></p>'
        os:
          type: string
          description: '<p><em>device operating system</em><p>optional field<p>if you specify <code>desktop</code> in the <code>device</code> field, choose from the following values: <code>windows</code>, <code>macos</code><p>default value: <code>windows</code><p>if you specify <code>mobile</code> in the <code>device</code> field, choose from the following values: <code>android</code>, <code>ios</code><p>default value: <code>android</code></p>'
          nullable: true
        tag:
          type: string
          description: <p><em>user-defined task identifier</em><p>optional field<p><em>the character limit is 255</em><p>you can use this parameter to identify the task and match it with the result<p>you will find the specified <code>tag</code> value in the <code>data</code> object of the response</p>
          nullable: true
        location_coordinate:
          type: string
          description: '<p><em>GPS coordinates of a location</em><p><strong>required field if you don''t specify</strong> <code>location_name</code>&nbsp;or <code>location_code</code><p><strong>if you use this field, you don''t need to specify <code>location_name</code> or <code>location_code</code></strong><p><code>location_coordinate</code> parameter should be specified in the <em>"latitude,longitude,zoom"</em> format<p>if <em>"zoom"</em> is not specified, <em>9z</em> will be applied as a default value<p>the maximum number of decimal digits for <em>"latitude"</em> and <em>"longitude"</em>: 7<p>the minimum value for <em>"zoom"</em>: 4z<p>the maximum value for <em>"zoom"</em>: 18z<p>example:<p><code class="long-string">52.6178549,-155.352142,18z</code></p>'
        min_rating:
          type: number
          description: '<p><em>filter results by minimum rating</em><p>optional field<p>possible values for <code>desktop</code>: <code>3.5</code>, <code>4</code>, <code>4.5</code>;<p>possible values for <code>mobile</code>: <code>2</code>, <code>2.5</code>, <code>3</code>, <code>3.5</code>, <code>4</code>, <code>4.5</code></p>'
          format: double
          nullable: true
        time_filter:
          type: string
          description: '<p><em>filter results by open hours</em><p>optional field<p>using this field, you can filter places in the results by the time a place is open for visitors<p>note that Google may also provide results that do not match this filter<p>possible values: <code>"open_now"</code>, <code>"24_hours"</code>, <code>"$day_value"</code>, <code>"$day_value;$time_value"</code>;<p>instead of <code>$day_value</code> use one of these values: <code>"monday"</code>, <code>"tuesday"</code>, <code>"wednesday"</code>, <code>"thursday"</code>, <code>"friday"</code>, <code>"saturday"</code>, <code>"sunday"</code>;<p>instead of <code>$time_value</code> use one of these values: <code>"00"</code>, <code>"01"</code>, <code>"02"</code>, <code>"03"</code>, <code>"04"</code>, <code>"05"</code>, <code>"06"</code>, <code>"07"</code>, <code>"08"</code>, <code>"09"</code>, <code>"10"</code>, <code>"11"</code>, <code>"12"</code>, <code>"13"</code>, <code>"14"</code>, <code>"15"</code>, <code>"16"</code>, <code>"17"</code>, <code>"18"</code>, <code>"19"</code>, <code>"20"</code>, <code>"21"</code>, <code>"22"</code>, <code>"23"</code><p>example: <code class="long-string">"tuesday;18"</code></p>'
          nullable: true
      example:
        - language_code: en
          location_code: 2840
          keyword: local nail services
          min_rating: 4.5
          time_filter: monday
    SerpGoogleLocalFinderTaskPostTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: object
              description: '<em>array of results</em><br>in this case, the value will be <code>null</code>'
              nullable: true
    SerpGoogleLocalFinderTaskPostResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleLocalFinderTaskPostTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    SerpGoogleLocalFinderTasksReadyResultInfo:
      type: object
      properties:
        id:
          type: string
          description: <em>task identifier of the completed task</em><br><strong>unique task identifier in our system in the <a href="https://en.wikipedia.org/wiki/Universally_unique_identifier">UUID</a> format</strong>
          nullable: true
        se:
          type: string
          description: <em>search engine specified when setting the task</em>
          nullable: true
        se_type:
          type: string
          description: '<em>type of search engine</em><br>example: <code>{{low_se_type_under}}</code>'
          nullable: true
        date_posted:
          type: string
          description: <em>date when the task was posted (in the UTC format)</em>
          nullable: true
        tag:
          type: string
          description: <em>user-defined task identifier</em>
          nullable: true
        endpoint_regular:
          type: string
          description: '<em>URL for collecting the results of the SERP Regular task</em><br>if SERP Regular is not supported in the specified endpoint, the value will be <code>null</code>'
          nullable: true
        endpoint_advanced:
          type: string
          description: '<em>URL for collecting the results of the SERP Advanced task</em><br>if SERP Advanced is not supported in the specified endpoint, the value will be <code>null</code>'
          nullable: true
        endpoint_html:
          type: string
          description: '<em>URL for collecting the results of the SERP HTML task</em><br>if SERP HTML is not supported in the specified endpoint, the value will be <code>null</code>'
          nullable: true
    SerpGoogleLocalFinderTasksReadyTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleLocalFinderTasksReadyResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    SerpGoogleLocalFinderTasksReadyResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleLocalFinderTasksReadyTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    SerpGoogleLocalFinderTasksFixedResultInfo:
      type: object
      properties:
        id:
          type: string
          description: <em>task identifier of the completed task</em><br><strong>unique task identifier in our system in the <a href="https://en.wikipedia.org/wiki/Universally_unique_identifier">UUID</a> format</strong>
          nullable: true
        se:
          type: string
          description: <em>search engine specified when setting the task</em>
          nullable: true
        se_type:
          type: string
          description: '<em>type of search engine</em><br>can take the following values: <code>{{low_se_type_under}}</code>'
          nullable: true
        date_posted:
          type: string
          nullable: true
        tag:
          type: string
          description: <em>user-defined task identifier</em>
          nullable: true
        endpoint_regular:
          type: string
          description: '<em>URL for collecting the results of the SERP Regular task</em><br>if SERP Regular is not supported in the specified endpoint, the value will be <code>null</code>'
          nullable: true
        endpoint_advanced:
          type: string
          description: '<em>URL for collecting the results of the SERP Advanced task</em><br>if SERP Advanced is not supported in the specified endpoint, the value will be <code>null</code>'
          nullable: true
        endpoint_html:
          type: string
          description: '<em>URL for collecting the results of the SERP HTML task</em><br>if SERP HTML is not supported in the specified endpoint, the value will be <code>null</code>'
          nullable: true
    SerpGoogleLocalFinderTasksFixedTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleLocalFinderTasksFixedResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    SerpGoogleLocalFinderTasksFixedResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleLocalFinderTasksFixedTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    SerpGoogleLocalFinderTaskGetAdvancedResultInfo:
      type: object
      properties:
        keyword:
          type: string
          description: <em>keyword received in a POST array<br></em><strong>the keyword is returned with decoded %## (plus symbol '+' will be decoded to a space character)</strong>
          nullable: true
        type:
          type: string
          description: type of element
          nullable: true
        se_domain:
          type: string
          description: <em>search engine domain in a POST array</em>
          nullable: true
        location_code:
          type: integer
          description: <em>location code in a POST array</em>
          nullable: true
        language_code:
          type: string
          description: <em>language code in a POST array</em>
          nullable: true
        check_url:
          type: string
          description: <em>direct URL to search engine results<br></em>you can use it to make sure that we provided exact results
          nullable: true
        datetime:
          type: string
          description: '<em>date and time when the result was received</em><br>in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”<br>example:<br><code class="long-string">2019-11-15 12:57:46 +00:00</code>'
          nullable: true
        spell:
          type: object
          oneOf:
            - $ref: '#/components/schemas/SpellInfo'
          description: '<em>autocorrection of the search engine</em><br>if the search engine provided results for a keyword that was corrected, we will specify the keyword corrected by the search engine and the type of autocorrection'
          nullable: true
        refinement_chips:
          type: object
          oneOf:
            - $ref: '#/components/schemas/RefinementChipsInfo'
          description: <em>search refinement chips</em>
          nullable: true
        item_types:
          type: array
          items:
            type: string
            nullable: true
          description: <em>types of search results in SERP</em><br>contains types of search results (<code>items</code>) found in SERP.<br>possible item types:<br><code>local_pack</code>
          nullable: true
        se_results_count:
          type: integer
          description: <em> total number of results in SERP</em>
          format: int64
          nullable: true
        items_count:
          type: integer
          description: <em>the number of results returned in the <strong><code>items</code></strong> array</em>
          format: int64
          nullable: true
        items:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/LocalPackSerpElementItem'
            nullable: true
          description: <em>items of the element</em>
          nullable: true
    SerpGoogleLocalFinderTaskGetAdvancedTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleLocalFinderTaskGetAdvancedResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    SerpGoogleLocalFinderTaskGetAdvancedResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleLocalFinderTaskGetAdvancedTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    SerpGoogleLocalFinderTaskGetHtmlResultInfo:
      type: object
      properties:
        keyword:
          type: string
          description: <em>keyword received in a POST array<br></em><strong>keyword is returned with decoded %## (plus symbol '+' will be decoded to a space character)</strong>
          nullable: true
        type:
          type: string
          description: type of element
          nullable: true
        se_domain:
          type: string
          description: <em>search engine domain in a POST array</em>
          nullable: true
        location_code:
          type: integer
          description: <em>location code in a POST array</em>
          nullable: true
        language_code:
          type: string
          description: <em>language code in a POST array</em>
          nullable: true
        datetime:
          type: string
          description: '<em>date and time when the result was received</em><br>in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”<br>example:<br><code class="long-string">2019-11-15 12:57:46 +00:00</code>'
          nullable: true
        items_count:
          type: integer
          description: <em>the number of results returned in the <strong><code>items</code></strong> array</em>
          format: int64
          nullable: true
        items:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/HtmlItemInfo'
            nullable: true
          description: <em>elements of search results found in SERP</em>
          nullable: true
    SerpGoogleLocalFinderTaskGetHtmlTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleLocalFinderTaskGetHtmlResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    SerpGoogleLocalFinderTaskGetHtmlResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleLocalFinderTaskGetHtmlTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    SerpGoogleLocalFinderLiveAdvancedRequestInfo:
      type: object
      properties:
        keyword:
          type: string
          description: '<p><em>keyword</em><p><strong>required field</strong><p>you can specify <strong>up to 700 characters</strong> in the <code>keyword</code> field<p>all %## will be decoded (plus character ‘+’ will be decoded to a space character)<p>if you need to use the “%” character for your <code>keyword</code>, please specify it as “%25”;<p>if you need to use the “+” character for your <code>keyword</code>, please specify it as “%2B”</p><br><p>learn more about rules and limitations of <code>keyword</code> and <code>keywords</code> fields in DataForSEO APIs in this <a href="https://dataforseo.com/help-center/rules-and-limitations-of-keyword-and-keywords-fields-in-dataforseo-apis" rel="noopener noreferrer" target="_blank">Help Center article</a></p>'
        location_code:
          type: integer
          description: '<p><em>search engine location code</em><p><strong>required field if you don''t specify</strong> <code>location_name</code>&nbsp;or <code>location_coordinate</code><p><strong>if you use this field, you don''t need to specify <code>location_name</code> or <code>location_coordinate</code></strong><p>you can receive the list of available locations of the search engines with their <code>location_code</code> by making a separate request to the <code>https://api.dataforseo.com/v3/serp/{{low_se_name}}/locations</code><p>example:<p><code class="long-string">2840</code></p>'
        language_code:
          type: string
          description: '<p><em>search engine language code</em><p><strong>required field if you don''t specify</strong> <code>language_name</code><p><strong>if you use this field, you don''t need to specify <code>language_name</code></strong><p>you can receive the list of available languages of the search engine with their <code>language_code</code>&nbsp;by making a separate request to the <code>https://api.dataforseo.com/v3/serp/{{low_se_name}}/languages</code><p>example:<code class="long-string">en</code></p>'
        depth:
          type: integer
          description: '<p><em>parsing depth</em><p>optional field<p>number of results in SERP<br><p>default value: <code>10</code><p>max value: <code>100</code></p><br><strong>Your account will be billed per each SERP containing up to 10 results;</strong><p>Setting depth above 10 may result in additional charges if the search engine returns more than 10 results respectively;<p>If the specified depth is higher than the number of results in the response, the difference will be refunded to your account balance automatically<p>The cost can be calculated on the <a title="Pricing" href="https://dataforseo.com/pricing/serp/google-local-finder-serp-api" target="_blank" rel="noopener noreferrer">Pricing</a> page.'
          nullable: true
        device:
          type: string
          description: '<p><em>device type</em><p>optional field<p>return results for a specific device type<p>can take the values:<code>desktop</code>, <code>mobile</code><p>default value: <code>desktop</code></p>'
          nullable: true
        location_name:
          type: string
          description: '<p><em>full name of search engine location</em><p><strong>required field if you don''t specify</strong> <code>location_code</code> or <code>location_coordinate</code><p><strong>if you use this field, you don''t need to specify <code>location_code</code> or <code>location_coordinate</code></strong><p>you can receive the list of available locations of the search engine with their <code>location_name</code> by making a separate request to the <code>https://api.dataforseo.com/v3/serp/{{low_se_name}}/locations</code><p>example:<p><code class="long-string">London,England,United Kingdom</code></p>'
        language_name:
          type: string
          description: '<p><em>full name of search engine language</em><p><strong>required field if you don''t specify</strong> <code>language_code</code><p><strong>if you use this field, you don''t need to specify <code>language_code</code></strong><p>you can receive the list of available languages of the search engine with their <code>language_name</code> by making a separate request to the <code>https://api.dataforseo.com/v3/serp/{{low_se_name}}/languages</code><p>example:<p><code class="long-string">English</code></p>'
        os:
          type: string
          description: '<p><em>device operating system</em><p>optional field<p>if you specify <code>desktop</code> in the <code>device</code> field, choose from the following values: <code>windows</code>, <code>macos</code><p>default value: <code>windows</code><p>if you specify <code>mobile</code> in the <code>device</code> field, choose from the following values: <code>android</code>, <code>ios</code><p>default value: <code>android</code></p>'
          nullable: true
        tag:
          type: string
          description: <p><em>user-defined task identifier</em><p>optional field<p><em>the character limit is 255</em><p>you can use this parameter to identify the task and match it with the result<p>you will find the specified <code>tag</code> value in the <code>data</code> object of the response</p>
          nullable: true
        priority:
          type: integer
          description: <p><em>task priority</em><p>optional field<p>can take the following values:<p>1 – normal execution priority (set by default)<p>2 – high execution priority</p><br>You will be additionally charged for the tasks with high execution priority.<p>The cost can be calculated on the <a title="Pricing" href="https://dataforseo.com/pricing/serp/google-local-finder-serp-api" target="_blank" rel="noopener noreferrer">Pricing</a> page.
          nullable: true
        location_coordinate:
          type: string
          description: '<p><em>GPS coordinates of a location</em><p><strong>required field if you don''t specify</strong> <code>location_name</code>&nbsp;or <code>location_code</code><p><strong>if you use this field, you don''t need to specify <code>location_name</code> or <code>location_code</code></strong><p><code>location_coordinate</code> parameter should be specified in the <em>"latitude,longitude,zoom"</em> format<p>if <em>"zoom"</em> is not specified, <em>9z</em> will be applied as a default value<p>the maximum number of decimal digits for <em>"latitude"</em> and <em>"longitude"</em>: 7<p>the minimum value for <em>"zoom"</em>: 4z<p>the maximum value for <em>"zoom"</em>: 18z<p>example:<p><code class="long-string">52.6178549,-155.352142,20z</code></p>'
        min_rating:
          type: number
          description: '<p><em>filter results by minimum rating</em><p>optional field<p>possible values for <code>desktop</code>: <code>3.5</code>, <code>4</code>, <code>4.5</code>;<p>possible values for <code>mobile</code>: <code>2</code>, <code>2.5</code>, <code>3</code>, <code>3.5</code>, <code>4</code>, <code>4.5</code></p>'
          format: double
          nullable: true
        time_filter:
          type: string
          description: '<p><em>filter results by open hours</em><p>optional field<p>using this field, you can filter places in the results by the time a place is open for visitors<p>note that Google may also provide results that do not match this filter<p>possible values: <code>"open_now"</code>, <code>"24_hours"</code>, <code>"$day_value"</code>, <code>"$day_value;$time_value"</code>;<p>instead of <code>$day_value</code> use one of these values: <code>"monday"</code>, <code>"tuesday"</code>, <code>"wednesday"</code>, <code>"thursday"</code>, <code>"friday"</code>, <code>"saturday"</code>, <code>"sunday"</code>;<p>instead of <code>$time_value</code> use one of these values: <code>"00"</code>, <code>"01"</code>, <code>"02"</code>, <code>"03"</code>, <code>"04"</code>, <code>"05"</code>, <code>"06"</code>, <code>"07"</code>, <code>"08"</code>, <code>"09"</code>, <code>"10"</code>, <code>"11"</code>, <code>"12"</code>, <code>"13"</code>, <code>"14"</code>, <code>"15"</code>, <code>"16"</code>, <code>"17"</code>, <code>"18"</code>, <code>"19"</code>, <code>"20"</code>, <code>"21"</code>, <code>"22"</code>, <code>"23"</code><p>example: <code class="long-string">"tuesday;18"</code></p>'
          nullable: true
      example:
        - language_code: en
          location_code: 2840
          keyword: local nail services
          min_rating: 4.5
          time_filter: monday
    SerpGoogleLocalFinderLiveAdvancedResultInfo:
      type: object
      properties:
        keyword:
          type: string
          description: <em>keyword received in a POST array<br></em><strong>the keyword is returned with decoded %## (plus character '+' will be decoded to a space character)</strong>
          nullable: true
        type:
          type: string
          description: type of element
          nullable: true
        se_domain:
          type: string
          description: <em>search engine domain in a POST array<br></em>
          nullable: true
        location_code:
          type: integer
          description: <em>location code in a POST array</em>
          nullable: true
        language_code:
          type: string
          description: <em>language code in a POST array</em>
          nullable: true
        check_url:
          type: string
          description: <em>direct URL to search engine results<br></em>you can use it to make sure that we provided exact results
          nullable: true
        datetime:
          type: string
          description: '<em>date and time when the result was received</em><br>in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”<br>example:<br><code class="long-string">2019-11-15 12:57:46 +00:00</code>'
          nullable: true
        spell:
          type: object
          oneOf:
            - $ref: '#/components/schemas/SpellInfo'
          description: '<em>autocorrection of the search engine</em><br>if the search engine provided results for a keyword that was corrected, we will specify the keyword corrected by the search engine and the type of autocorrection'
          nullable: true
        refinement_chips:
          type: object
          oneOf:
            - $ref: '#/components/schemas/RefinementChipsInfo'
          description: <em>search refinement chips</em>
          nullable: true
        item_types:
          type: array
          items:
            type: string
            nullable: true
          description: <em>types of search results in SERP</em><br>contains types of search results (<code>items</code>) found in SERP.<br>possible item types:<br><code>local_pack</code>
          nullable: true
        se_results_count:
          type: integer
          description: <em> total number of results in SERP</em>
          format: int64
          nullable: true
        items_count:
          type: integer
          description: <em>the number of results returned in the <strong><code>items</code></strong> array</em>
          format: int64
          nullable: true
        items:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/LocalPackSerpElementItem'
            nullable: true
          description: <em>items of the element</em>
          nullable: true
    SerpGoogleLocalFinderLiveAdvancedTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleLocalFinderLiveAdvancedResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    SerpGoogleLocalFinderLiveAdvancedResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleLocalFinderLiveAdvancedTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    SerpGoogleLocalFinderLiveHtmlRequestInfo:
      type: object
      properties:
        keyword:
          type: string
          description: '<p><em>keyword</em><p><strong>required field</strong><p>you can specify <strong>up to 700 characters</strong> in the <code>keyword</code> field<p>all %## will be decoded (plus character ‘+’ will be decoded to a space character)<p>if you need to use the “%” character for your <code>keyword</code>, please specify it as “%25”;<p>if you need to use the “+” character for your <code>keyword</code>, please specify it as “%2B”</p>'
        location_code:
          type: integer
          description: '<p><em>search engine location code</em><p><strong>required field if you don''t specify</strong> <code>location_name</code>&nbsp;or <code>location_coordinate</code><p><strong>if you use this field, you don''t need to specify <code>location_name</code> or <code>location_coordinate</code></strong><p>you can receive the list of available locations of the search engines with their <code>location_code</code> by making a separate request to the <code>https://api.dataforseo.com/v3/serp/{{low_se_name}}/locations</code><p>example:<p><code class="long-string">2840</code></p>'
        language_code:
          type: string
          description: '<p><em>search engine language code</em><p><strong>required field if you don''t specify</strong> <code>language_name</code><p><strong>if you use this field, you don''t need to specify <code>language_name</code></strong><p>you can receive the list of available languages of the search engine with their <code>language_code</code>&nbsp;by making a separate request to the <code>https://api.dataforseo.com/v3/serp/{{low_se_name}}/languages</code><p>example:<code class="long-string">en</code></p>'
        depth:
          type: integer
          description: '<p><em>parsing depth</em><p>optional field<p>number of results in SERP<br><p>default value: <code>10</code><p>max value: <code>100</code></p><br><strong>Your account will be billed per each SERP containing up to 10 results;</strong><p>Setting depth above 10 may result in additional charges if the search engine returns more than 10 results;<p>If the specified depth is higher than the number of results in the response, the difference will be refunded to your account balance automatically<p>The cost can be calculated on the <a title="Pricing" href="https://dataforseo.com/pricing/serp/google-local-finder-serp-api" target="_blank" rel="noopener noreferrer">Pricing</a> page.'
          nullable: true
        device:
          type: string
          description: '<p><em>device type</em><p>optional field<p>return results for a specific device type<p>can take the values:<code>desktop</code>, <code>mobile</code><p>default value: <code>desktop</code></p>'
          nullable: true
        location_name:
          type: string
          description: '<p><em>full name of search engine location</em><p><strong>required field if you don''t specify</strong> <code>location_code</code> or <code>location_coordinate</code><p><strong>if you use this field, you don''t need to specify <code>location_code</code> or <code>location_coordinate</code></strong><p>you can receive the list of available locations of the search engine with their <code>location_name</code> by making a separate request to the <code>https://api.dataforseo.com/v3/serp/{{low_se_name}}/locations</code><p>example:<p><code class="long-string">London,England,United Kingdom</code></p>'
        language_name:
          type: string
          description: '<p><em>full name of search engine language</em><p><strong>required field if you don''t specify</strong> <code>language_code</code><p><strong>if you use this field, you don''t need to specify <code>language_code</code></strong><p>you can receive the list of available languages of the search engine with their <code>language_name</code> by making a separate request to the <code>https://api.dataforseo.com/v3/serp/{{low_se_name}}/languages</code><p>example:<p><code class="long-string">English</code></p>'
        os:
          type: string
          description: '<p><em>device operating system</em><p>optional field<p>if you specify <code>desktop</code> in the <code>device</code> field, choose from the following values: <code>windows</code>, <code>macos</code><p>default value: <code>windows</code><p>if you specify <code>mobile</code> in the <code>device</code> field, choose from the following values: <code>android</code>, <code>ios</code><p>default value: <code>android</code></p>'
          nullable: true
        tag:
          type: string
          description: <p><em>user-defined task identifier</em><p>optional field<p><em>the character limit is 255</em><p>you can use this parameter to identify the task and match it with the result<p>you will find the specified <code>tag</code> value in the <code>data</code> object of the response</p>
          nullable: true
        location_coordinate:
          type: string
          description: '<p><em>GPS coordinates of a location</em><p><strong>required field if you don''t specify</strong> <code>location_name</code>&nbsp;or <code>location_code</code><p><strong>if you use this field, you don''t need to specify <code>location_name</code> or <code>location_code</code></strong><p><code>location_coordinate</code> parameter should be specified in the <em>"latitude,longitude,zoom"</em> format<p>if <em>"zoom"</em> is not specified, <em>9z</em> will be applied as a default value<p>the maximum number of decimal digits for <em>"latitude"</em> and <em>"longitude"</em>: 7<p>the minimum value for <em>"zoom"</em>: 4z<p>the maximum value for <em>"zoom"</em>: 18z<p>example:<p><code class="long-string">52.6178549,-155.352142,20z</code></p>'
        min_rating:
          type: string
          description: '<p><em>filter results by minimum rating</em><p>optional field<p>possible values for <code>desktop</code>: <code>3.5</code>, <code>4</code>, <code>4.5</code>;<p>possible values for <code>mobile</code>: <code>2</code>, <code>2.5</code>, <code>3</code>, <code>3.5</code>, <code>4</code>, <code>4.5</code></p>'
          nullable: true
        time_filter:
          type: string
          description: '<p><em>filter results by open hours</em><p>optional field<p>using this field, you can filter places in the results by the time a place is open for visitors<p>note that Google may also provide results that do not match this filter<p>possible values: <code>"open_now"</code>, <code>"24_hours"</code>, <code>"$day_value"</code>, <code>"$day_value;$time_value"</code>;<p>instead of <code>$day_value</code> use one of these values: <code>"monday"</code>, <code>"tuesday"</code>, <code>"wednesday"</code>, <code>"thursday"</code>, <code>"friday"</code>, <code>"saturday"</code>, <code>"sunday"</code>;<p>instead of <code>$time_value</code> use one of these values: <code>"00"</code>, <code>"01"</code>, <code>"02"</code>, <code>"03"</code>, <code>"04"</code>, <code>"05"</code>, <code>"06"</code>, <code>"07"</code>, <code>"08"</code>, <code>"09"</code>, <code>"10"</code>, <code>"11"</code>, <code>"12"</code>, <code>"13"</code>, <code>"14"</code>, <code>"15"</code>, <code>"16"</code>, <code>"17"</code>, <code>"18"</code>, <code>"19"</code>, <code>"20"</code>, <code>"21"</code>, <code>"22"</code>, <code>"23"</code><p>example: <code class="long-string">"tuesday;18"</code></p>'
          nullable: true
      example:
        - language_code: en
          location_code: 2840
          keyword: albert einstein
    SerpGoogleLocalFinderLiveHtmlResultInfo:
      type: object
      properties:
        keyword:
          type: string
          description: <em>keyword received in a POST array<br></em><strong>keyword is returned with decoded %## (plus character '+' will be decoded to a space character)</strong>
          nullable: true
        type:
          type: string
          description: type of element
          nullable: true
        se_domain:
          type: string
          description: <em>search engine domain in a POST array</em>
          nullable: true
        location_code:
          type: integer
          description: <em>location code in a POST array</em>
          nullable: true
        language_code:
          type: string
          description: <em>language code in a POST array</em>
          nullable: true
        datetime:
          type: string
          description: '<em>date and time when the result was received</em><br>in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”<br>example:<br><code class="long-string">2019-11-15 12:57:46 +00:00</code>'
          nullable: true
        items_count:
          type: integer
          description: <em>the number of results returned in the <strong><code>items</code></strong> array</em>
          format: int64
          nullable: true
        items:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/HtmlItemInfo'
            nullable: true
          description: <em>elements of search results found in SERP</em>
          nullable: true
    SerpGoogleLocalFinderLiveHtmlTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleLocalFinderLiveHtmlResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    SerpGoogleLocalFinderLiveHtmlResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleLocalFinderLiveHtmlTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    SerpGoogleNewsTaskPostRequestInfo:
      type: object
      properties:
        keyword:
          type: string
          description: '<p><em>keyword</em><p><strong>required field</strong><p>you can specify <strong>up to 700 characters</strong> in the <code>keyword</code> field<p>all %## will be decoded (plus character ‘+’ will be decoded to a space character)<p>if you need to use the “%” character for your <code>keyword</code>, please specify it as “%25”;<p>if you need to use the “+” character for your <code>keyword</code>, please specify it as “%2B”;<p>if this field contains such parameters as <em>‘allinanchor:’, ‘allintext:’, ‘allintitle:’, ‘allinurl:’, ‘define:’, ‘filetype:’, ‘id:’, ‘inanchor:’, ‘info:’, ‘intext:’, ‘intitle:’, ‘inurl:’, ‘link:’, ‘related:’, ‘site:’</em>, <strong>the charge per task will be multiplied by 5</strong><p><strong>Note:</strong> queries containing the ‘cache:’ parameter are not supported and will return a validation error</p><br><p>learn more about rules and limitations of <code>keyword</code> and <code>keywords</code> fields in DataForSEO APIs in this <a href="https://dataforseo.com/help-center/rules-and-limitations-of-keyword-and-keywords-fields-in-dataforseo-apis" rel="noopener noreferrer" target="_blank">Help Center article</a></p>'
        location_code:
          type: integer
          description: '<p><em>search engine location code</em><p><strong>required field if you don''t specify</strong> <code>location_name</code>&nbsp;or <code>location_coordinate</code><p><strong>if you use this field, you don''t need to specify <code>location_name</code> or <code>location_coordinate</code></strong><p>you can receive the list of available locations of the search engines with their <code>location_code</code> by making a separate request to the <code>https://api.dataforseo.com/v3/serp/{{low_se_name}}/locations</code><p>example:<p><code class="long-string">2840</code></p>'
        language_code:
          type: string
          description: '<p><em>search engine language code</em><p><strong>required field if you don''t specify</strong> <code>language_name</code><p><strong>if you use this field, you don''t need to specify <code>language_name</code></strong><p>you can receive the list of available languages of the search engine with their <code>language_code</code>&nbsp;by making a separate request to the <code>https://api.dataforseo.com/v3/serp/{{low_se_name}}/languages</code><em><p></em>example:<em><p></em><code class="long-string">en</code></p>'
        depth:
          type: integer
          description: '<p><em>parsing depth</em><p>optional field<p>number of results in SERP<p>default value: <code>10</code><p>max value: <code>700</code></p><br><strong>Your account will be billed per each SERP containing up to 10 results;</strong><p>Setting depth above 10 may result in additional charges if the search engine returns more than 10 results;<p>If the specified depth is higher than the number of results in the response, the difference will be refunded to your account balance automatically;<p>The cost can be calculated on the <a title="Pricing" href="https://dataforseo.com/pricing/serp/google-news-serp-api" target="_blank" rel="noopener noreferrer">Pricing</a> page.'
          nullable: true
        priority:
          type: integer
          description: <p><em>task priority</em><p>optional field<p>can take the following values:<p>1 – normal execution priority (set by default)<p>2 – high execution priority</p><br>You will be additionally charged for the tasks with high execution priority.<p>The cost can be calculated on the <a title="Pricing" href="https://dataforseo.com/pricing/serp/google-news-serp-api" target="_blank" rel="noopener noreferrer">Pricing</a> page.
          nullable: true
        pingback_url:
          type: string
          description: '<p><em>notification URL of a completed task</em><p>optional field<p>when a task is completed we will notify you by GET request sent to the URL you have specified<p>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<p>example:<p><code>http://your-server.com/pingscript?id=$id</code><p><code>http://your-server.com/pingscript?id=$id&amp;tag=$tag</code><p><strong>Note:</strong> special characters in <code>pingback_url</code> will be urlencoded;<p>i.a., the <code>#</code> character will be encoded into <code>%23</code></p><br><p>learn more on our <a href="https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api" target="_blank" rel="noopener noreferrer">Help Center</a></p>'
          nullable: true
        postback_url:
          type: string
          description: '<p><em>URL for sending task results</em><p>optional field<p>once the task is completed, we will send a POST request with its results compressed in the <code>gzip</code> format to the <code>postback_url</code> you specified<p>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<p>example:<p><code>http://your-server.com/postbackscript?id=$id</code><p><code>http://your-server.com/postbackscript?id=$id&amp;tag=$tag</code><p><strong>Note:</strong> special characters in <code>postback_url</code> will be urlencoded;<p>i.a., the <code>#</code> character will be encoded into <code>%23</code></p><br><p>learn more on our <a href="https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api" target="_blank" rel="noopener noreferrer">Help Center</a></p>'
          nullable: true
        postback_data:
          type: string
          description: '<p><em>postback_url datatype</em><p><strong>required field if you specify <code>postback_url</code></strong><p>corresponds to the datatype that will be sent to your server<p>possible values:<p><code>advanced</code>, <code>html</code></p>'
        location_name:
          type: string
          description: '<p><em>full name of search engine location</em><p><strong>required field if you don''t specify</strong> <code>location_code</code> or <code>location_coordinate</code><p><strong>if you use this field, you don''t need to specify <code>location_code</code> or <code>location_coordinate</code></strong><p>you can receive the list of available locations of the search engine with their <code>location_name</code> by making a separate request to the <code>https://api.dataforseo.com/v3/serp/{{low_se_name}}/locations</code><p>example:<p><code class="long-string">London,England,United Kingdom</code></p>'
        language_name:
          type: string
          description: '<p><em>full name of search engine language</em><p><strong>required field if you don''t specify</strong> <code>language_code</code><p><strong>if you use this field, you don''t need to specify <code>language_code</code></strong><p>you can receive the list of available languages of the search engine with their <code>language_name</code> by making a separate request to the <code>https://api.dataforseo.com/v3/serp/{{low_se_name}}/languages</code><p>example:<p><code class="long-string">English</code></p>'
        os:
          type: string
          description: '<p><em>device operating system</em><p>optional field<p><strong>note that this API provides results for desktop only</strong><p>choose from the following values: <code>windows</code>, <code>macos</code><p>default value: <code>windows</code></p>'
          nullable: true
        tag:
          type: string
          description: <p><em>user-defined task identifier</em><p>optional field<p><em>the character limit is 255</em><p>you can use this parameter to identify the task and match it with the result<p>you will find the specified <code>tag</code> value in the <code>data</code> object of the response</p>
          nullable: true
        max_crawl_pages:
          type: integer
          description: '<p><em>page crawl limit</em><p>optional field<p>number of search results pages to crawl<p>max value: <code>100</code><p><strong>Note:</strong> the <code>max_crawl_pages</code> and <code>depth</code> parameters complement each other;<p>learn more at <a href="https://dataforseo.com/help-center/what-is-max-crawl-pages-and-how-does-it-work" target="_blank" rel="noopener noreferrer">our help center</a></p>'
          nullable: true
        search_param:
          type: string
          description: <p><em>additional parameters of the search query</em><p>optional field<p><a href="https://dataforseo.com/help-center/google-search-engine-parameters-and-how-to-use-them">get the list of available parameters and additional details here</a></p>
          nullable: true
        calculate_rectangles:
          type: boolean
          description: '<p><em>calculate pixel rankings for SERP elements in advanced results</em><p>optional field<p>pixel ranking refers to the distance between the result snippet and top left corner of the screen;<p><a href="https://dataforseo.com/help-center/pixel-ranking-in-serp-api">Visit Help Center to learn more&gt;&gt;</a><p>by default, the parameter is set to <code>false</code><p><strong>Note:</strong> if set to <code>true</code>, the charge per task will be multiplied by 2</p>'
          nullable: true
        browser_screen_width:
          type: integer
          description: '<p><em>browser screen width</em><p>optional field<p>you can set a custom browser screen width to calculate pixel rankings for a particular device;<p>by default, the parameter is set to <code>1920</code>;<p><strong>Note:</strong> to use this parameter, set <code>calculate_rectangles</code> to <code>true</code></p>'
          format: int64
          nullable: true
        browser_screen_height:
          type: integer
          description: '<p><em>browser screen height</em><p>optional field<p>you can set a custom browser screen height to calculate pixel rankings for a particular device;<p>by default, the parameter is set to <code>1080</code>;<p><strong>Note:</strong> to use this parameter, set <code>calculate_rectangles</code> to <code>true</code></p>'
          nullable: true
        browser_screen_resolution_ratio:
          type: integer
          description: '<p><em>browser screen resolution ratio</em><p>optional field<p>you can set a custom browser screen resolution ratio to calculate pixel rankings for a particular device;<p>by default, the parameter is set to <code>1</code>;<p><strong>Note:</strong> to use this parameter, set <code>calculate_rectangles</code> to <code>true</code></p>'
          nullable: true
        url:
          type: string
          description: '<p><em>direct URL of the search query</em><p>optional field<p>you can specify a direct URL and we will sort it out to the necessary fields;<p><strong>Note</strong> that this method is the most difficult for our API to process and also requires you to specify the exact language and location in the URL. In most cases, we wouldn’t recommend using this method;<p>example:<p><code class="long-string">https://www.google.co.uk/search?q=%20rank%20tracker%20api&amp;hl=en&amp;gl=GB&amp;uule=w+CAIQIFISCXXeIa8LoNhHEZkq1d1aOpZS</code></p>'
          nullable: true
        location_coordinate:
          type: string
          description: '<p><em>GPS coordinates of a location</em><p><strong>required field if you don''t specify</strong> <code>location_name</code>&nbsp;or <code>location_code</code><p><strong>if you use this field, you don''t need to specify <code>location_name</code> or <code>location_code</code></strong><p><code>location_coordinate</code> parameter should be specified in the <em>"latitude,longitude,radius"</em> format<p>the maximum number of decimal digits for <em>"latitude"</em> and <em>"longitude"</em>: 7<p>the minimum value for <em>"radius"</em>: 199.9 (mm)<p>the maximum value for <em>"radius"</em>: 199999 (mm)<p>example:<p><code class="long-string">53.476225,-2.243572,200</code></p>'
        se_domain:
          type: string
          description: '<p><em>search engine domain</em><p>optional field<p>we choose the relevant search engine domain automatically according to the location and language you specify<p>however, you can set a custom search engine domain in this field<p>example:<p><code><code></code></code><em>google.co.uk</em>, <code><code></code></code><em>google.com.au</em>, <code><code></code></code><em>google.de</em>, etc.</p>'
          nullable: true
      example:
        - language_code: en
          location_code: 2840
          keyword: albert einstein
    SerpGoogleNewsTaskPostTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: object
              description: '<em>array of results</em><br>in this case, the value will be <code>null</code>'
              nullable: true
    SerpGoogleNewsTaskPostResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleNewsTaskPostTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    SerpGoogleNewsTasksReadyResultInfo:
      type: object
      properties:
        id:
          type: string
          description: <em>task identifier of the completed task</em><br><strong>unique task identifier in our system in the <a href="https://en.wikipedia.org/wiki/Universally_unique_identifier">UUID</a> format</strong>
          nullable: true
        se:
          type: string
          description: <em>search engine specified when setting the task</em>
          nullable: true
        se_type:
          type: string
          description: '<em>type of search engine</em><br>example: <code>{{low_se_type_under}}</code>'
          nullable: true
        date_posted:
          type: string
          description: <em>date when the task was posted (in the UTC format)</em>
          nullable: true
        tag:
          type: string
          description: <em>user-defined task identifier</em>
          nullable: true
        endpoint_regular:
          type: string
          description: '<em>URL for collecting the results of the SERP Regular task</em><br>if SERP Regular is not supported in the specified endpoint, the value will be <code>null</code>'
          nullable: true
        endpoint_advanced:
          type: string
          description: '<em>URL for collecting the results of the SERP Advanced task</em><br>if SERP Advanced is not supported in the specified endpoint, the value will be <code>null</code>'
          nullable: true
        endpoint_html:
          type: string
          description: '<em>URL for collecting the results of the SERP HTML task</em><br>if SERP HTML is not supported in the specified endpoint, the value will be <code>null</code>'
          nullable: true
    SerpGoogleNewsTasksReadyTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleNewsTasksReadyResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    SerpGoogleNewsTasksReadyResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleNewsTasksReadyTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    SerpGoogleNewsTasksFixedResultInfo:
      type: object
      properties:
        id:
          type: string
          description: <em>task identifier of the completed task</em><br><strong>unique task identifier in our system in the <a href="https://en.wikipedia.org/wiki/Universally_unique_identifier">UUID</a> format</strong>
          nullable: true
        se:
          type: string
          description: <em>search engine specified when setting the task</em>
          nullable: true
        se_type:
          type: string
          description: '<em>type of search engine</em><br>can take the following values: <code>{{low_se_type_under}}</code>'
          nullable: true
        date_posted:
          type: string
          nullable: true
        tag:
          type: string
          description: <em>user-defined task identifier</em>
          nullable: true
        endpoint_regular:
          type: string
          description: '<em>URL for collecting the results of the SERP Regular task</em><br>if SERP Regular is not supported in the specified endpoint, the value will be <code>null</code>'
          nullable: true
        endpoint_advanced:
          type: string
          description: '<em>URL for collecting the results of the SERP Advanced task</em><br>if SERP Advanced is not supported in the specified endpoint, the value will be <code>null</code>'
          nullable: true
        endpoint_html:
          type: string
          description: '<em>URL for collecting the results of the SERP HTML task</em><br>if SERP HTML is not supported in the specified endpoint, the value will be <code>null</code>'
          nullable: true
    SerpGoogleNewsTasksFixedTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleNewsTasksFixedResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    SerpGoogleNewsTasksFixedResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleNewsTasksFixedTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    SerpApiGoogleNewsNewsSearchElementItem:
      type: object
      allOf:
        - type: object
          oneOf:
            - $ref: '#/components/schemas/BaseSerpApiGoogleNewsElementItem'
          nullable: true
        - type: object
          properties:
            domain:
              type: string
              description: <em>domain in SERP</em>
              nullable: true
            url:
              type: string
              description: <em>search URL with refinement parameters</em>
              nullable: true
            image_url:
              type: string
              description: <em>URL of the image</em><br>the URL leading to the image on the original resource or DataForSEO storage (in case the original source is not available)
              nullable: true
            snippet:
              type: string
              description: <em>snippet of the result in SERP</em>
              nullable: true
            time_published:
              type: string
              description: <em>indicates the time the result was published</em>
              nullable: true
            timestamp:
              type: string
              description: <em>date and time when the news was published</em><br>in the format “year-month-date:minutes:UTC_difference_hours:UTC_difference_minutes”<br>example:<br><code>2019-11-15 12:57:46 +00:00</code>
              nullable: true
    SerpApiGoogleNewsTopStoriesElementItem:
      type: object
      allOf:
        - type: object
          oneOf:
            - $ref: '#/components/schemas/BaseSerpApiGoogleNewsElementItem'
          nullable: true
        - type: object
          properties:
            page:
              type: integer
              nullable: true
            position:
              type: string
              description: <em>the alignment of the element in SERP</em><br>can take the following values:<br><code>left</code>
              nullable: true
            items:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/TopStoriesElement'
                nullable: true
              description: <em>items of the element</em>
              nullable: true
    SerpGoogleNewsTaskGetAdvancedResultInfo:
      type: object
      properties:
        keyword:
          type: string
          description: <em>keyword received in a POST array<br></em><strong>the keyword is returned with decoded %## (plus symbol '+' will be decoded to a space character)</strong>
          nullable: true
        type:
          type: string
          description: type of element
          nullable: true
        se_domain:
          type: string
          description: <em>search engine domain in a POST array</em>
          nullable: true
        location_code:
          type: integer
          description: <em>location code in a POST array</em>
          nullable: true
        language_code:
          type: string
          description: <em>language code in a POST array</em>
          nullable: true
        check_url:
          type: string
          description: <em>direct URL to search engine results<br></em>you can use it to make sure that we provided accurate results
          nullable: true
        datetime:
          type: string
          description: '<em>date and time when the result was received</em><br>in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”<br>example:<br><code class="long-string">2019-11-15 12:57:46 +00:00</code>'
          nullable: true
        spell:
          type: object
          oneOf:
            - $ref: '#/components/schemas/SpellInfo'
          description: '<em>autocorrection of the search engine</em><br>if the search engine provided results for a keyword that was corrected, we will specify the keyword corrected by the search engine and the type of autocorrection'
          nullable: true
        refinement_chips:
          type: object
          oneOf:
            - $ref: '#/components/schemas/RefinementChipsInfo'
          description: <em>search refinement chips</em>
          nullable: true
        includes_non_news_search_results:
          type: boolean
          description: <em>indicates whether the response contains non-news search results in addition to news content</em>
          nullable: true
        item_types:
          type: array
          items:
            type: string
            nullable: true
          description: '<em>types of search results in SERP</em><br>contains types of search results (<code>items</code>) found in SERP.<br>possible item types:<br><code>top_stories</code>, <code>news_search</code>'
          nullable: true
        se_results_count:
          type: integer
          description: <em> total number of results in SERP</em>
          format: int64
          nullable: true
        items_count:
          type: integer
          description: <em>the number of results returned in the <strong><code>items</code></strong> array</em>
          format: int64
          nullable: true
        items:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/BaseSerpApiGoogleNewsElementItem'
            nullable: true
          description: <em>elements of search results found in SERP</em>
          nullable: true
    SerpGoogleNewsTaskGetAdvancedTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleNewsTaskGetAdvancedResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    SerpGoogleNewsTaskGetAdvancedResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleNewsTaskGetAdvancedTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    SerpGoogleNewsTaskGetHtmlResultInfo:
      type: object
      properties:
        keyword:
          type: string
          description: <em>keyword received in a POST array<br></em><strong>keyword is returned with decoded %## (plus symbol '+' will be decoded to a space character)</strong>
          nullable: true
        type:
          type: string
          description: type of element
          nullable: true
        se_domain:
          type: string
          description: <em>search engine domain in a POST array</em>
          nullable: true
        location_code:
          type: integer
          description: <em>location code in a POST array</em>
          nullable: true
        language_code:
          type: string
          description: <em>language code in a POST array</em>
          nullable: true
        datetime:
          type: string
          description: '<em>date and time when the result was received</em><br>in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”<br>example:<br><code class="long-string">2019-11-15 12:57:46 +00:00</code>'
          nullable: true
        items_count:
          type: integer
          description: <em>the number of results returned in the <strong><code>items</code></strong> array</em>
          format: int64
          nullable: true
        items:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/HtmlItemInfo'
            nullable: true
          description: <em>elements of search results found in SERP</em>
          nullable: true
    SerpGoogleNewsTaskGetHtmlTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleNewsTaskGetHtmlResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    SerpGoogleNewsTaskGetHtmlResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleNewsTaskGetHtmlTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    SerpGoogleNewsLiveAdvancedRequestInfo:
      type: object
      properties:
        keyword:
          type: string
          description: '<p><em>keyword</em><p><strong>required field</strong><p>you can specify <strong>up to 700 characters</strong> in the <code>keyword</code> field<p>all %## will be decoded (plus character ''+'' will be decoded to a space character)<p>if you need to use the "%" character for your <code>keyword</code>, please specify it as "%25";<p>if you need to use the “+” character for your <code>keyword</code>, please specify it as “%2B”;<p>if this field contains such parameters as <em>''allinanchor:'', ''allintext:'', ''allintitle:'', ''allinurl:'', ''define:'', ''filetype:'', ''id:'', ''inanchor:'', ''info:'', ''intext:'', ''intitle:'', ''inurl:'', ''link:'', ''related:'', ''site:''</em>, <strong>the charge per task will be multiplied by 5</strong><p><strong>Note:</strong> queries containing the ‘cache:’ parameter are not supported and will return a validation error</p><br><p>learn more about rules and limitations of <code>keyword</code> and <code>keywords</code> fields in DataForSEO APIs in this <a href="https://dataforseo.com/help-center/rules-and-limitations-of-keyword-and-keywords-fields-in-dataforseo-apis" rel="noopener noreferrer" target="_blank">Help Center article</a></p>'
        location_code:
          type: integer
          description: '<p><em>search engine location code</em><p><strong>required field if you don''t specify</strong> <code>location_name</code>&nbsp;or <code>location_coordinate</code><p><strong>if you use this field, you don''t need to specify <code>location_name</code> or <code>location_coordinate</code></strong><p>you can receive the list of available locations of the search engines with their <code>location_code</code> by making a separate request to the <code>https://api.dataforseo.com/v3/serp/{{low_se_name}}/locations</code><p>example:<p><code class="long-string">2840</code></p>'
        language_code:
          type: string
          description: '<p><em>search engine language code</em><p><strong>required field if you don''t specify</strong> <code>language_name</code><p><strong>if you use this field, you don''t need to specify <code>language_name</code></strong><p>you can receive the list of available languages of the search engine with their <code>language_code</code>&nbsp;by making a separate request to the <code>https://api.dataforseo.com/v3/serp/{{low_se_name}}/languages</code><em><p></em>example:<em><p></em><code class="long-string">en</code></p>'
        depth:
          type: integer
          description: '<p><em>parsing depth</em><p>optional field<p>number of results in SERP<p>default value: <code>10</code><p>max value: <code>200</code></p><br><strong>Your account will be billed per each SERP containing up to 10 results;</strong><p>Setting depth above 10 may result in additional charges if the search engine returns more than 10 results;<p>If the specified depth is higher than the number of results in the response, the difference will be refunded to your account balance automatically<p>The cost can be calculated on the <a title="Pricing" href="https://dataforseo.com/pricing/serp/google-news-serp-api" target="_blank" rel="noopener noreferrer">Pricing</a> page.'
          nullable: true
        location_name:
          type: string
          description: '<p><em>full name of search engine location</em><p><strong>required field if you don''t specify</strong> <code>location_code</code> or <code>location_coordinate</code><p><strong>if you use this field, you don''t need to specify <code>location_code</code> or <code>location_coordinate</code></strong><p>you can receive the list of available locations of the search engine with their <code>location_name</code> by making a separate request to the <code>https://api.dataforseo.com/v3/serp/{{low_se_name}}/locations</code><p>example:<p><code class="long-string">London,England,United Kingdom</code></p>'
        language_name:
          type: string
          description: '<p><em>full name of search engine language</em><p><strong>required field if you don''t specify</strong> <code>language_code</code><p><strong>if you use this field, you don''t need to specify <code>language_code</code></strong><p>you can receive the list of available languages of the search engine with their <code>language_name</code> by making a separate request to the <code>https://api.dataforseo.com/v3/serp/{{low_se_name}}/languages</code><p>example:<p><code class="long-string">English</code></p>'
        os:
          type: string
          description: '<p><em>device operating system</em><p>optional field<p><strong>note that this API provides results for desktop only</strong><p>choose from the following values: <code>windows</code>, <code>macos</code><p>default value: <code>windows</code></p>'
          nullable: true
        max_crawl_pages:
          type: integer
          description: '<p><em>page crawl limit</em><p>optional field<p>number of search results pages to crawl<p>max value: <code>100</code><p><strong>Note:</strong> the <code>max_crawl_pages</code> and <code>depth</code> parameters complement each other;<p>learn more at <a href="https://dataforseo.com/help-center/what-is-max-crawl-pages-and-how-does-it-work" rel="noopener noreferrer" target="_blank">our help center</a></p>'
          nullable: true
        search_param:
          type: string
          description: <p><em>additional parameters of the search query</em><p>optional field<p><a href="https://dataforseo.com/help-center/google-search-engine-parameters-and-how-to-use-them">Get the list of available parameters and additional details here.</a></p>
          nullable: true
        calculate_rectangles:
          type: boolean
          description: '<p><em>calculate pixel rankings for SERP elements in advanced results</em><p>optional field<p>pixel ranking refers to the distance between the result snippet and top left corner of the screen;<p><a href="https://dataforseo.com/help-center/pixel-ranking-in-serp-api">Visit Help Center to learn more&gt;&gt;</a><p>by default, the parameter is set to <code>false</code><p><strong>Note:</strong> if set to <code>true</code>, the charge per task will be multiplied by 2</p>'
          nullable: true
        browser_screen_width:
          type: integer
          description: '<p><em>browser screen width</em><p>optional field<p>you can set a custom browser screen width to calculate pixel rankings for a particular device;<p>by default, the parameter is set to <code>1920</code>;<p><strong>Note:</strong> to use this parameter, set <code>calculate_rectangles</code> to <code>true</code></p>'
          format: int64
          nullable: true
        browser_screen_height:
          type: integer
          description: '<p><em>browser screen height</em><p>optional field<p>you can set a custom browser screen height to calculate pixel rankings for a particular device;<p>by default, the parameter is set to <code>1080</code>;<p><strong>Note:</strong> to use this parameter, set <code>calculate_rectangles</code> to <code>true</code></p>'
          nullable: true
        browser_screen_resolution_ratio:
          type: integer
          description: '<p><em>browser screen resolution ratio</em><p>optional field<p>you can set a custom browser screen resolution ratio to calculate pixel rankings for a particular device;<p>by default, the parameter is set to <code>1</code>;<p><strong>Note:</strong> to use this parameter, set <code>calculate_rectangles</code> to <code>true</code></p>'
          nullable: true
        url:
          type: string
          description: '<p><em>direct URL of the search query</em><p>optional field<p>you can specify a direct URL and we will sort it out to the necessary fields. Note that this method is the most difficult for our API to process and also requires you to specify the exact language and location in the URL. In most cases, we wouldn’t recommend using this method.<p>example:<p><code class="long-string">https://www.google.co.uk/search?q=%20rank%20tracker%20api&amp;hl=en&amp;gl=GB&amp;uule=w+CAIQIFISCXXeIa8LoNhHEZkq1d1aOpZS</code></p>'
          nullable: true
        location_coordinate:
          type: string
          description: '<p><em>GPS coordinates of a location</em><p><strong>required field if you don''t specify</strong> <code>location_name</code>&nbsp;or <code>location_code</code><p><strong>if you use this field, you don''t need to specify <code>location_name</code> or <code>location_code</code></strong><p><code>location_coordinate</code> parameter should be specified in the <em>"latitude,longitude,radius"</em> format<p>the maximum number of decimal digits for <em>"latitude"</em> and <em>"longitude"</em>: 7<p>the minimum value for <em>"radius"</em>: 199.9 (mm)<p>the maximum value for <em>"radius"</em>: 199999 (mm)<p>example:<p><code class="long-string">53.476225,-2.243572,200</code></p>'
        se_domain:
          type: string
          description: '<p><em>search engine domain</em><p>optional field<p>we choose the relevant search engine domain automatically according to the location and language you specify<p>however, you can set a custom search engine domain in this field<p>example:<p><code><em>google.co.uk</em></code>, <code><em>google.com.au</em></code>, <code><em>google.de</em></code>, etc.</p>'
          nullable: true
      example:
        - language_code: en
          location_code: 2840
          keyword: android
    SerpGoogleNewsLiveAdvancedResultInfo:
      type: object
      properties:
        keyword:
          type: string
          description: <em>keyword received in a POST array<br></em><strong>the keyword is returned with decoded %## (plus character '+' will be decoded to a space character)</strong>
          nullable: true
        type:
          type: string
          description: type of element
          nullable: true
        se_domain:
          type: string
          description: <em>search engine domain in a POST array</em>
          nullable: true
        location_code:
          type: integer
          description: <em>location code in a POST array</em>
          nullable: true
        language_code:
          type: string
          description: <em>language code in a POST array</em>
          nullable: true
        check_url:
          type: string
          description: <em>direct URL to search engine results<br></em>you can use it to make sure that we provided accurate results
          nullable: true
        datetime:
          type: string
          description: '<em>date and time when the result was received</em><br>in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”<br>example:<br><code class="long-string">2019-11-15 12:57:46 +00:00</code>'
          nullable: true
        spell:
          type: object
          oneOf:
            - $ref: '#/components/schemas/SpellInfo'
          description: '<em>autocorrection of the search engine</em><br>if the search engine provided results for a keyword that was corrected, we will specify the keyword corrected by the search engine and the type of autocorrection'
          nullable: true
        refinement_chips:
          type: object
          oneOf:
            - $ref: '#/components/schemas/RefinementChipsInfo'
          description: <em>search refinement chips</em>
          nullable: true
        includes_non_news_search_results:
          type: boolean
          description: <em>indicates whether the response contains non-news search results in addition to news content</em>
          nullable: true
        item_types:
          type: array
          items:
            type: string
            nullable: true
          description: '<em>types of search results in SERP</em><br>contains types of search results (<code>items</code>) found in SERP.<br>possible item types:<br><code>top_stories</code>, <code>news_search</code>'
          nullable: true
        se_results_count:
          type: integer
          description: <em> total number of results in SERP</em>
          format: int64
          nullable: true
        items_count:
          type: integer
          description: <em>the number of results returned in the <strong><code>items</code></strong> array</em>
          format: int64
          nullable: true
        items:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/BaseSerpApiGoogleNewsElementItem'
            nullable: true
          description: <em>items of the element</em>
          nullable: true
    SerpGoogleNewsLiveAdvancedTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleNewsLiveAdvancedResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    SerpGoogleNewsLiveAdvancedResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleNewsLiveAdvancedTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    SerpGoogleNewsLiveHtmlRequestInfo:
      type: object
      properties:
        keyword:
          type: string
          description: '<p><em>keyword</em><p><strong>required field</strong><p>you can specify <strong>up to 700 characters</strong> in the <code>keyword</code> field<p>all %## will be decoded (plus character ''+'' will be decoded to a space character)<p>if you need to use the "%" character for your <code>keyword</code>, please specify it as "%25";<p>if you need to use the “+” character for your <code>keyword</code>, please specify it as “%2B”;<p>if this field contains such parameters as <em>''allinanchor:'', ''allintext:'', ''allintitle:'', ''allinurl:'', ''define:'', ''filetype:'', ''id:'', ''inanchor:'', ''info:'', ''intext:'', ''intitle:'', ''inurl:'', ''link:'', ''related:'', ''site:''</em>, <strong>the charge per task will be multiplied by 5</strong><p><strong>Note:</strong> queries containing the ‘cache:’ parameter are not supported and will return a validation error</p><br><p>learn more about rules and limitations of <code>keyword</code> and <code>keywords</code> fields in DataForSEO APIs in this <a href="https://dataforseo.com/help-center/rules-and-limitations-of-keyword-and-keywords-fields-in-dataforseo-apis" rel="noopener noreferrer" target="_blank">Help Center article</a></p>'
        location_code:
          type: integer
          description: '<p><em>search engine location code</em><p><strong>required field if you don''t specify</strong> <code>location_name</code>&nbsp;or <code>location_coordinate</code><p><strong>if you use this field, you don''t need to specify <code>location_name</code> or <code>location_coordinate</code></strong><p>you can receive the list of available locations of the search engines with their <code>location_code</code> by making a separate request to the <code>https://api.dataforseo.com/v3/serp/{{low_se_name}}/locations</code><p>example:<p><code class="long-string">2840</code></p>'
        language_code:
          type: string
          description: '<p><em>search engine language code</em><p><strong>required field if you don''t specify</strong> <code>language_name</code><p><strong>if you use this field, you don''t need to specify <code>language_name</code></strong><p>you can receive the list of available locations of the search engine with their <code>language_code</code>&nbsp;by making a separate request to the <code>https://api.dataforseo.com/v3/serp/{{low_se_name}}/languages</code><em><p></em>example:<em><p></em><code class="long-string">en</code></p>'
        depth:
          type: integer
          description: '<p><em>parsing depth</em><p>optional field<p>number of results in SERP<p>default value: <code>10</code><p>max value: <code>200</code></p><br><strong>Your account will be billed per each SERP containing up to 10 results;</strong><p>Setting depth above 10 may result in additional charges if the search engine returns more than 10 results;<p>If the specified depth is higher than the number of results in the response, the difference will be refunded to your account balance automatically<p>The cost can be calculated on the <a title="Pricing" href="https://dataforseo.com/pricing/serp/google-news-serp-api" target="_blank" rel="noopener noreferrer">Pricing</a> page.'
          nullable: true
        location_name:
          type: string
          description: '<p><em>full name of search engine location</em><p><strong>required field if you don''t specify</strong> <code>location_code</code> or <code>location_coordinate</code><p><strong>if you use this field, you don''t need to specify <code>location_code</code> or <code>location_coordinate</code></strong><p>you can receive the list of available locations of the search engine with their <code>location_name</code> by making a separate request to the <code>https://api.dataforseo.com/v3/serp/{{low_se_name}}/locations</code><p>example:<p><code class="long-string">London,England,United Kingdom</code></p>'
        language_name:
          type: string
          description: '<p><em>full name of search engine language</em><p><strong>required field if you don''t specify</strong> <code>language_code</code><p><strong>if you use this field, you don''t need to specify <code>language_code</code></strong><p>you can receive the list of available locations of the search engine with their <code>language_name</code> by making a separate request to the <code>https://api.dataforseo.com/v3/serp/{{low_se_name}}/languages</code><p>example:<p><code class="long-string">English</code></p>'
        os:
          type: string
          description: '<p><em>device operating system</em><p>optional field<p><strong>note that this API provides results for desktop only</strong><p>choose from the following values: <code>windows</code>, <code>macos</code><p>default value: <code>windows</code></p>'
          nullable: true
        tag:
          type: string
          description: <p><em>user-defined task identifier</em><p>optional field<p><em>the character limit is 255</em><p>you can use this parameter to identify the task and match it with the result<p>you will find the specified <code>tag</code> value in the <code>data</code> object of the response</p>
          nullable: true
        max_crawl_pages:
          type: integer
          description: '<p><em>page crawl limit</em><p>optional field<p>number of search results pages to crawl<p>max value: <code>100</code><p><strong>Note:</strong> the <code>max_crawl_pages</code> and <code>depth</code> parameters complement each other;<p>learn more at <a href="https://dataforseo.com/help-center/what-is-max-crawl-pages-and-how-does-it-work" rel="noopener noreferrer" target="_blank">our help center</a></p>'
          nullable: true
        search_param:
          type: string
          description: <p><em>additional parameters of the search query</em><p>optional field<p><a href="https://dataforseo.com/what-are-google-search-parameters-and-how-to-use-them-with-serp-api.html">get the list of available parameters and additional details here</a></p>
          nullable: true
        url:
          type: string
          description: '<p><em>direct URL of the search query</em><p>optional field<p>you can specify a direct URL and we will sort it out to the necessary fields. Note that this method is the most difficult for our API to process and also requires you to specify the exact language and location in the URL. In most cases, we wouldn’t recommend using this method.<p>example:<p><code class="long-string">https://www.google.co.uk/search?q=%20rank%20tracker%20api&amp;hl=en&amp;gl=GB&amp;uule=w+CAIQIFISCXXeIa8LoNhHEZkq1d1aOpZS</code></p>'
          nullable: true
        location_coordinate:
          type: string
          description: '<p><em>GPS coordinates of a location</em><p><strong>required field if you don''t specify</strong> <code>location_name</code>&nbsp;or <code>location_code</code><p><strong>if you use this field, you don''t need to specify <code>location_name</code> or <code>location_code</code></strong><p><code>location_coordinate</code> parameter should be specified in the <em>"latitude,longitude,radius"</em> format<p>the maximum number of decimal digits for <em>"latitude"</em> and <em>"longitude"</em>: 7<p>the minimum value for <em>"radius"</em>: 199.9 (mm)<p>the maximum value for <em>"radius"</em>: 199999 (mm)<p>example:<p><code class="long-string">53.476225,-2.243572,200</code></p>'
        se_domain:
          type: string
          description: '<p><em>search engine domain</em><p>optional field<p>we choose the relevant search engine domain automatically according to the location and language you specify<p>however, you can set a custom search engine domain in this field<p>example:<p><code><em>google.co.uk</em></code>, <code><em>google.com.au</em></code>, <code><em>google.de</em></code>, etc.</p>'
          nullable: true
      example:
        - language_code: en
          location_code: 2840
          keyword: albert einstein
    SerpGoogleNewsLiveHtmlResultInfo:
      type: object
      properties:
        keyword:
          type: string
          description: <em>keyword received in a POST array<br></em><strong>keyword is returned with decoded %## (plus character '+' will be decoded to a space character)</strong>
          nullable: true
        type:
          type: string
          description: type of element
          nullable: true
        se_domain:
          type: string
          description: <em>search engine domain in a POST array</em>
          nullable: true
        location_code:
          type: integer
          description: <em>location code in a POST array</em>
          nullable: true
        language_code:
          type: string
          description: <em>language code in a POST array</em>
          nullable: true
        datetime:
          type: string
          description: '<em>date and time when the result was received</em><br>in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”<br>example:<br><code class="long-string">2019-11-15 12:57:46 +00:00</code>'
          nullable: true
        items_count:
          type: integer
          description: <em>the number of results returned in the <strong><code>items</code></strong> array</em>
          format: int64
          nullable: true
        items:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/HtmlItemInfo'
            nullable: true
          description: <em>elements of search results found in SERP</em>
          nullable: true
    SerpGoogleNewsLiveHtmlTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleNewsLiveHtmlResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    SerpGoogleNewsLiveHtmlResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleNewsLiveHtmlTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    SerpGoogleImagesTaskPostRequestInfo:
      type: object
      properties:
        keyword:
          type: string
          description: '<p><em>keyword</em><p><strong>required field</strong><p>you can specify <strong>up to 700 characters</strong> in the <code>keyword</code> field<p>all %## will be decoded (plus character ‘+’ will be decoded to a space character)<p>if you need to use the “%” character for your <code>keyword</code>, please specify it as “%25”;<p>if you need to use the “+” character for your <code>keyword</code>, please specify it as “%2B”;<p>if this field contains such parameters as <em>‘allinanchor:’, ‘allintext:’, ‘allintitle:’, ‘allinurl:’, ‘define:’, ‘filetype:’, ‘id:’, ‘inanchor:’, ‘info:’, ‘intext:’, ‘intitle:’, ‘inurl:’, ‘link:’, ‘related:’, ‘site:’</em>, <strong>the charge per task will be multiplied by 5</strong><p><strong>Note:</strong> queries containing the ‘cache:’ parameter are not supported and will return a validation error</p><br><p>learn more about rules and limitations of <code>keyword</code> and <code>keywords</code> fields in DataForSEO APIs in this <a href="https://dataforseo.com/help-center/rules-and-limitations-of-keyword-and-keywords-fields-in-dataforseo-apis" rel="noopener noreferrer" target="_blank">Help Center article</a></p>'
        location_code:
          type: integer
          description: '<p><em>search engine location code</em><p><strong>required field if you don''t specify</strong> <code>location_name</code>&nbsp;or <code>location_coordinate</code><p><strong>if you use this field, you don''t need to specify <code>location_name</code> or <code>location_coordinate</code></strong><p>you can receive the list of available locations of the search engines with their <code>location_code</code> by making a separate request to the <code>https://api.dataforseo.com/v3/serp/{{low_se_name}}/locations</code><p>example:<p><code class="long-string">2840</code></p>'
        language_code:
          type: string
          description: '<p><em>search engine language code</em><p><strong>required field if you don''t specify</strong> <code>language_name</code><p><strong>if you use this field, you don''t need to specify <code>language_name</code></strong><p>you can receive the list of available languages of the search engine with their <code>language_code</code>&nbsp;by making a separate request to the <code>https://api.dataforseo.com/v3/serp/{{low_se_name}}/languages</code><em><p></em>example:<em><p></em><code class="long-string">en</code></p>'
        depth:
          type: integer
          description: '<p><em>parsing depth</em><p>optional field<p>number of results in SERP<p>default value: <code>100</code><p>max value: <code>700</code></p><br><strong>Your account will be billed per each SERP containing up to 100 results;</strong><p>Setting depth above 100 may result in additional charges if the search engine returns more than 100 results;<p>If the specified depth is higher than the number of results in the response, the difference will be refunded to your account balance automatically;<p>The cost can be calculated on the <a title="Pricing" href="https://dataforseo.com/pricing/serp/google-images-serp-api" target="_blank" rel="noopener noreferrer">Pricing</a> page.'
          nullable: true
        priority:
          type: integer
          description: <p><em>task priority</em><p>optional field<p>can take the following values:<p>1 – normal execution priority (set by default)<p>2 – high execution priority</p><br>You will be additionally charged for the tasks with high execution priority.<p>The cost can be calculated on the <a title="Pricing" href="https://dataforseo.com/pricing/serp/google-images-serp-api" target="_blank" rel="noopener noreferrer">Pricing</a> page.
          nullable: true
        pingback_url:
          type: string
          description: '<p><em>notification URL of a completed task</em><p>optional field<p>when a task is completed we will notify you by GET request sent to the URL you have specified<p>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<p>example:<p><code>http://your-server.com/pingscript?id=$id</code><p><code>http://your-server.com/pingscript?id=$id&amp;tag=$tag</code><p><strong>Note:</strong> special characters in <code>pingback_url</code> will be urlencoded;<p>i.a., the <code>#</code> character will be encoded into <code>%23</code></p><br><p>learn more on our <a href="https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api" target="_blank" rel="noopener noreferrer">Help Center</a></p>'
          nullable: true
        postback_url:
          type: string
          description: '<p><em>URL for sending task results</em><p>optional field<p>once the task is completed, we will send a POST request with its results compressed in the <code>gzip</code> format to the <code>postback_url</code> you specified<p>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<p>example:<p><code>http://your-server.com/postbackscript?id=$id</code><p><code>http://your-server.com/postbackscript?id=$id&amp;tag=$tag</code><p><strong>Note:</strong> special characters in <code>postback_url</code> will be urlencoded;<p>i.a., the <code>#</code> character will be encoded into <code>%23</code></p><br><p>learn more on our <a href="https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api" target="_blank" rel="noopener noreferrer">Help Center</a></p>'
          nullable: true
        postback_data:
          type: string
          description: '<p><em>postback_url datatype</em><p><strong>required field if you specify <code>postback_url</code></strong><p>corresponds to the datatype that will be sent to your server<p>possible values:<p><code>advanced</code>, <code>html</code></p>'
        location_name:
          type: string
          description: '<p><em>full name of search engine location</em><p><strong>required field if you don''t specify</strong> <code>location_code</code> or <code>location_coordinate</code><p><strong>if you use this field, you don''t need to specify <code>location_code</code> or <code>location_coordinate</code></strong><p>you can receive the list of available locations of the search engine with their <code>location_name</code> by making a separate request to the <code>https://api.dataforseo.com/v3/serp/{{low_se_name}}/locations</code><p>example:<p><code class="long-string">London,England,United Kingdom</code></p>'
        language_name:
          type: string
          description: '<p><em>full name of search engine language</em><p><strong>required field if you don''t specify</strong> <code>language_code</code><p><strong>if you use this field, you don''t need to specify <code>language_code</code></strong><p>you can receive the list of available languages of the search engine with their <code>language_name</code> by making a separate request to the <code>https://api.dataforseo.com/v3/serp/{{low_se_name}}/languages</code><p>example:<p><code class="long-string">English</code></p>'
        os:
          type: string
          description: '<p><em>device operating system</em><p>optional field<p><strong>note that this API provides results for desktop only</strong><p>choose from the following values: <code>windows</code>, <code>macos</code><p>default value: <code>windows</code></p>'
          nullable: true
        tag:
          type: string
          description: <p><em>user-defined task identifier</em><p>optional field<p><em>the character limit is 255</em><p>you can use this parameter to identify the task and match it with the result<p>you will find the specified <code>tag</code> value in the <code>data</code> object of the response</p>
          nullable: true
        max_crawl_pages:
          type: integer
          description: '<p><em>page crawl limit</em><p>optional field<p>number of search results pages to crawl<p>max value: <code>100</code><p><strong>Note:</strong> the <code>max_crawl_pages</code> and <code>depth</code> parameters complement each other;<p>learn more at <a href="https://dataforseo.com/help-center/what-is-max-crawl-pages-and-how-does-it-work" target="_blank" rel="noopener noreferrer">our help center</a></p>'
          nullable: true
        search_param:
          type: string
          description: <p><em>additional parameters of the search query</em><p>optional field<p><a href="https://dataforseo.com/help-center/google-search-engine-parameters-and-how-to-use-them">get the list of available parameters and additional details here</a></p>
          nullable: true
        url:
          type: string
          description: '<p><em>direct URL of the search query</em><p>optional field<p>you can specify a direct URL and we will sort it out to the necessary fields. Note that this method is the most difficult for our API to process and also requires you to specify the exact language and location in the URL. In most cases, we wouldn’t recommend using this method.<p>example:<p><code class="long-string">https://www.google.co.uk/search?q=%20rank%20tracker%20api&amp;hl=en&amp;gl=GB&amp;uule=w+CAIQIFISCXXeIa8LoNhHEZkq1d1aOpZS</code></p>'
          nullable: true
        location_coordinate:
          type: string
          description: '<p><em>GPS coordinates of a location</em><p><strong>required field if you don''t specify</strong> <code>location_name</code>&nbsp;or <code>location_code</code><p><strong>if you use this field, you don''t need to specify <code>location_name</code> or <code>location_code</code></strong><p><code>location_coordinate</code> parameter should be specified in the <em>"latitude,longitude,radius"</em> format<p>the maximum number of decimal digits for <em>"latitude"</em> and <em>"longitude"</em>: 7<p>the minimum value for <em>"radius"</em>: 199.9 (mm)<p>the maximum value for <em>"radius"</em>: 199999 (mm)<p>example:<p><code class="long-string">53.476225,-2.243572,200</code></p>'
        se_domain:
          type: string
          description: '<p><em>search engine domain</em><p>optional field<p>we choose the relevant search engine domain automatically according to the location and language you specify<p>however, you can set a custom search engine domain in this field<p>example:<p><code><code></code></code><em>google.co.uk</em>, <code><code></code></code><em>google.com.au</em>, <code><code></code></code><em>google.de</em>, etc.</p>'
          nullable: true
      example:
        - language_code: en
          location_code: 2840
          keyword: albert einstein
    SerpGoogleImagesTaskPostTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: object
              description: '<em>array of results</em><br>in this case, the value will be <code>null</code>'
              nullable: true
    SerpGoogleImagesTaskPostResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleImagesTaskPostTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    SerpGoogleImagesTasksReadyResultInfo:
      type: object
      properties:
        id:
          type: string
          description: <em>task identifier of the completed task</em><br><strong>unique task identifier in our system in the <a href="https://en.wikipedia.org/wiki/Universally_unique_identifier">UUID</a> format</strong>
          nullable: true
        se:
          type: string
          description: <em>search engine specified when setting the task</em>
          nullable: true
        se_type:
          type: string
          description: '<em>type of search engine</em><br>example: <code>{{low_se_type_under}}</code>'
          nullable: true
        date_posted:
          type: string
          description: <em>date when the task was posted (in the UTC format)</em>
          nullable: true
        tag:
          type: string
          description: <em>user-defined task identifier</em>
          nullable: true
        endpoint_regular:
          type: string
          description: '<em>URL for collecting the results of the SERP Regular task</em><br>if SERP Regular is not supported in the specified endpoint, the value will be <code>null</code>'
          nullable: true
        endpoint_advanced:
          type: string
          description: '<em>URL for collecting the results of the SERP Advanced task</em><br>if SERP Advanced is not supported in the specified endpoint, the value will be <code>null</code>'
          nullable: true
        endpoint_html:
          type: string
          description: '<em>URL for collecting the results of the SERP HTML task</em><br>if SERP HTML is not supported in the specified endpoint, the value will be <code>null</code>'
          nullable: true
    SerpGoogleImagesTasksReadyTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleImagesTasksReadyResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    SerpGoogleImagesTasksReadyResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleImagesTasksReadyTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    SerpGoogleImagesTasksFixedResultInfo:
      type: object
      properties:
        id:
          type: string
          description: <em>task identifier of the completed task</em><br><strong>unique task identifier in our system in the <a href="https://en.wikipedia.org/wiki/Universally_unique_identifier">UUID</a> format</strong>
          nullable: true
        se:
          type: string
          description: <em>search engine specified when setting the task</em>
          nullable: true
        se_type:
          type: string
          description: '<em>type of search engine</em><br>can take the following values: <code>{{low_se_type_under}}</code>'
          nullable: true
        date_posted:
          type: string
          nullable: true
        tag:
          type: string
          description: <em>user-defined task identifier</em>
          nullable: true
        endpoint_regular:
          type: string
          description: '<em>URL for collecting the results of the SERP Regular task</em><br>if SERP Regular is not supported in the specified endpoint, the value will be <code>null</code>'
          nullable: true
        endpoint_advanced:
          type: string
          description: '<em>URL for collecting the results of the SERP Advanced task</em><br>if SERP Advanced is not supported in the specified endpoint, the value will be <code>null</code>'
          nullable: true
        endpoint_html:
          type: string
          description: '<em>URL for collecting the results of the SERP HTML task</em><br>if SERP HTML is not supported in the specified endpoint, the value will be <code>null</code>'
          nullable: true
    SerpGoogleImagesTasksFixedTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleImagesTasksFixedResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    SerpGoogleImagesTasksFixedResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleImagesTasksFixedTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    SerpApiGoogleImagesCarouselElementItem:
      type: object
      allOf:
        - type: object
          oneOf:
            - $ref: '#/components/schemas/BaseSerpApiGoogleImagesElementItem'
          nullable: true
        - type: object
          properties:
            page:
              type: integer
              nullable: true
            position:
              type: string
              description: '<em>the alignment of the element in SERP</em><br>can take the following values:<br><code>left</code>, <code>right</code>'
              nullable: true
            title:
              type: string
              description: <em>title of the element</em>
              nullable: true
            items:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpApiCarouselElement'
                nullable: true
              description: <em>items of the element</em>
              nullable: true
            rectangle:
              type: object
              oneOf:
                - $ref: '#/components/schemas/AiModeRectangleInfo'
              description: '<em>rectangle parameters</em><br>contains cartesian coordinates and pixel dimensions of the result’s snippet in SERP<br><strong>note: </strong>calculate_rectangles parameter is not yet available when setting tasks for this search engine type, that’s why <code>rectangle</code> always equals <code>null</code>'
              nullable: true
    SerpApiGoogleImagesImagesSearchElementItem:
      type: object
      allOf:
        - type: object
          oneOf:
            - $ref: '#/components/schemas/BaseSerpApiGoogleImagesElementItem'
          nullable: true
        - type: object
          properties:
            title:
              type: string
              description: <em>title of the result in SERP</em>
              nullable: true
            subtitle:
              type: string
              description: <em>subtitle of the result in SERP</em>
              nullable: true
            alt:
              type: string
              description: <em>the alt tag of the image</em>
              nullable: true
            url:
              type: string
              description: <em>search URL with refinement parameters</em>
              nullable: true
            source_url:
              type: string
              description: <em>the URL of the source image</em>
              nullable: true
            encoded_url:
              type: string
              description: <em>the URL of the cached version of the image stored on Google's servers</em>
              nullable: true
    SerpApiGoogleImagesRelatedSearchesElementItem:
      type: object
      allOf:
        - type: object
          oneOf:
            - $ref: '#/components/schemas/BaseSerpApiGoogleImagesElementItem'
          nullable: true
        - type: object
          properties:
            page:
              type: integer
              nullable: true
            position:
              type: string
              description: '<em>the alignment of the element in SERP</em><br>can take the following values:<br><code>left</code>, <code>right</code>'
              nullable: true
            items:
              type: array
              items:
                type: string
                nullable: true
              description: <em>items of the element</em>
              nullable: true
            rectangle:
              type: object
              oneOf:
                - $ref: '#/components/schemas/AiModeRectangleInfo'
              description: '<em>rectangle parameters</em><br>contains cartesian coordinates and pixel dimensions of the result’s snippet in SERP<br><strong>note: </strong>calculate_rectangles parameter is not yet available when setting tasks for this search engine type, that’s why <code>rectangle</code> always equals <code>null</code>'
              nullable: true
    SerpGoogleImagesTaskGetAdvancedResultInfo:
      type: object
      properties:
        keyword:
          type: string
          description: <em>keyword received in a POST array<br></em><strong>the keyword is returned with decoded %## (plus symbol '+' will be decoded to a space character)</strong>
          nullable: true
        type:
          type: string
          description: type of element
          nullable: true
        se_domain:
          type: string
          description: <em>search engine domain in a POST array</em>
          nullable: true
        location_code:
          type: integer
          description: <em>location code in a POST array</em>
          nullable: true
        language_code:
          type: string
          description: <em>language code in a POST array</em>
          nullable: true
        check_url:
          type: string
          description: <em>direct URL to search engine results<br></em>you can use it to make sure that we provided accurate results
          nullable: true
        datetime:
          type: string
          description: '<em>date and time when the result was received</em><br>in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”<br>example:<br><code class="long-string">2019-11-15 12:57:46 +00:00</code>'
          nullable: true
        spell:
          type: object
          oneOf:
            - $ref: '#/components/schemas/SpellInfo'
          description: '<em>autocorrection of the search engine</em><br>if the search engine provided results for a keyword that was corrected, we will specify the keyword corrected by the search engine and the type of autocorrection'
          nullable: true
        refinement_chips:
          type: object
          oneOf:
            - $ref: '#/components/schemas/RefinementChipsInfo'
          description: <em>search refinement chips</em>
          nullable: true
        item_types:
          type: array
          items:
            type: string
            nullable: true
          description: '<em>types of search results in SERP</em><br>contains types of search results (<code>items</code>) found in SERP.<br>possible item types:<br><code>carousel</code>, <code>images_search</code>, <code>related_searches</code>'
          nullable: true
        se_results_count:
          type: integer
          description: <em> total number of results in SERP</em>
          format: int64
          nullable: true
        items_count:
          type: integer
          description: <em>the number of results returned in the <strong><code>items</code></strong> array</em>
          format: int64
          nullable: true
        items:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/BaseSerpApiGoogleImagesElementItem'
            nullable: true
          description: <em>elements of search results found in SERP</em>
          nullable: true
    SerpGoogleImagesTaskGetAdvancedTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleImagesTaskGetAdvancedResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    SerpGoogleImagesTaskGetAdvancedResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleImagesTaskGetAdvancedTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    SerpGoogleImagesTaskGetHtmlResultInfo:
      type: object
      properties:
        keyword:
          type: string
          description: <em>keyword received in a POST array<br></em><strong>keyword is returned with decoded %## (plus symbol '+' will be decoded to a space character)</strong>
          nullable: true
        type:
          type: string
          description: type of element
          nullable: true
        se_domain:
          type: string
          description: <em>search engine domain in a POST array</em>
          nullable: true
        location_code:
          type: integer
          description: <em>location code in a POST array</em>
          nullable: true
        language_code:
          type: string
          description: <em>language code in a POST array</em>
          nullable: true
        datetime:
          type: string
          description: '<em>date and time when the result was received</em><br>in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”<br>example:<br><code class="long-string">2019-11-15 12:57:46 +00:00</code>'
          nullable: true
        items_count:
          type: integer
          description: <em>the number of results returned in the <strong><code>items</code></strong> array</em>
          format: int64
          nullable: true
        items:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/HtmlItemInfo'
            nullable: true
          description: <em>elements of search results found in SERP</em>
          nullable: true
    SerpGoogleImagesTaskGetHtmlTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleImagesTaskGetHtmlResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    SerpGoogleImagesTaskGetHtmlResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleImagesTaskGetHtmlTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    SerpGoogleImagesLiveAdvancedRequestInfo:
      type: object
      properties:
        keyword:
          type: string
          description: '<p><em>keyword</em><p><strong>required field</strong><p>you can specify <strong>up to 700 characters</strong> in the <code>keyword</code> field<p>all %## will be decoded (plus character ''+'' will be decoded to a space character)<p>if you need to use the "%" character for your <code>keyword</code>, please specify it as "%25";<p>if you need to use the “+” character for your <code>keyword</code>, please specify it as “%2B”;<p>if this field contains such parameters as <em>''allinanchor:'', ''allintext:'', ''allintitle:'', ''allinurl:'', ''define:'', ''filetype:'', ''id:'', ''inanchor:'', ''info:'', ''intext:'', ''intitle:'', ''inurl:'', ''link:'', ''related:'', ''site:''</em>, <strong>the charge per task will be multiplied by 5</strong><p><strong>Note:</strong> queries containing the ‘cache:’ parameter are not supported and will return a validation error</p><br><p>learn more about rules and limitations of <code>keyword</code> and <code>keywords</code> fields in DataForSEO APIs in this <a href="https://dataforseo.com/help-center/rules-and-limitations-of-keyword-and-keywords-fields-in-dataforseo-apis" rel="noopener noreferrer" target="_blank">Help Center article</a></p>'
        location_code:
          type: integer
          description: '<p><em>search engine location code</em><p><strong>required field if you don''t specify</strong> <code>location_name</code>&nbsp;or <code>location_coordinate</code><p><strong>if you use this field, you don''t need to specify <code>location_name</code> or <code>location_coordinate</code></strong><p>you can receive the list of available locations of the search engines with their <code>location_code</code> by making a separate request to the <code>https://api.dataforseo.com/v3/serp/google/locations</code><p>example:<p><code class="long-string">2840</code></p>'
        language_code:
          type: string
          description: '<p><em>search engine language code</em><p><strong>required field if you don''t specify</strong> <code>language_name</code><p><strong>if you use this field, you don''t need to specify <code>language_name</code></strong><p>you can receive the list of available languages of the search engine with their <code>language_code</code>&nbsp;by making a separate request to the <code>https://api.dataforseo.com/v3/serp/google/languages</code><em><p></em>example:<em><p></em><code class="long-string">en</code></p>'
        depth:
          type: integer
          description: '<p><em>parsing depth</em><p>optional field<p>number of results in SERP<p>default value: <code>100</code><p>max value: <code>200</code></p><br><strong>Your account will be billed per each SERP containing up to 100 results;</strong><p>Setting depth above 100 may result in additional charges if the search engine returns more than 100 results;<p>If the specified depth is higher than the number of results in the response, the difference will be refunded to your account balance automatically;<p>The cost can be calculated on the <a title="Pricing" href="https://dataforseo.com/pricing/serp/google-images-serp-api" target="_blank" rel="noopener noreferrer">Pricing</a> page.'
          nullable: true
        location_name:
          type: string
          description: '<p><em>full name of search engine location</em><p><strong>required field if you don''t specify</strong> <code>location_code</code> or <code>location_coordinate</code><p><strong>if you use this field, you don''t need to specify <code>location_code</code> or <code>location_coordinate</code></strong><p>you can receive the list of available locations of the search engine with their <code>location_name</code> by making a separate request to the <code>https://api.dataforseo.com/v3/serp/google/locations</code><p>example:<p><code class="long-string">London,England,United Kingdom</code></p>'
        language_name:
          type: string
          description: '<p><em>full name of search engine language</em><p><strong>required field if you don''t specify</strong> <code>language_code</code><p><strong>if you use this field, you don''t need to specify <code>language_code</code></strong><p>you can receive the list of available languages of the search engine with their <code>language_name</code> by making a separate request to the <code>https://api.dataforseo.com/v3/serp/google/languages</code><p>example:<p><code class="long-string">English</code></p>'
        os:
          type: string
          description: '<p><em>device operating system</em><p>optional field<p><strong>note that this API provides results for desktop only</strong><p>choose from the following values: <code>windows</code>, <code>macos</code><p>default value: <code>windows</code></p>'
          nullable: true
        tag:
          type: string
          description: <p><em>user-defined task identifier</em><p>optional field<p><em>the character limit is 255</em><p>you can use this parameter to identify the task and match it with the result<p>you will find the specified <code>tag</code> value in the <code>data</code> object of the response</p>
          nullable: true
        max_crawl_pages:
          type: integer
          description: '<p><em>page crawl limit</em><p>optional field<p>number of search results pages to crawl<p>max value: <code>100</code><p><strong>Note:</strong> the <code>max_crawl_pages</code> and <code>depth</code> parameters complement each other;<p>learn more at <a href="https://dataforseo.com/help-center/what-is-max-crawl-pages-and-how-does-it-work" rel="noopener noreferrer" target="_blank">our help center</a></p>'
          nullable: true
        search_param:
          type: string
          description: <p><em>additional parameters of the search query</em><p>optional field<p><a href="https://dataforseo.com/what-are-google-search-parameters-and-how-to-use-them-with-serp-api.html">Get the list of available parameters and additional details here.</a></p>
          nullable: true
        url:
          type: string
          description: '<p><em>direct URL of the search query</em><p>optional field<p>you can specify a direct URL and we will sort it out to the necessary fields. Note that this method is the most difficult for our API to process and also requires you to specify the exact language and location in the URL. In most cases, we wouldn’t recommend using this method.<p>example:<p><code class="long-string">https://www.google.co.uk/search?q=%20rank%20tracker%20api&amp;hl=en&amp;gl=GB&amp;uule=w+CAIQIFISCXXeIa8LoNhHEZkq1d1aOpZS</code></p>'
          nullable: true
        location_coordinate:
          type: string
          description: '<p><em>GPS coordinates of a location</em><p><strong>required field if you don''t specify</strong> <code>location_name</code>&nbsp;or <code>location_code</code><p><strong>if you use this field, you don''t need to specify <code>location_name</code> or <code>location_code</code></strong><p><code>location_coordinate</code> parameter should be specified in the <em>"latitude,longitude,radius"</em> format<p>the maximum number of decimal digits for <em>"latitude"</em> and <em>"longitude"</em>: 7<p>the minimum value for <em>"radius"</em>: 199.9 (mm)<p>the maximum value for <em>"radius"</em>: 199999 (mm)<p>example:<p><code class="long-string">53.476225,-2.243572,200</code></p>'
        se_domain:
          type: string
          description: '<p><em>search engine domain</em><p>optional field<p>We choose the relevant search engine domain automatically according to the location and language you specify. However, you can set a custom search engine domain in this field<p>example:<p><code><code></code></code><em>google.co.uk</em>, <code><code></code></code><em>google.com.au</em>, <code><code></code></code><em>google.de</em>, etc.</p>'
          nullable: true
      example:
        - language_code: en
          location_code: 2840
          keyword: albert einstein
    SerpGoogleImagesLiveAdvancedResultInfo:
      type: object
      properties:
        keyword:
          type: string
          description: <em>keyword received in a POST array<br></em><strong>the keyword is returned with decoded %## (plus character '+' will be decoded to a space character)</strong>
          nullable: true
        type:
          type: string
          description: type of element
          nullable: true
        se_domain:
          type: string
          description: <em>search engine domain in a POST array</em>
          nullable: true
        location_code:
          type: integer
          description: <em>location code in a POST array</em>
          nullable: true
        language_code:
          type: string
          description: <em>language code in a POST array</em>
          nullable: true
        check_url:
          type: string
          description: <em>direct URL to search engine results<br></em>you can use it to make sure that we provided accurate results
          nullable: true
        datetime:
          type: string
          description: '<em>date and time when the result was received</em><br>in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”<br>example:<br><code class="long-string">2019-11-15 12:57:46 +00:00</code>'
          nullable: true
        spell:
          type: object
          oneOf:
            - $ref: '#/components/schemas/SpellInfo'
          description: '<em>autocorrection of the search engine</em><br>if the search engine provided results for a keyword that was corrected, we will specify the keyword corrected by the search engine and the type of autocorrection'
          nullable: true
        refinement_chips:
          type: object
          oneOf:
            - $ref: '#/components/schemas/RefinementChipsInfo'
          description: <em>search refinement chips</em>
          nullable: true
        item_types:
          type: array
          items:
            type: string
            nullable: true
          description: '<em>types of search results in SERP</em><br>contains types of search results (<code>items</code>) found in SERP.<br>possible item types:<br><code>carousel</code>, <code>images_search</code>, <code>related_searches</code>'
          nullable: true
        se_results_count:
          type: integer
          description: <em> total number of results in SERP</em>
          format: int64
          nullable: true
        items_count:
          type: integer
          description: <em>the number of results returned in the <strong><code>items</code></strong> array</em>
          format: int64
          nullable: true
        items:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/BaseSerpApiGoogleImagesElementItem'
            nullable: true
          description: <em>items of the element</em>
          nullable: true
    SerpGoogleImagesLiveAdvancedTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleImagesLiveAdvancedResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    SerpGoogleImagesLiveAdvancedResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleImagesLiveAdvancedTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    SerpGoogleImagesLiveHtmlRequestInfo:
      type: object
      properties:
        keyword:
          type: string
          description: '<p><em>keyword</em><p><strong>required field</strong><p>you can specify <strong>up to 700 characters</strong> in the <code>keyword</code> field<p>all %## will be decoded (plus character ''+'' will be decoded to a space character)<p>if you need to use the "%" character for your <code>keyword</code>, please specify it as "%25";<p>if you need to use the “+” character for your <code>keyword</code>, please specify it as “%2B”;<p>if this field contains such parameters as <em>''allinanchor:'', ''allintext:'', ''allintitle:'', ''allinurl:'', ''define:'', ''filetype:'', ''id:'', ''inanchor:'', ''info:'', ''intext:'', ''intitle:'', ''inurl:'', ''link:'', ''related:'', ''site:''</em>, <strong>the charge per task will be multiplied by 5</strong><p><strong>Note:</strong> queries containing the ‘cache:’ parameter are not supported and will return a validation error</p><br><p>learn more about rules and limitations of <code>keyword</code> and <code>keywords</code> fields in DataForSEO APIs in this <a href="https://dataforseo.com/help-center/rules-and-limitations-of-keyword-and-keywords-fields-in-dataforseo-apis" rel="noopener noreferrer" target="_blank">Help Center article</a></p>'
        location_code:
          type: integer
          description: '<p><em>search engine location code</em><p><strong>required field if you don''t specify</strong> <code>location_name</code>&nbsp;or <code>location_coordinate</code><p><strong>if you use this field, you don''t need to specify <code>location_name</code> or <code>location_coordinate</code></strong><p>you can receive the list of available locations of the search engines with their <code>location_code</code> by making a separate request to the <code>https://api.dataforseo.com/v3/serp/google/locations</code><p>example:<p><code class="long-string">2840</code></p>'
        language_code:
          type: string
          description: '<p><em>search engine language code</em><p><strong>required field if you don''t specify</strong> <code>language_name</code><p><strong>if you use this field, you don''t need to specify <code>language_name</code></strong><p>you can receive the list of available languages of the search engine with their <code>language_code</code>&nbsp;by making a separate request to the <code>https://api.dataforseo.com/v3/serp/google/languages</code><em><p></em>example:<em><p></em><code class="long-string">en</code></p>'
        depth:
          type: integer
          description: '<p><em>parsing depth</em><p>optional field<p>number of results in SERP<p>default value: <code>100</code><p>max value: <code>200</code></p><br><strong>Your account will be billed per each SERP containing up to 100 results;</strong><p>Setting depth above 100 may result in additional charges if the search engine returns more than 100 results;<p>If the specified depth is higher than the number of results in the response, the difference will be refunded to your account balance automatically;<p>The cost can be calculated on the <a title="Pricing" href="https://dataforseo.com/pricing/serp/google-images-serp-api" target="_blank" rel="noopener noreferrer">Pricing</a> page.'
          nullable: true
        location_name:
          type: string
          description: '<p><em>full name of search engine location</em><p><strong>required field if you don''t specify</strong> <code>location_code</code> or <code>location_coordinate</code><p><strong>if you use this field, you don''t need to specify <code>location_code</code> or <code>location_coordinate</code></strong><p>you can receive the list of available locations of the search engine with their <code>location_name</code> by making a separate request to the <code>https://api.dataforseo.com/v3/serp/google/locations</code><p>example:<p><code class="long-string">London,England,United Kingdom</code></p>'
        language_name:
          type: string
          description: '<p><em>full name of search engine language</em><p><strong>required field if you don''t specify</strong> <code>language_code</code><p><strong>if you use this field, you don''t need to specify <code>language_code</code></strong><p>you can receive the list of available languages of the search engine with their <code>language_name</code> by making a separate request to the <code>https://api.dataforseo.com/v3/serp/google/languages</code><p>example:<p><code class="long-string">English</code></p>'
        os:
          type: string
          description: '<p><em>device operating system</em><p>optional field<p><strong>note that this API provides results for desktop only</strong><p>choose from the following values: <code>windows</code>, <code>macos</code><p>default value: <code>windows</code></p>'
          nullable: true
        tag:
          type: string
          description: <p><em>user-defined task identifier</em><p>optional field<p><em>the character limit is 255</em><p>you can use this parameter to identify the task and match it with the result<p>you will find the specified <code>tag</code> value in the <code>data</code> object of the response</p>
          nullable: true
        max_crawl_pages:
          type: integer
          description: '<p><em>page crawl limit</em><p>optional field<p>number of search results pages to crawl<p>max value: <code>100</code><p><strong>Note:</strong> the <code>max_crawl_pages</code> and <code>depth</code> parameters complement each other;<p>learn more at <a href="https://dataforseo.com/help-center/what-is-max-crawl-pages-and-how-does-it-work" rel="noopener noreferrer" target="_blank">our help center</a></p>'
          nullable: true
        search_param:
          type: string
          description: <p><em>additional parameters of the search query</em><p>optional field<p><a href="https://dataforseo.com/help-center/google-search-engine-parameters-and-how-to-use-them">get the list of available parameters and additional details here</a></p>
          nullable: true
        url:
          type: string
          description: '<p><em>direct URL of the search query</em><p>optional field<p>you can specify a direct URL and we will sort it out to the necessary fields. Note that this method is the most difficult for our API to process and also requires you to specify the exact language and location in the URL. In most cases, we wouldn’t recommend using this method.<p>example:<p><code class="long-string">https://www.google.co.uk/search?q=%20rank%20tracker%20api&amp;hl=en&amp;gl=GB&amp;uule=w+CAIQIFISCXXeIa8LoNhHEZkq1d1aOpZS</code></p>'
          nullable: true
        location_coordinate:
          type: string
          description: '<p><em>GPS coordinates of a location</em><p><strong>required field if you don''t specify</strong> <code>location_name</code>&nbsp;or <code>location_code</code><p><strong>if you use this field, you don''t need to specify <code>location_name</code> or <code>location_code</code></strong><p><code>location_coordinate</code> parameter should be specified in the <em>"latitude,longitude,radius"</em> format<p>the maximum number of decimal digits for <em>"latitude"</em> and <em>"longitude"</em>: 7<p>the minimum value for <em>"radius"</em>: 199.9 (mm)<p>the maximum value for <em>"radius"</em>: 199999 (mm)<p>example:<p><code class="long-string">53.476225,-2.243572,200</code></p>'
        se_domain:
          type: string
          description: '<p><em>search engine domain</em><p>optional field<p>we choose the relevant search engine domain automatically according to the location and language you specify<p>however, you can set a custom search engine domain in this field<p>example:<p><code><code></code></code><em>google.co.uk</em>, <code><code></code></code><em>google.com.au</em>, <code><code></code></code><em>google.de</em>, etc.</p>'
          nullable: true
      example:
        - language_code: en
          location_code: 2840
          keyword: albert einstein
    SerpGoogleImagesLiveHtmlResultInfo:
      type: object
      properties:
        keyword:
          type: string
          description: <em>keyword received in a POST array<br></em><strong>keyword is returned with decoded %## (plus character '+' will be decoded to a space character)</strong>
          nullable: true
        type:
          type: string
          description: type of element
          nullable: true
        se_domain:
          type: string
          description: <em>search engine domain in a POST array</em>
          nullable: true
        location_code:
          type: integer
          description: <em>location code in a POST array</em>
          nullable: true
        language_code:
          type: string
          description: <em>language code in a POST array</em>
          nullable: true
        datetime:
          type: string
          description: '<em>date and time when the result was received</em><br>in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”<br>example:<br><code class="long-string">2019-11-15 12:57:46 +00:00</code>'
          nullable: true
        items_count:
          type: integer
          description: <em>the number of results returned in the <strong><code>items</code></strong> array</em>
          format: int64
          nullable: true
        items:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/HtmlItemInfo'
            nullable: true
          description: <em>elements of search results found in SERP</em>
          nullable: true
    SerpGoogleImagesLiveHtmlTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleImagesLiveHtmlResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    SerpGoogleImagesLiveHtmlResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleImagesLiveHtmlTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    SerpGoogleSearchByImageTaskPostRequestInfo:
      type: object
      properties:
        image_url:
          type: string
          description: <p><em>URL of the image</em><p><strong>required field</strong><p>the results will be based on the image you specified in this field<p>example:<p><code class="long-string">https://upload.wikimedia.org/wikipedia/commons/e/ed/Elon_Musk_Royal_Society.jpg</code></p>
        location_code:
          type: integer
          description: '<p><em>search engine location code</em><p><strong>required field if you don''t specify</strong> <code>location_name</code>&nbsp;or <code>location_coordinate</code><p><strong>if you use this field, you don''t need to specify <code>location_name</code> or <code>location_coordinate</code></strong><p>you can receive the list of available locations of the search engines with their <code>location_code</code> by making a separate request to the <code>https://api.dataforseo.com/v3/serp/{{low_se_name}}/locations</code><p>example:<p><code class="long-string">2840</code></p>'
        language_code:
          type: string
          description: '<p><em>search engine language code</em><p><strong>required field if you don''t specify</strong> <code>language_name</code><p><strong>if you use this field, you don''t need to specify <code>language_name</code></strong><p>you can receive the list of available languages of the search engine with their <code>language_code</code>&nbsp;by making a separate request to the <code>https://api.dataforseo.com/v3/serp/{{low_se_name}}/languages</code><em><p></em>example:<em><p></em><code class="long-string">en</code></p>'
        pingback_url:
          type: string
          description: '<p><em>notification URL of a completed task</em><p>optional field<p>when a task is completed we will notify you by GET request sent to the URL you have specified<p>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<p>example:<p><code>http://your-server.com/pingscript?id=$id</code><p><code>http://your-server.com/pingscript?id=$id&amp;tag=$tag</code><p><strong>Note:</strong> special characters in <code>pingback_url</code> will be urlencoded;<p>i.a., the <code>#</code> character will be encoded into <code>%23</code></p><br><p>learn more on our <a href="https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api" target="_blank" rel="noopener noreferrer">Help Center</a></p>'
          nullable: true
        postback_url:
          type: string
          description: '<p><em>URL for sending task results</em><p>optional field<p>once the task is completed, we will send a POST request with its results compressed in the <code>gzip</code> format to the <code>postback_url</code> you specified<p>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<p>example:<p><code>http://your-server.com/postbackscript?id=$id</code><p><code>http://your-server.com/postbackscript?id=$id&amp;tag=$tag</code><p><strong>Note:</strong> special characters in <code>postback_url</code> will be urlencoded;<p>i.a., the <code>#</code> character will be encoded into <code>%23</code></p><br><p>learn more on our <a href="https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api" target="_blank" rel="noopener noreferrer">Help Center</a></p>'
          nullable: true
        postback_data:
          type: string
          description: '<p><em>postback_url datatype</em><p><strong>required field if you specify <code>postback_url</code></strong><p>corresponds to the datatype that will be sent to your server<p>possible values:<p><code>advanced</code>, <code>html</code></p>'
        priority:
          type: integer
          description: <p><em>task priority</em><p>optional field<p>can take the following values:<p>1 – normal execution priority (set by default)<p>2 – high execution priority</p><br>You will be additionally charged for the tasks with high execution priority.<p>The cost can be calculated on the <a title="Pricing" href="https://dataforseo.com/pricing/serp/google-search-by-image-serp-api" target="_blank" rel="noopener noreferrer">Pricing</a> page.
          nullable: true
        location_name:
          type: string
          description: '<p><em>full name of search engine location</em><p><strong>required field if you don''t specify</strong> <code>location_code</code> or <code>location_coordinate</code><p><strong>if you use this field, you don''t need to specify <code>location_code</code> or <code>location_coordinate</code></strong><p>you can receive the list of available locations of the search engine with their <code>location_name</code> by making a separate request to the <code>https://api.dataforseo.com/v3/serp/{{low_se_name}}/locations</code><p>example:<p><code class="long-string">London,England,United Kingdom</code></p>'
        language_name:
          type: string
          description: '<p><em>full name of search engine language</em><p><strong>required field if you don''t specify</strong> <code>language_code</code><p><strong>if you use this field, you don''t need to specify <code>language_code</code></strong><p>you can receive the list of available languages of the search engine with their <code>language_name</code> by making a separate request to the <code>https://api.dataforseo.com/v3/serp/{{low_se_name}}/languages</code><p>example:<p><code class="long-string">English</code></p>'
        tag:
          type: string
          description: <p><em>user-defined task identifier</em><p>optional field<p><em>the character limit is 255</em><p>you can use this parameter to identify the task and match it with the result<p>you will find the specified <code>tag</code> value in the <code>data</code> object of the response</p>
          nullable: true
        max_crawl_pages:
          type: integer
          description: '<p><em>page crawl limit</em><p>optional field<p>number of search results pages to crawl<p>max value: <code>100</code><p><strong>Note:</strong> the <code>max_crawl_pages</code> and <code>depth</code> parameters complement each other;<p>learn more at <a href="https://dataforseo.com/help-center/what-is-max-crawl-pages-and-how-does-it-work" target="_blank" rel="noopener noreferrer">our help center</a></p>'
          nullable: true
        search_param:
          type: string
          description: <p><em>additional parameters of the search query</em><p>optional field<p><a href="https://dataforseo.com/help-center/google-search-engine-parameters-and-how-to-use-them">get the list of available parameters and additional details here</a></p>
          nullable: true
        calculate_rectangles:
          type: boolean
          description: '<p><em>calculate pixel rankings for SERP elements in advanced results</em><p>optional field<p>pixel ranking refers to the distance between the result snippet and top left corner of the screen;<p><a href="https://dataforseo.com/help-center/pixel-ranking-in-serp-api">Visit Help Center to learn more&gt;&gt;</a><p>by default, the parameter is set to <code>false</code><p><strong>Note:</strong> if set to <code>true</code>, the charge per task will be multiplied by 2</p>'
          nullable: true
        browser_screen_width:
          type: integer
          description: '<p><em>browser screen width</em><p>optional field<p>you can set a custom browser screen width to calculate pixel rankings for a particular device;<p>by default, the parameter is set to <code>1920</code>;<p><strong>Note:</strong> to use this parameter, set <code>calculate_rectangles</code> to <code>true</code></p>'
          format: int64
          nullable: true
        browser_screen_height:
          type: integer
          description: '<p><em>browser screen height</em><p>optional field<p>you can set a custom browser screen height to calculate pixel rankings for a particular device;<p>by default, the parameter is set to <code>1080</code>;<p><strong>Note:</strong> to use this parameter, set <code>calculate_rectangles</code> to <code>true</code></p>'
          nullable: true
        browser_screen_resolution_ratio:
          type: integer
          description: '<p><em>browser screen resolution ratio</em><p>optional field<p>you can set a custom browser screen resolution ratio to calculate pixel rankings for a particular device;<p>by default, the parameter is set to <code>1</code>;<p><strong>Note:</strong> to use this parameter, set <code>calculate_rectangles</code> to <code>true</code></p>'
          nullable: true
        location_coordinate:
          type: string
          description: '<p><em>GPS coordinates of a location</em><p><strong>required field if you don''t specify</strong> <code>location_name</code>&nbsp;or <code>location_code</code><p><strong>if you use this field, you don''t need to specify <code>location_name</code> or <code>location_code</code></strong><p><code>location_coordinate</code> parameter should be specified in the <em>"latitude,longitude,radius"</em> format<p>the maximum number of decimal digits for <em>"latitude"</em> and <em>"longitude"</em>: 7<p>the minimum value for <em>"radius"</em>: 199.9 (mm)<p>the maximum value for <em>"radius"</em>: 199999 (mm)<p>example:<p><code class="long-string">53.476225,-2.243572,200</code></p>'
        se_domain:
          type: string
          description: '<p><em>search engine domain</em><p>optional field<p>we choose the relevant search engine domain automatically according to the location and language you specify<p>however, you can set a custom search engine domain in this field<p>example:<p><code><em>google.co.uk</em></code>, <code><em>google.com.au</em></code>, <code><em>google.de</em></code>, etc.</p>'
          nullable: true
      example:
        - language_code: en
          location_code: 2840
          image_url: https://dataforseo.com/wp-content/uploads/2016/11/data_for_seo_light_429.png
    SerpGoogleSearchByImageTaskPostTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: object
              description: '<em>array of results</em><br>in this case, the value will be <code>null</code>'
              nullable: true
    SerpGoogleSearchByImageTaskPostResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleSearchByImageTaskPostTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    SerpGoogleSearchByImageTasksReadyResultInfo:
      type: object
      properties:
        id:
          type: string
          description: <em>task identifier of the completed task</em><br><strong>unique task identifier in our system in the <a href="https://en.wikipedia.org/wiki/Universally_unique_identifier">UUID</a> format</strong>
          nullable: true
        se:
          type: string
          description: <em>search engine specified when setting the task</em>
          nullable: true
        se_type:
          type: string
          description: '<em>type of search engine</em><br>can take the following values: <code>search_by_image</code>'
          nullable: true
        date_posted:
          type: string
          description: <em>date when the task was posted (in the UTC format)</em>
          nullable: true
        tag:
          type: string
          description: <em>user-defined task identifier</em>
          nullable: true
        endpoint_regular:
          type: string
          description: '<em>URL for collecting the results of the SERP Regular task</em><br>if SERP Regular is not supported in the specified endpoint, the value will be <code>null</code>'
          nullable: true
        endpoint_advanced:
          type: string
          description: '<em>URL for collecting the results of the SERP Advanced task</em><br>if SERP Advanced is not supported in the specified endpoint, the value will be <code>null</code>'
          nullable: true
        endpoint_html:
          type: string
          description: '<em>URL for collecting the results of the SERP HTML task</em><br>if SERP HTML is not supported in the specified endpoint, the value will be <code>null</code>'
          nullable: true
    SerpGoogleSearchByImageTasksReadyTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleSearchByImageTasksReadyResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    SerpGoogleSearchByImageTasksReadyResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleSearchByImageTasksReadyTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    SerpGoogleSearchByImageTasksFixedResultInfo:
      type: object
      properties:
        id:
          type: string
          description: <em>task identifier of the completed task</em><br><strong>unique task identifier in our system in the <a href="https://en.wikipedia.org/wiki/Universally_unique_identifier">UUID</a> format</strong>
          nullable: true
        se:
          type: string
          description: <em>search engine specified when setting the task</em>
          nullable: true
        se_type:
          type: string
          description: '<em>type of search engine</em><br>can take the following values: <code>{{low_se_type_under}}</code>'
          nullable: true
        date_posted:
          type: string
          nullable: true
        tag:
          type: string
          description: <em>user-defined task identifier</em>
          nullable: true
        endpoint_regular:
          type: string
          description: '<em>URL for collecting the results of the SERP Regular task</em><br>if SERP Regular is not supported in the specified endpoint, the value will be <code>null</code>'
          nullable: true
        endpoint_advanced:
          type: string
          description: '<em>URL for collecting the results of the SERP Advanced task</em><br>if SERP Advanced is not supported in the specified endpoint, the value will be <code>null</code>'
          nullable: true
        endpoint_html:
          type: string
          description: '<em>URL for collecting the results of the SERP HTML task</em><br>if SERP HTML is not supported in the specified endpoint, the value will be <code>null</code>'
          nullable: true
    SerpGoogleSearchByImageTasksFixedTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleSearchByImageTasksFixedResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    SerpGoogleSearchByImageTasksFixedResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleSearchByImageTasksFixedTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    SerpApiGoogleSearchByImagesOrganicElementItem:
      type: object
      allOf:
        - type: object
          oneOf:
            - $ref: '#/components/schemas/BaseSerpApiGoogleSearchByImagesElementItem'
          nullable: true
        - type: object
          properties:
            domain:
              type: string
              description: <em>domain in SERP</em>
              nullable: true
            cache_url:
              type: string
              description: <em>cached version of the page</em>
              nullable: true
            related_search_url:
              type: string
              description: <em>URL to a similar search</em><br>            URL to a new search for the same keyword(s) <a href="https://support.google.com/websearch/answer/2466433?hl=en#:~:text=Search%20for%20related%20sites">on related sites</a>
              nullable: true
            breadcrumb:
              type: string
              description: <em>breadcrumb in SERP</em>
              nullable: true
            website_name:
              type: string
              description: <em>name of the website in SERP</em>
              nullable: true
            is_image:
              type: boolean
              description: <em>indicates whether the element contains an <code class="prettyprint">image</code></em>
              nullable: true
            is_video:
              type: boolean
              description: <em>indicates whether the element contains a <code class="prettyprint">video</code></em>
              nullable: true
            is_featured_snippet:
              type: boolean
              description: <em>indicates whether the element is a <code class="prettyprint">featured_snippet</code></em>
              nullable: true
            is_malicious:
              type: boolean
              description: <em>indicates whether the element is marked as malicious</em>
              nullable: true
            is_web_story:
              type: boolean
              description: <em>indicates whether the element is marked as Google web story</em>
              nullable: true
            checks:
              type: array
              items:
                type: string
                description: <em>indicates whether the element contains a <code class="prettyprint">video</code></em>
                nullable: true
              nullable: true
            description:
              type: string
              description: <em>description of the results element in SERP</em>
              nullable: true
            pre_snippet:
              type: string
              description: <em>includes additional information appended before the result description in SERP</em>
              nullable: true
            extended_snippet:
              type: string
              description: <em>includes additional information appended after the result description in SERP</em>
              nullable: true
            images:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AiModeImagesElementInfo'
                nullable: true
              description: <em>images of the element</em>
              nullable: true
            amp_version:
              type: boolean
              description: <em>Accelerated Mobile Pages</em><br>            indicates whether an item has the Accelerated Mobile Page (AMP) version
              nullable: true
            rating:
              type: object
              oneOf:
                - $ref: '#/components/schemas/RatingInfo'
              description: <em>the item's rating </em><br>            the popularity rate based on reviews and displayed in SERP
              nullable: true
            price:
              type: object
              oneOf:
                - $ref: '#/components/schemas/PriceInfo'
              description: <em>pricing details</em><br>            contains the pricing details of the product or service featured in the result
              nullable: true
            highlighted:
              type: array
              items:
                type: string
                nullable: true
              description: <em>words highlighted in bold within the results <code>description</code></em>
              nullable: true
            links:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/LinkElement'
                nullable: true
              description: '<em>sitelinks</em><br>            the links shown below some of Google''s search results<br>            if there are none, equals <code>null</code>'
              nullable: true
            faq:
              type: object
              oneOf:
                - $ref: '#/components/schemas/FaqBox'
              description: '<em>frequently asked questions</em><br>            questions and answers extension shown below some of Google''s search results<br>            if there are none, equals <code>null</code>'
              nullable: true
              deprecated: true
            extended_people_also_search:
              type: array
              items:
                type: string
                nullable: true
              description: <em>extension of the organic element</em><br>            extension of the organic result containing related search queries<br>            <strong>Note:</strong> extension appears in SERP upon clicking on the result and then bouncing back to search results
              nullable: true
            about_this_result:
              type: object
              oneOf:
                - $ref: '#/components/schemas/AboutThisResultElement'
              description: <em>contains information from the 'About this result' panel</em><br>            <a href="https://blog.google/products/search/learn-more-and-get-more-from-search/">'About this result' panel</a> provides additional context about why Google returned this result for the given query;<br>            this feature appears after clicking on the three dots next to most results
              nullable: true
              deprecated: true
            related_result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/RelatedResult'
                nullable: true
              description: '<em>related result from the same domain</em><br>            related result from the same domain appears as a part of the main result snippet;<br>            you can derive the <code>related_result</code> snippets as <code>"type": "organic"</code> results by setting the <code>group_organic_results</code> parameter to <code>false</code> in the POST request'
              nullable: true
            timestamp:
              type: string
              description: '<em>date and time when the result was published</em><br>            in the UTC format: "yyyy-mm-dd hh-mm-ss +00:00"<br>            example:<br>            <code class="long-string">2019-11-15 12:57:46 +00:00</code>'
              nullable: true
    SerpApiGoogleSearchByImagesImagesElementItem:
      type: object
      allOf:
        - type: object
          oneOf:
            - $ref: '#/components/schemas/BaseSerpApiGoogleSearchByImagesElementItem'
          nullable: true
        - type: object
          properties:
            items:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AiModeImagesElementInfo'
                nullable: true
              description: <em>elements of search results found in SERP</em>
              nullable: true
            related_image_searches:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/RelatedImageSearchesElement'
                nullable: true
              description: '<em>contains keywords and images related to the specified search term</em><br>            if there are none, equals <code>null</code>'
              nullable: true
              deprecated: true
    SerpGoogleSearchByImageTaskGetAdvancedResultInfo:
      type: object
      properties:
        image_url:
          type: string
          description: <em>URL specified in a POST array</em>
          nullable: true
        keyword:
          type: string
          description: <em>keyword Google associated with the specified image</em>
          nullable: true
        type:
          type: string
          description: type of element
          nullable: true
        se_domain:
          type: string
          description: <em>search engine domain in a POST array</em>
          nullable: true
        location_code:
          type: integer
          description: <em>location code in a POST array</em>
          nullable: true
        language_code:
          type: string
          description: <em>language code in a POST array</em>
          nullable: true
        check_url:
          type: string
          description: <em>direct URL to search engine results</em><br>            you can use it to make sure that we provided accurate results
          nullable: true
        datetime:
          type: string
          description: '<em>date and time when the result was received</em><br>            in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”<br>            example:<br>            <code class="long-string">2019-11-15 12:57:46 +00:00</code>'
          nullable: true
        spell:
          type: object
          oneOf:
            - $ref: '#/components/schemas/SpellInfo'
          description: '<em>autocorrection of the search engine</em><br>            if the search engine provided results for a keyword that was corrected, we will specify the keyword corrected by the search engine and the type of autocorrection'
          nullable: true
        refinement_chips:
          type: object
          oneOf:
            - $ref: '#/components/schemas/RefinementChipsInfo'
          description: <em>search refinement chips</em><br>
          nullable: true
        item_types:
          type: array
          items:
            type: string
            nullable: true
          description: '<em>types of search results in SERP</em><br>            contains types of search results (<code>items</code>) found in SERP.<br>            possible item types:<br>            <code>organic</code>,<br>            <code>images</code>'
          nullable: true
        se_results_count:
          type: integer
          description: <em> total number of results in SERP</em>
          format: int64
          nullable: true
        items_count:
          type: integer
          description: <em>the number of results returned in the <strong><code>items</code></strong> array</em>
          format: int64
          nullable: true
        items:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/BaseSerpApiGoogleSearchByImagesElementItem'
            nullable: true
          description: <em>items featured in the faq_box</em>
          nullable: true
    SerpGoogleSearchByImageTaskGetAdvancedTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleSearchByImageTaskGetAdvancedResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    SerpGoogleSearchByImageTaskGetAdvancedResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleSearchByImageTaskGetAdvancedTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    SerpGoogleJobsTaskPostRequestInfo:
      type: object
      properties:
        keyword:
          type: string
          description: '<p><em>keyword</em><p><strong>required field</strong><p>you can specify <strong>up to 700 characters</strong> in the <code>keyword</code> field<p>all %## will be decoded (plus character ‘+’ will be decoded to a space character)<p>if you need to use the “%” character for your <code>keyword</code>, please specify it as “%25”;<p>if you need to use the “+” character for your <code>keyword</code>, please specify it as “%2B”;<p><strong>Note:</strong> the keyword you specify must indicate the job title;<p>example: <code>.net developer</code></p><br><p>learn more about rules and limitations of <code>keyword</code> and <code>keywords</code> fields in DataForSEO APIs in this <a href="https://dataforseo.com/help-center/rules-and-limitations-of-keyword-and-keywords-fields-in-dataforseo-apis" rel="noopener noreferrer" target="_blank">Help Center article</a></p>'
        location_code:
          type: integer
          description: <p><em>search engine location code</em><p><strong>required field if you don't specify</strong> <code>location_name</code>;<p>you can receive the list of available locations of the search engines with their <code>location_code</code> by making a separate request to <code>https://api.dataforseo.com/v3/serp/google/jobs/locations</code><p>example:<p><code class="long-string">2840</code></p>
        language_code:
          type: string
          description: '<p><em>search engine language code</em><p><strong>required field if you don''t specify</strong> <code>language_name</code><p><strong>if you use this field, you don''t need to specify <code>language_name</code></strong>;<p>you can receive the list of available languages of the search engine with their <code>language_code</code>&nbsp;by making a separate request to the <code>https://api.dataforseo.com/v3/serp/google/languages</code><em><p></em>example:<em><p></em><code class="long-string">en</code></p>'
        depth:
          type: integer
          description: '<p><em>parsing depth</em><p>optional field<p>number of results in SERP;<p>default value: <code>10</code><p>max value: <code>200</code></p><br><strong>Your account will be billed per each SERP containing up to 10 results;</strong><p>Setting depth above 10 may result in additional charges if the search engine returns more than 10 results;<p>If the specified depth is higher than the number of results in the response, the difference will be refunded to your account balance automatically;<p>The cost can be calculated on the <a title="Pricing" href="https://dataforseo.com/pricing/serp/google-jobs-serp-api" target="_blank" rel="noopener noreferrer">Pricing</a> page.'
          nullable: true
        priority:
          type: integer
          description: <p><em>task priority</em><p>optional field<p>can take the following values:<p>1 – normal execution priority (set by default);<p>2 – high execution priority</p><br>You will be additionally charged for the tasks with high execution priority;<p>The cost can be calculated on the <a title="Pricing" href="https://dataforseo.com/pricing/serp/google-jobs-serp-api" target="_blank" rel="noopener noreferrer">Pricing</a> page
          nullable: true
        pingback_url:
          type: string
          description: '<p><em>notification URL of a completed task</em><p>optional field<p>when a task is completed we will notify you by GET request sent to the URL you have specified<p>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<p>example:<p><code>http://your-server.com/pingscript?id=$id</code><p><code>http://your-server.com/pingscript?id=$id&amp;tag=$tag</code><p><strong>Note:</strong> special characters in <code>pingback_url</code> will be urlencoded;<p>i.a., the <code>#</code> character will be encoded into <code>%23</code></p><br><p>learn more on our <a href="https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api" target="_blank" rel="noopener noreferrer">Help Center</a></p>'
          nullable: true
        postback_url:
          type: string
          description: '<p><em>URL for sending task results</em><p>optional field<p>once the task is completed, we will send a POST request with its results compressed in the <code>gzip</code> format to the <code>postback_url</code> you specified<p>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request<p>example:<p><code>http://your-server.com/postbackscript?id=$id</code><p><code>http://your-server.com/postbackscript?id=$id&amp;tag=$tag</code><p><strong>Note:</strong> special characters in <code>postback_url</code> will be urlencoded;<p>i.a., the <code>#</code> character will be encoded into <code>%23</code></p><br><p>learn more on our <a href="https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api" target="_blank" rel="noopener noreferrer">Help Center</a></p>'
          nullable: true
        postback_data:
          type: string
          description: '<p><em>postback_url datatype</em><p><strong>required field if you specify <code>postback_url</code></strong><p>corresponds to the datatype that will be sent to your server<p>possible values:<p><code>regular</code>, <code>advanced</code>, <code>html</code></p>'
        location_name:
          type: string
          description: '<p><em>full name of search engine location</em><p><strong>required field if you don''t specify</strong> <code>location_code</code><p><strong>if you use this field, you don''t need to specify <code>location_code</code></strong>;<p>you can receive the list of available locations of the search engine with their <code>location_name</code> by making a separate request to <code>https://api.dataforseo.com/v3/serp/google/jobs/locations</code><p>example:<p><code class="long-string">London,England,United Kingdom</code></p>'
        language_name:
          type: string
          description: '<p><em>full name of search engine language</em><p><strong>required field if you don''t specify</strong> <code>language_code</code><p><strong>if you use this field, you don''t need to specify <code>language_code</code></strong>;<p>you can receive the list of available languages of the search engine with their <code>language_name</code> by making a separate request to <code>https://api.dataforseo.com/v3/serp/google/languages</code><p>example:<p><code class="long-string">English</code></p>'
        tag:
          type: string
          description: <p><em>user-defined task identifier</em><p>optional field<p><em>the character limit is 255</em><p>you can use this parameter to identify the task and match it with the result<p>you will find the specified <code>tag</code> value in the <code>data</code> object of the response</p>
          nullable: true
        location_radius:
          type: string
          description: '<p><em>location search radius</em><p>optional field<p>location search radius in kilometers;<p><strong>Note:</strong> for countries that use the imperial system of units, you will need to convert miles to kilometers by multiplying the value in miles by <code>1.609</code>;<p>if value is not specified, search is executed anywhere within the specified location;<p>maximal value: <code>300</code><p>minimal value: <code>&gt; 0</code></p>'
          nullable: true
        employment_type:
          type: array
          items:
            type: string
          description: '<p><em>employment contract type</em><p>optional field<p>type of employment contract for which the search results will be returned;<p>possible values:<p><code>fulltime</code>, <code>partime</code>, <code>contractor</code>, <code>intern</code></p>'
          nullable: true
      example:
        - language_code: en
          location_code: 2840
          keyword: .net developer
        - language_name: English
          location_name: United States
          keyword: .net developer
          tag: some_string_123
          pingback_url: https://your-server.com/pingscript?id=$id&tag=$tag
    SerpGoogleJobsTaskPostTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: object
              description: '<em>array of results</em><br>in this case, the value will be <code>null</code>'
              nullable: true
    SerpGoogleJobsTaskPostResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleJobsTaskPostTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    SerpGoogleJobsTasksReadyResultInfo:
      type: object
      properties:
        id:
          type: string
          description: <em>task identifier of the completed task</em><br><strong>unique task identifier in our system in the <a href="https://en.wikipedia.org/wiki/Universally_unique_identifier">UUID</a> format</strong>
          nullable: true
        se:
          type: string
          description: <em>search engine specified when setting the task</em>
          nullable: true
        se_type:
          type: string
          description: '<em>type of search engine</em><br>example: <code>{{low_se_type_under}}</code>'
          nullable: true
        date_posted:
          type: string
          description: <em>date when the task was posted (in the UTC format)</em>
          nullable: true
        tag:
          type: string
          description: <em>user-defined task identifier</em>
          nullable: true
        endpoint_regular:
          type: string
          description: '<em>URL for collecting the results of the SERP Regular task</em><br>if SERP Regular is not supported in the specified endpoint, the value will be <code>null</code>'
          nullable: true
        endpoint_advanced:
          type: string
          description: '<em>URL for collecting the results of the SERP Advanced task</em><br>if SERP Advanced is not supported in the specified endpoint, the value will be <code>null</code>'
          nullable: true
        endpoint_html:
          type: string
          description: '<em>URL for collecting the results of the SERP HTML task</em><br>if SERP HTML is not supported in the specified endpoint, the value will be <code>null</code>'
          nullable: true
    SerpGoogleJobsTasksReadyTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleJobsTasksReadyResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    SerpGoogleJobsTasksReadyResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleJobsTasksReadyTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    SerpGoogleJobsTasksFixedResultInfo:
      type: object
      properties:
        id:
          type: string
          description: <em>task identifier of the completed task</em><br><strong>unique task identifier in our system in the <a href="https://en.wikipedia.org/wiki/Universally_unique_identifier">UUID</a> format</strong>
          nullable: true
        se:
          type: string
          description: <em>search engine specified when setting the task</em>
          nullable: true
        se_type:
          type: string
          description: '<em>type of search engine</em><br>can take the following values: <code>{{low_se_type_under}}</code>'
          nullable: true
        date_posted:
          type: string
          nullable: true
        tag:
          type: string
          description: <em>user-defined task identifier</em>
          nullable: true
        endpoint_regular:
          type: string
          description: '<em>URL for collecting the results of the SERP Regular task</em><br>if SERP Regular is not supported in the specified endpoint, the value will be <code>null</code>'
          nullable: true
        endpoint_advanced:
          type: string
          description: '<em>URL for collecting the results of the SERP Advanced task</em><br>if SERP Advanced is not supported in the specified endpoint, the value will be <code>null</code>'
          nullable: true
        endpoint_html:
          type: string
          description: '<em>URL for collecting the results of the SERP HTML task</em><br>if SERP HTML is not supported in the specified endpoint, the value will be <code>null</code>'
          nullable: true
    SerpGoogleJobsTasksFixedTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleJobsTasksFixedResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    SerpGoogleJobsTasksFixedResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleJobsTasksFixedTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    GoogleJobsItem:
      type: object
      properties:
        type:
          type: string
          description: type of element
          nullable: true
        rank_group:
          type: integer
          description: <em>group rank in SERP</em><br>position within a group of elements with identical <code>type</code> values<br>positions of elements with different <code>type</code> values are omitted from <code>rank_group</code>
          nullable: true
        rank_absolute:
          type: integer
          description: <em>absolute rank in SERP</em><br>absolute position among all the elements in SERP
          nullable: true
        position:
          type: string
          description: '<em>the alignment of the element in SERP</em><br>can take the following values:<br><code>left</code>, <code>right</code>'
          nullable: true
        xpath:
          type: string
          description: <em>the <a href="https://en.wikipedia.org/wiki/XPath" rel="noopener noreferrer" target="_blank">XPath</a> of the element</em>
          nullable: true
        job_id:
          type: string
          description: <em>ID of the job on Google Jobs</em>
          nullable: true
        title:
          type: string
          description: <em>title of the element</em>
          nullable: true
        employer_name:
          type: string
          description: <em>name of the employer</em>
          nullable: true
        employer_url:
          type: string
          description: <em>URL to the employer's website</em>
          nullable: true
        employer_image_url:
          type: string
          description: <em>URL to the image used in the job posting</em>
          nullable: true
        location:
          type: string
          description: <em>location for which the job vacancy is posted</em>
          nullable: true
        source_name:
          type: string
          description: <em>original source of the job vacancy</em>
          nullable: true
        source_url:
          type: string
          description: <em>URL to the original source of the job vacancy</em>
          nullable: true
        salary:
          type: string
          description: '<em>the salary indicated in the job vacancy</em><br>if the salary isn''t indicated, this field will equal <code>null</code>'
          nullable: true
        contract_type:
          type: string
          description: <em>employment contract type</em>
          nullable: true
        timestamp:
          type: string
          description: '<em>date and time when the result was published</em><br>in the UTC format: "yyyy-mm-dd hh-mm-ss +00:00"<br>example:<br><code class="long-string">2019-11-15 12:57:46 +00:00</code>'
          nullable: true
        time_ago:
          type: string
          description: <em>indicates how long ago the job vacancy was posted</em>
          nullable: true
        rectangle:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AiModeRectangleInfo'
          description: '<em>rectangle parameters</em><br>contains cartesian coordinates and pixel dimensions of the result''s snippet in SERP;<br>in this case, will equal <code>null</code>'
          nullable: true
    SerpGoogleJobsTaskGetAdvancedResultInfo:
      type: object
      properties:
        keyword:
          type: string
          description: <em>keyword received in a POST array<br></em><strong>the keyword is returned with decoded %## (plus symbol '+' will be decoded to a space character)</strong>
          nullable: true
        type:
          type: string
          description: type of element
          nullable: true
        se_domain:
          type: string
          description: <em>search engine domain in a POST array</em>
          nullable: true
        location_code:
          type: integer
          description: <em>location code in a POST array</em>
          nullable: true
        language_code:
          type: string
          description: <em>language code in a POST array</em>
          nullable: true
        check_url:
          type: string
          description: <em>direct URL to search engine results</em><br>you can use it to make sure that we provided accurate results
          nullable: true
        datetime:
          type: string
          description: '<em>date and time when the result was received</em><br>in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”<br>example:<br><code class="long-string">2019-11-15 12:57:46 +00:00</code>'
          nullable: true
        spell:
          type: object
          oneOf:
            - $ref: '#/components/schemas/SpellInfo'
          description: '<em>autocorrection of the search engine</em><br>if the search engine provided results for a keyword that was corrected, we will specify the keyword corrected by the search engine and the type of autocorrection;<br>in this case, equals <code>null</code>'
          nullable: true
        refinement_chips:
          type: object
          oneOf:
            - $ref: '#/components/schemas/RefinementChipsInfo'
          description: <em>search refinement chips</em>
          nullable: true
        item_types:
          type: array
          items:
            type: string
            nullable: true
          description: <em>types of search results in SERP</em><br>contains types of search results (<code>items</code>) found in SERP.<br>possible item types:<br><code>google_jobs_item</code>
          nullable: true
        se_results_count:
          type: integer
          description: <em> total number of results in SERP</em>
          format: int64
          nullable: true
        items_count:
          type: integer
          description: <em>the number of results returned in the <strong><code>items</code></strong> array</em>
          format: int64
          nullable: true
        items:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/GoogleJobsItem'
            nullable: true
          description: <em>items of the element</em>
          nullable: true
    SerpGoogleJobsTaskGetAdvancedTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleJobsTaskGetAdvancedResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    SerpGoogleJobsTaskGetAdvancedResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleJobsTaskGetAdvancedTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    SerpGoogleJobsTaskGetHtmlResultInfo:
      type: object
      properties:
        keyword:
          type: string
          description: <em>keyword received in a POST array<br></em><strong>keyword is returned with decoded %## (plus symbol '+' will be decoded to a space character)</strong>
          nullable: true
        type:
          type: string
          description: type of element
          nullable: true
        se_domain:
          type: string
          description: <em>search engine domain in a POST array</em>
          nullable: true
        location_code:
          type: integer
          description: <em>location code in a POST array</em>
          nullable: true
        language_code:
          type: string
          description: <em>language code in a POST array</em>
          nullable: true
        datetime:
          type: string
          description: '<em>date and time when the result was received</em><br>in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”<br>example:<br><code class="long-string">2019-11-15 12:57:46 +00:00</code>'
          nullable: true
        items_count:
          type: integer
          description: <em>the number of results returned in the <strong><code>items</code></strong> array</em>
          format: int64
          nullable: true
        items:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/HtmlItemInfo'
            nullable: true
          description: <em>elements of search results found in SERP</em>
          nullable: true
    SerpGoogleJobsTaskGetHtmlTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleJobsTaskGetHtmlResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    SerpGoogleJobsTaskGetHtmlResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleJobsTaskGetHtmlTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    SerpGoogleAutocompleteTaskPostRequestInfo:
      type: object
      properties:
        keyword:
          type: string
          description: '<p><em>keyword</em><p><strong>required field</strong><p>you can specify <strong>up to 700 characters</strong> in the <code>keyword</code> field<p>all %## will be decoded (plus character ‘+’ will be decoded to a space character)<p>if you need to use the “%” character for your <code>keyword</code>, please specify it as “%25”;<p>if you need to use the “+” character for your <code>keyword</code>, please specify it as “%2B”;</p><br><p>learn more about rules and limitations of <code>keyword</code> and <code>keywords</code> fields in DataForSEO APIs in this <a href="https://dataforseo.com/help-center/rules-and-limitations-of-keyword-and-keywords-fields-in-dataforseo-apis" rel="noopener noreferrer" target="_blank">Help Center article</a></p>'
        location_code:
          type: integer
          description: <p><em>search engine location code</em><p><strong>required field if you don't specify</strong> <code>location_name</code>;<p>you can receive the list of available locations of the search engines with their <code>location_code</code> by making a separate request to <code>https://api.dataforseo.com/v3/serp/google/locations</code><p>example:<p><code class="long-string">2840</code></p>
        language_code:
          type: string
          description: '<p><em>search engine language code</em><p><strong>required field if you don''t specify</strong> <code>language_name</code><p><strong>if you use this field, you don''t need to specify <code>language_name</code></strong>;<p>you can receive the list of available languages of the search engine with their <code>language_code</code>&nbsp;by making a separate request to the <code>https://api.dataforseo.com/v3/serp/google/languages</code><em><p></em>example:<em><p></em><code class="long-string">en</code></p>'
        cursor_pointer:
          type: integer
          description: '<p><em>search bar cursor pointer</em><p>optional field<p>the horizontal numerical position of the cursor pointer within the keyword in the search bar;<p>by modifying the position of the cursor pointer, you will obtain different autocomplete suggestions for the same seed keyword;<p>minimal value: <code>0</code><p>default value: the number of the last character of the specified <code>keyword</code><p>example:<p><code>|which query are s</code> - <code>"cursor_pointer": 0</code><p><code>which query is s|</code> - <code>"cursor_pointer": 16</code><p><code>which que|ry is s</code> - <code>"cursor_pointer": 9</code></p>'
          nullable: true
        priority:
          type: integer
          description: <p><em>task priority</em><p>optional field<p>can take the following values:<p>1 – normal execution priority (set by default);<p>2 – high execution priority</p><br>You will be additionally charged for the tasks with high execution priority;<p>The cost can be calculated on the <a title="Pricing" href="https://dataforseo.com/pricing/serp/google-autocomplete-serp-api" target="_blank" rel="noopener noreferrer">Pricing</a> page
          nullable: true
        pingback_url:
          type: string
          description: '<p><em>notification URL of a completed task</em><p>optional field<p>when a task is completed we will notify you by GET request sent to the URL you have specified<p>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<p>example:<p><code>http://your-server.com/pingscript?id=$id</code><p><code>http://your-server.com/pingscript?id=$id&amp;tag=$tag</code><p><strong>Note:</strong> special characters in <code>pingback_url</code> will be urlencoded;<p>i.a., the <code>#</code> character will be encoded into <code>%23</code></p><br><p>learn more on our <a href="https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api" target="_blank" rel="noopener noreferrer">Help Center</a></p>'
          nullable: true
        postback_url:
          type: string
          description: '<p><em>URL for sending task results</em><p>optional field<p>once the task is completed, we will send a POST request with its results compressed in the <code>gzip</code> format to the <code>postback_url</code> you specified<p>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request<p>example:<p><code>http://your-server.com/postbackscript?id=$id</code><p><code>http://your-server.com/postbackscript?id=$id&amp;tag=$tag</code><p><strong>Note:</strong> special characters in <code>postback_url</code> will be url-encoded;<p>i.e., the <code>#</code> character will be encoded into <code>%23</code></p><br><p>learn more on our <a href="https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api" target="_blank" rel="noopener noreferrer">Help Center</a></p>'
          nullable: true
        postback_data:
          type: string
          description: <p><em>postback_url datatype</em><p><strong>required field if you specify <code>postback_url</code></strong><p>corresponds to the datatype that will be sent to your server<p>possible values:<p><code>advanced</code></p>
        client:
          type: string
          description: <p><em>search client for autocomplete</em><p>optional field<p>autocomplete results may differ depending on the search client;<p>possible values:<p><code>chrome</code> — used when google search is opened in google chrome;<p><code>chrome-omni</code> — used in the address bar in chrome;<p><code>gws-wiz</code> — used in google search home page;<p><code>gws-wiz-serp</code> — used in google search engine results page;<p><code>safari</code> — used when google search is opened in safari browser;<p><code>firefox</code> — used when google search is opened in firefox browser;<p><code>psy-ab</code> — may be used when google search is opened in google chrome browser;<p><code>toolbar</code> — returns XML;<p><code>youtube</code> — returns JSONP;<p><code>gws-wiz-local</code> — used in google local;<p><code>img</code> — used in google's image search;<p><code>products-cc</code> — used in google shopping search</p>
          nullable: true
        location_name:
          type: string
          description: '<p><em>full name of search engine location</em><p><strong>required field if you don''t specify</strong> <code>location_code</code><p><strong>if you use this field, you don''t need to specify <code>location_code</code></strong>;<p>you can receive the list of available locations of the search engine with their <code>location_name</code> by making a separate request to <code>https://api.dataforseo.com/v3/serp/google/autocomplete/locations</code><p>example:<p><code class="long-string">London,England,United Kingdom</code></p>'
        language_name:
          type: string
          description: '<p><em>full name of search engine language</em><p><strong>required field if you don''t specify</strong> <code>language_code</code><p><strong>if you use this field, you don''t need to specify <code>language_code</code></strong>;<p>you can receive the list of available languages of the search engine with their <code>language_name</code> by making a separate request to <code>https://api.dataforseo.com/v3/serp/google/languages</code><p>example:<p><code class="long-string">English</code></p>'
        tag:
          type: string
          description: <p><em>user-defined task identifier</em><p>optional field<p><em>the character limit is 255</em><p>you can use this parameter to identify the task and match it with the result<p>you will find the specified <code>tag</code> value in the <code>data</code> object of the response</p>
          nullable: true
      example:
        - language_code: en
          location_code: 2840
          keyword: albert einstein
          cursor_pointer: 6
    SerpGoogleAutocompleteTaskPostTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: object
              description: '<em>array of results</em><br>in this case, the value will be <code>null</code>'
              nullable: true
    SerpGoogleAutocompleteTaskPostResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleAutocompleteTaskPostTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    SerpGoogleAutocompleteTasksReadyResultInfo:
      type: object
      properties:
        id:
          type: string
          description: <em>task identifier of the completed task</em><br><strong>unique task identifier in our system in the <a href="https://en.wikipedia.org/wiki/Universally_unique_identifier">UUID</a> format</strong>
          nullable: true
        se:
          type: string
          description: <em>search engine specified when setting the task</em>
          nullable: true
        se_type:
          type: string
          description: '<em>type of search engine</em><br>example: <code>{{low_se_type_under}}</code>'
          nullable: true
        date_posted:
          type: string
          description: <em>date when the task was posted (in the UTC format)</em>
          nullable: true
        tag:
          type: string
          description: <em>user-defined task identifier</em>
          nullable: true
        endpoint_regular:
          type: string
          description: '<em>URL for collecting the results of the SERP Regular task</em><br>if SERP Regular is not supported in the specified endpoint, the value will be <code>null</code>'
          nullable: true
        endpoint_advanced:
          type: string
          description: '<em>URL for collecting the results of the SERP Advanced task</em><br>if SERP Advanced is not supported in the specified endpoint, the value will be <code>null</code>'
          nullable: true
        endpoint_html:
          type: string
          description: '<em>URL for collecting the results of the SERP HTML task</em><br>if SERP HTML is not supported in the specified endpoint, the value will be <code>null</code>'
          nullable: true
    SerpGoogleAutocompleteTasksReadyTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleAutocompleteTasksReadyResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    SerpGoogleAutocompleteTasksReadyResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleAutocompleteTasksReadyTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    SerpGoogleAutocompleteTasksFixedResultInfo:
      type: object
      properties:
        id:
          type: string
          description: <em>task identifier of the completed task</em><br><strong>unique task identifier in our system in the <a href="https://en.wikipedia.org/wiki/Universally_unique_identifier">UUID</a> format</strong>
          nullable: true
        se:
          type: string
          description: <em>search engine specified when setting the task</em>
          nullable: true
        se_type:
          type: string
          description: '<em>type of search engine</em><br>can take the following values: <code>{{low_se_type_under}}</code>'
          nullable: true
        date_posted:
          type: string
          nullable: true
        tag:
          type: string
          description: <em>user-defined task identifier</em>
          nullable: true
        endpoint_regular:
          type: string
          description: '<em>URL for collecting the results of the SERP Regular task</em><br>if SERP Regular is not supported in the specified endpoint, the value will be <code>null</code>'
          nullable: true
        endpoint_advanced:
          type: string
          description: '<em>URL for collecting the results of the SERP Advanced task</em><br>if SERP Advanced is not supported in the specified endpoint, the value will be <code>null</code>'
          nullable: true
        endpoint_html:
          type: string
          description: '<em>URL for collecting the results of the SERP HTML task</em><br>if SERP HTML is not supported in the specified endpoint, the value will be <code>null</code>'
          nullable: true
    SerpGoogleAutocompleteTasksFixedTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleAutocompleteTasksFixedResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    SerpGoogleAutocompleteTasksFixedResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleAutocompleteTasksFixedTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    Autocomplete:
      type: object
      properties:
        type:
          type: string
          description: type of element
          nullable: true
        rank_group:
          type: integer
          description: <em>group rank in SERP</em><br>position within a group of elements with identical <code>type</code> values<br>positions of elements with different <code>type</code> values are omitted from <code>rank_group</code>
          nullable: true
        rank_absolute:
          type: integer
          description: <em>absolute rank in SERP</em><br>absolute position among all the elements in SERP
          nullable: true
        relevance:
          type: integer
          description: '<em>relevance of suggested keyword</em><br>represents the relevant of the autocomplete suggestion to the target keyword<br>can take values from <code>500</code> to <code>2000</code><br>the higher the value, the more relevant is the suggestion<br><strong>Note:</strong> only available for the following <code>client</code>:<br><code>chrome/chrome-omni</code>'
          nullable: true
        suggestion:
          type: string
          description: <em>google autocomplete keyword suggestion</em>
          nullable: true
        suggestion_type:
          type: string
          description: <em>google autocomplete suggestion type</em><br><strong>Note:</strong> only available for the following <code>client</code>:<br><code>chrome/chrome-omni</code>
          nullable: true
        search_query_url:
          type: string
          description: <em>url to search results</em><br>url to search results relevant to the google autocomplete suggestion
          nullable: true
        thumbnail_url:
          type: string
          description: <em>url of the thumbnail image</em><br>url of the thumbnail image of the google autocomplete suggestion<br><strong>Note:</strong> only available for the following <code>client</code>:<br><code>gws-wiz</code><br><code>gws-wiz-serp</code>
          nullable: true
        highlighted:
          type: array
          items:
            type: string
            nullable: true
          description: <em>keywords highlighted in autocomplete</em><br>contains a list of google autocomplete suggestions that are highlighted in the search bar;<br><strong>Note:</strong> array is only available for the following <code>client</code>:<br><code>gws-wiz</code><br><code>psy-ab</code><br><code>gws-wiz-local</code>
          nullable: true
    SerpGoogleAutocompleteTaskGetAdvancedResultInfo:
      type: object
      properties:
        keyword:
          type: string
          description: <em>keyword received in a POST array<br></em><strong>the keyword is returned with decoded %## (plus symbol '+' will be decoded to a space character)</strong>
          nullable: true
        type:
          type: string
          description: type of element
          nullable: true
        se_domain:
          type: string
          description: <em>search engine domain in a POST array</em>
          nullable: true
        location_code:
          type: integer
          description: <em>location code in a POST array</em>
          nullable: true
        language_code:
          type: string
          description: <em>language code in a POST array</em>
          nullable: true
        check_url:
          type: string
          description: <em>direct URL to search engine results</em><br>you can use it to make sure that we provided accurate results
          nullable: true
        datetime:
          type: string
          description: '<em>date and time when the result was received</em><br>in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”<br>example:<br><code class="long-string">2019-11-15 12:57:46 +00:00</code>'
          nullable: true
        spell:
          type: object
          oneOf:
            - $ref: '#/components/schemas/SpellInfo'
          description: '<em>autocorrection of the search engine</em><br>if the search engine provided results for a keyword that was corrected, we will specify the keyword corrected by the search engine and the type of autocorrection;<br>in this case, will equal <code>null</code>'
          nullable: true
        refinement_chips:
          type: object
          oneOf:
            - $ref: '#/components/schemas/RefinementChipsInfo'
          description: <em>search refinement chips</em>
          nullable: true
        item_types:
          type: array
          items:
            type: string
            nullable: true
          description: <em>types of search results in SERP</em><br>contains types of search results (<code>items</code>) found in SERP.<br>possible item types:<br><code>autocomplete</code>
          nullable: true
        se_results_count:
          type: integer
          description: <em> total number of results in SERP</em>
          format: int64
          nullable: true
        items_count:
          type: integer
          description: <em>the number of results returned in the <strong><code>items</code></strong> array</em>
          format: int64
          nullable: true
        items:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/Autocomplete'
            nullable: true
          description: <em>items of the element</em>
          nullable: true
    SerpGoogleAutocompleteTaskGetAdvancedTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleAutocompleteTaskGetAdvancedResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    SerpGoogleAutocompleteTaskGetAdvancedResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleAutocompleteTaskGetAdvancedTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    SerpGoogleAutocompleteLiveAdvancedRequestInfo:
      type: object
      properties:
        keyword:
          type: string
          description: '<p><em>keyword</em><p><strong>required field</strong><p>you can specify <strong>up to 700 characters</strong> in the <code>keyword</code> field<p>all %## will be decoded (plus character ‘+’ will be decoded to a space character)<p>if you need to use the “%” character for your <code>keyword</code>, please specify it as “%25”;<p>if you need to use the “+” character for your <code>keyword</code>, please specify it as “%2B”;</p><br><p>learn more about rules and limitations of <code>keyword</code> and <code>keywords</code> fields in DataForSEO APIs in this <a href="https://dataforseo.com/help-center/rules-and-limitations-of-keyword-and-keywords-fields-in-dataforseo-apis" rel="noopener noreferrer" target="_blank">Help Center article</a></p>'
        location_code:
          type: integer
          description: <p><em>search engine location code</em><p><strong>required field if you don't specify</strong> <code>location_name</code>;<p>you can receive the list of available locations of the search engines with their <code>location_code</code> by making a separate request to <code>https://api.dataforseo.com/v3/serp/google/locations</code><p>example:<p><code class="long-string">2840</code></p>
        language_code:
          type: string
          description: '<p><em>search engine language code</em><p><strong>required field if you don''t specify</strong> <code>language_name</code><p><strong>if you use this field, you don''t need to specify <code>language_name</code></strong>;<p>you can receive the list of available languages of the search engine with their <code>language_code</code>&nbsp;by making a separate request to the <code>https://api.dataforseo.com/v3/serp/google/languages</code><em><p></em>example:<em><p></em><code class="long-string">en</code></p>'
        cursor_pointer:
          type: integer
          description: '<p><em>search bar cursor pointer</em><p>optional field<p>the horizontal numerical position of the cursor pointer within the keyword in the search bar;<p>by modifying the position of the cursor pointer, you will obtain different autocomplete suggestions for the same seed keyword;<p>minimal value: <code>0</code><p>default value: the number of the last character of the specified <code>keyword</code><p>example:<p><code>|which query are s</code> - <code>"cursor_pointer": 0</code><p><code>which query is s|</code> - <code>"cursor_pointer": 16</code><p><code>which que|ry is s</code> - <code>"cursor_pointer": 9</code></p>'
          nullable: true
        location_name:
          type: string
          description: '<p><em>full name of search engine location</em><p><strong>required field if you don''t specify</strong> <code>location_code</code><p><strong>if you use this field, you don''t need to specify <code>location_code</code></strong>;<p>you can receive the list of available locations of the search engine with their <code>location_name</code> by making a separate request to <code>https://api.dataforseo.com/v3/serp/google/autocomplete/locations</code><p>example:<p><code class="long-string">London,England,United Kingdom</code></p>'
        language_name:
          type: string
          description: '<p><em>full name of search engine language</em><p><strong>required field if you don''t specify</strong> <code>language_code</code><p><strong>if you use this field, you don''t need to specify <code>language_code</code></strong>;<p>you can receive the list of available languages of the search engine with their <code>language_name</code> by making a separate request to <code>https://api.dataforseo.com/v3/serp/google/languages</code><p>example:<p><code class="long-string">English</code></p>'
        client:
          type: string
          description: <p><em>search client for autocomplete</em><p>optional field<p>autocomplete results may differ depending on the search client;<p>possible values:<p><code>chrome</code> — used when google search is opened in google chrome;<p><code>chrome-omni</code> — used in the address bar in chrome;<p><code>gws-wiz</code> — used in google search home page;<p><code>gws-wiz-serp</code> — used in google search engine results page;<p><code>safari</code> — used when google search is opened in safari browser;<p><code>firefox</code> — used when google search is opened in firefox browser;<p><code>psy-ab</code> — may be used when google search is opened in google chrome browser;<p><code>toolbar</code> — returns XML;<p><code>youtube</code> — returns JSONP;<p><code>gws-wiz-local</code> — used in google local;<p><code>img</code> — used in google's image search;<p><code>products-cc</code> — used in google shopping search</p>
          nullable: true
        tag:
          type: string
          description: <p><em>user-defined task identifier</em><p>optional field<p><em>the character limit is 255</em><p>you can use this parameter to identify the task and match it with the result<p>you will find the specified <code>tag</code> value in the <code>data</code> object of the response</p>
          nullable: true
      example:
        - language_code: en
          location_code: 2840
          keyword: albert einstein
          client: gws-wiz-serp
    SerpGoogleAutocompleteLiveAdvancedResultInfo:
      type: object
      properties:
        keyword:
          type: string
          description: <em>keyword received in a POST array<br></em><strong>the keyword is returned with decoded %## (plus character '+' will be decoded to a space character)</strong>
          nullable: true
        type:
          type: string
          description: type of element
          nullable: true
        se_domain:
          type: string
          description: <em>search engine domain in a POST array</em>
          nullable: true
        location_code:
          type: integer
          description: <em>location code in a POST array</em>
          nullable: true
        language_code:
          type: string
          description: <em>language code in a POST array</em>
          nullable: true
        check_url:
          type: string
          description: <em>direct URL to search engine results</em><br>you can use it to make sure that we provided accurate results
          nullable: true
        datetime:
          type: string
          description: '<em>date and time when the result was received</em><br>in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”<br>example:<br><code class="long-string">2019-11-15 12:57:46 +00:00</code>'
          nullable: true
        spell:
          type: object
          oneOf:
            - $ref: '#/components/schemas/SpellInfo'
          description: '<em>autocorrection of the search engine</em><br>if the search engine provided results for a keyword that was corrected, we will specify the keyword corrected by the search engine and the type of autocorrection;<br>in this case, will equal <code>null</code>'
          nullable: true
        refinement_chips:
          type: object
          oneOf:
            - $ref: '#/components/schemas/RefinementChipsInfo'
          description: <em>search refinement chips</em>
          nullable: true
        item_types:
          type: array
          items:
            type: string
            nullable: true
          description: <em>types of search results in SERP</em><br>contains types of search results (<code>items</code>) found in SERP.<br>possible item types:<br><code>autocomplete</code>
          nullable: true
        se_results_count:
          type: integer
          description: <em> total number of results in SERP</em>
          format: int64
          nullable: true
        items_count:
          type: integer
          description: <em>the number of results returned in the <strong><code>items</code></strong> array</em>
          format: int64
          nullable: true
        items:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/Autocomplete'
            nullable: true
          description: <em>items of the element</em>
          nullable: true
    SerpGoogleAutocompleteLiveAdvancedTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleAutocompleteLiveAdvancedResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    SerpGoogleAutocompleteLiveAdvancedResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleAutocompleteLiveAdvancedTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    SerpGoogleDatasetSearchTaskPostRequestInfo:
      type: object
      properties:
        keyword:
          type: string
          description: '<p><em>keyword</em><p><strong>required field</strong><p>you can specify <strong>up to 700 characters</strong> in the <code>keyword</code> field<p>all %## will be decoded (plus character ‘+’ will be decoded to a space character)<p>if you need to use the “%” character for your <code>keyword</code>, please specify it as “%25”;<p>if you need to use the “+” character for your <code>keyword</code>, please specify it as “%2B”.</p><br><p>learn more about rules and limitations of <code>keyword</code> and <code>keywords</code> fields in DataForSEO APIs in this <a href="https://dataforseo.com/help-center/rules-and-limitations-of-keyword-and-keywords-fields-in-dataforseo-apis" rel="noopener noreferrer" target="_blank">Help Center article</a></p>'
        language_code:
          type: string
          description: <p><em>search engine language code</em><p>optional field<p>possible value:<p><code class="long-string">en</code></p>
          nullable: true
        depth:
          type: integer
          description: '<p><em>parsing depth</em><p>optional field<p>number of results in SERP<p>default value: <code>20</code><p>max value: <code>700</code></p><br><strong>Your account will be billed per each SERP containing up to 20 results;</strong><p>Setting depth above 20 may result in additional charges if the search engine returns more than 20 results;<p>If the specified depth is higher than the number of results in the response, the difference will be refunded to your account balance automatically;'
          nullable: true
        priority:
          type: integer
          description: <p><em>task priority</em><p>optional field<p>can take the following values:<p>1 – normal execution priority (set by default)<p>2 – high execution priority</p><br>You will be additionally charged for the tasks with high execution priority.<p>The cost can be calculated on the <a title="Pricing" href="https://dataforseo.com/pricing/serp/google-dataset-search-serp-api" target="_blank" rel="noopener noreferrer">Pricing</a> page.
          nullable: true
        device:
          type: string
          description: '<p><em>device type</em><p>optional field<p>return results for a specific device type<p>possible value: <code>desktop</code></p>'
          nullable: true
        pingback_url:
          type: string
          description: '<p><em>notification URL of a completed task</em><p>optional field<p>when a task is completed we will notify you by GET request sent to the URL you have specified<p>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<p>example:<p><code>http://your-server.com/pingscript?id=$id</code><p><code>http://your-server.com/pingscript?id=$id&amp;tag=$tag</code><p><strong>Note:</strong> special characters in <code>pingback_url</code> will be urlencoded;<p>i.a., the <code>#</code> character will be encoded into <code>%23</code></p><br><p>learn more on our <a href="https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api" target="_blank" rel="noopener noreferrer">Help Center</a></p>'
          nullable: true
        postback_url:
          type: string
          description: '<p><em>URL for sending task results</em><p>optional field<p>once the task is completed, we will send a POST request with its results compressed in the <code>gzip</code> format to the <code>postback_url</code> you specified<p>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request<p>example:<p><code>http://your-server.com/postbackscript?id=$id</code><p><code>http://your-server.com/postbackscript?id=$id&amp;tag=$tag</code><p><strong>Note:</strong> special characters in <code>postback_url</code> will be urlencoded;<p>i.a., the <code>#</code> character will be encoded into <code>%23</code></p><br><p>learn more on our <a href="https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api" target="_blank" rel="noopener noreferrer">Help Center</a></p>'
          nullable: true
        postback_data:
          type: string
          description: '<p><em>postback_url datatype</em><p><strong>required field if you specify <code>postback_url</code></strong><p>corresponds to the datatype that will be sent to your server<p>only value: <code>advanced</code></p>'
        language_name:
          type: string
          description: '<p><em>full name of search engine language</em><p>optional field<p>if you use this field, you don''t need to specify <code>language_code</code><p>possible value:<p><code class="long-string">English</code></p>'
          nullable: true
        os:
          type: string
          description: '<p><em>device operating system</em><p>optional field<p>possible values: <code>windows</code>, <code>macos</code><p>default value: <code>windows</code></p>'
          nullable: true
        tag:
          type: string
          description: <p><em>user-defined task identifier</em><p>optional field<p><em>the character limit is 255</em><p>you can use this parameter to identify the task and match it with the result<p>you will find the specified <code>tag</code> value in the <code>data</code> object of the response</p>
          nullable: true
        last_updated:
          type: string
          description: '<p><em>last time the dataset was updated</em><p>optional field<p>possible values: <code>1m</code>, <code>1y</code>, <code>3y</code></p>'
          nullable: true
        file_formats:
          type: array
          items:
            type: string
          description: '<p><em>file formats of the dataset</em><p>optional field<p>possible values: <code>other</code>, <code>archive</code>, <code>text</code>, <code>image</code>, <code>document</code>, <code>tabular</code></p>'
          nullable: true
        usage_rights:
          type: string
          description: '<p><em>usage rights of the dataset</em><p>optional field<p>possible values: <code>commercial</code>, <code>noncommercial</code></p>'
          nullable: true
        is_free:
          type: boolean
          description: '<p><em>indicates whether displayed datasets are free</em><p>optional field<p>possible values: <code>true</code>, <code>false</code></p>'
          nullable: true
        topics:
          type: array
          items:
            type: string
          description: '<p><em>dataset topics</em><p>optional field<p>possible values: <code>humanities</code>, <code>social_sciences</code>, <code>life_sciences</code>, <code>agriculture</code>, <code>natural_sciences</code>, <code>geo</code>, <code>computer</code>, <code>architecture_and_urban_planning</code>, <code>engineering</code></p>'
          nullable: true
      example:
        - keyword: water quality
          last_updated: 1m
          file_formats:
            - archive
            - image
          usage_rights: noncommercial
          is_free: true
          topics:
            - natural_sciences
            - geo
    SerpGoogleDatasetSearchTaskPostTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: object
              description: '<em>array of results</em><br>in this case, the value will be <code>null</code>'
              nullable: true
    SerpGoogleDatasetSearchTaskPostResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleDatasetSearchTaskPostTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    SerpGoogleDatasetSearchTasksReadyResultInfo:
      type: object
      properties:
        id:
          type: string
          description: <em>task identifier of the completed task</em><br><strong>unique task identifier in our system in the <a href="https://en.wikipedia.org/wiki/Universally_unique_identifier">UUID</a> format</strong>
          nullable: true
        se:
          type: string
          description: <em>search engine specified when setting the task</em>
          nullable: true
        se_type:
          type: string
          description: '<em>type of search engine</em><br>example: <code>{{low_se_type_under}}</code>'
          nullable: true
        date_posted:
          type: string
          description: <em>date when the task was posted (in the UTC format)</em>
          nullable: true
        tag:
          type: string
          description: <em>user-defined task identifier</em>
          nullable: true
        endpoint_regular:
          type: string
          description: '<em>URL for collecting the results of the SERP Regular task</em><br>if SERP Regular is not supported in the specified endpoint, the value will be <code>null</code>'
          nullable: true
        endpoint_advanced:
          type: string
          description: '<em>URL for collecting the results of the SERP Advanced task</em><br>if SERP Advanced is not supported in the specified endpoint, the value will be <code>null</code>'
          nullable: true
        endpoint_html:
          type: string
          description: '<em>URL for collecting the results of the SERP HTML task</em><br>if SERP HTML is not supported in the specified endpoint, the value will be <code>null</code>'
          nullable: true
    SerpGoogleDatasetSearchTasksReadyTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleDatasetSearchTasksReadyResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    SerpGoogleDatasetSearchTasksReadyResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleDatasetSearchTasksReadyTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    SerpGoogleDatasetSearchTasksFixedResultInfo:
      type: object
      properties:
        id:
          type: string
          description: <em>task identifier of the completed task</em><br><strong>unique task identifier in our system in the <a href="https://en.wikipedia.org/wiki/Universally_unique_identifier">UUID</a> format</strong>
          nullable: true
        se:
          type: string
          description: <em>search engine specified when setting the task</em>
          nullable: true
        se_type:
          type: string
          description: '<em>type of search engine</em><br>can take the following values: <code>{{low_se_type_under}}</code>'
          nullable: true
        date_posted:
          type: string
          nullable: true
        tag:
          type: string
          description: <em>user-defined task identifier</em>
          nullable: true
        endpoint_regular:
          type: string
          description: '<em>URL for collecting the results of the SERP Regular task</em><br>if SERP Regular is not supported in the specified endpoint, the value will be <code>null</code>'
          nullable: true
        endpoint_advanced:
          type: string
          description: '<em>URL for collecting the results of the SERP Advanced task</em><br>if SERP Advanced is not supported in the specified endpoint, the value will be <code>null</code>'
          nullable: true
        endpoint_html:
          type: string
          description: '<em>URL for collecting the results of the SERP HTML task</em><br>if SERP HTML is not supported in the specified endpoint, the value will be <code>null</code>'
          nullable: true
    SerpGoogleDatasetSearchTasksFixedTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleDatasetSearchTasksFixedResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    SerpGoogleDatasetSearchTasksFixedResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleDatasetSearchTasksFixedTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    FormatsElement:
      type: object
      properties:
        type:
          type: string
          description: type of element
          nullable: true
        format:
          type: string
          description: '<em>type of file format of the dataset</em><br>for example: <code>zip</code>, <code>html</code>, <code>csv</code>'
          nullable: true
        size:
          type: integer
          description: <em>file size in bytes</em>
          format: int64
          nullable: true
    PeriodCovered:
      type: object
      properties:
        start_date:
          type: string
          description: '<em>date and time when the period starts</em><br>in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”<br>example:<br><code class="long-string">2020-03-02 02:00:00 +00:00</code>'
          nullable: true
        end_date:
          type: string
          description: '<em>date and time when the period ends</em><br>in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”<br>example:<br><code class="long-string">2022-12-09 02:00:00 +00:00</code>'
          nullable: true
        displayed_date:
          type: string
          description: '<em>period displayed in SERP</em><br>example:<br><code class="long-string">Mar 2, 2020 - Dec 9, 2022</code>'
          nullable: true
    DatasetDescription:
      type: object
      properties:
        text:
          type: string
          description: <em>text of the description</em>
          nullable: true
        links:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/LinkElement'
            nullable: true
          description: <em>links featured in the 'dataset_description'</em>
          nullable: true
    Dataset:
      type: object
      properties:
        type:
          type: string
          description: type of element
          nullable: true
        rank_group:
          type: integer
          description: <em>group rank in SERP</em><br>position within a group of elements with identical <code>type</code> values<br>positions of elements with different <code>type</code> values are omitted from <code>rank_group</code>
          nullable: true
        rank_absolute:
          type: integer
          description: <em>absolute rank in SERP</em><br>absolute position among all the elements in SERP
          nullable: true
        position:
          type: string
          description: '<em>the alignment of the element in SERP</em><br>can take the following values:<br><code>left</code>, <code>right</code>'
          nullable: true
        xpath:
          type: string
          description: <em>the <a href="https://en.wikipedia.org/wiki/XPath" rel="noopener noreferrer" target="_blank">XPath</a> of the element</em>
          nullable: true
        dataset_id:
          type: string
          description: <em>ID of the dataset</em>
          nullable: true
        title:
          type: string
          description: <em>title of the element</em>
          nullable: true
        image_url:
          type: string
          description: <em>URL of the image</em><br>the URL leading to the image on the original resource or DataForSEO storage (in case the original source is not available)
          nullable: true
        scholarly_citations_count:
          type: integer
          description: <em>count of articles that refer to the dataset</em>
          format: int64
          nullable: true
        scholarly_articles_url:
          type: string
          description: '<em>url of scholarly articles</em><br>link to the list of scholarly articles on Google Scholar <br>example: <code>https://scholar.google.com/scholar?q=%2210.6084%20m9%20figshare%207427933%20v1%22</code>'
          nullable: true
        unique_identifier:
          type: string
          description: '<em>digital identifier of an object</em><br>unique digital identifier of the dataset <br>example: <code>https://doi.org/10.5061/dryad.hmgqnk9m3</code>'
          nullable: true
        related_article:
          type: string
          description: <em>link to related article</em><br>link to the published article that is related to the dataset
          nullable: true
        links:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/LinkElement'
            nullable: true
          description: '<em>sitelinks</em><br>the links shown below some of Google Dataset''s search results<br>if there are none, equals <code>null</code>'
          nullable: true
        dataset_providers:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/AmazonLabelElement'
            nullable: true
          description: <em>the list of institutions that provided the dataset</em>
          nullable: true
        formats:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/FormatsElement'
            nullable: true
          description: <em>the list of file formats of the dataset</em>
          nullable: true
        authors:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/AuthorsElement'
            nullable: true
          description: <em>the list of authors of the dataset</em>
          nullable: true
        licenses:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/AmazonLabelElement'
            nullable: true
          description: <em>the list of licenses issued to the dataset</em>
          nullable: true
        updated_date:
          type: string
          description: '<em>date and time when the result was last updated</em><br>in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”<br>example:<br><code class="long-string">2022-11-27 02:00:00 +00:00</code>'
          nullable: true
        area_covered:
          type: array
          items:
            type: string
            nullable: true
          description: '<em>the list of areas covered in the dataset</em><br>for example: <code>Africa</code>, <code>Global</code>'
          nullable: true
        period_covered:
          type: object
          oneOf:
            - $ref: '#/components/schemas/PeriodCovered'
          description: <em>period covered in the dataset</em>
          nullable: true
        dataset_description:
          type: object
          oneOf:
            - $ref: '#/components/schemas/DatasetDescription'
          description: <em>description of the dataset</em>
          nullable: true
    SerpGoogleDatasetSearchTaskGetAdvancedResultInfo:
      type: object
      properties:
        keyword:
          type: string
          description: <em>keyword received in a POST array<br></em><strong>the keyword is returned with decoded %## (plus symbol '+' will be decoded to a space character)</strong>
          nullable: true
        se_domain:
          type: string
          description: <em>search engine domain in a POST array</em>
          nullable: true
        language_code:
          type: string
          description: <em>language code in a POST array</em>
          nullable: true
        check_url:
          type: string
          description: <em>direct URL to search engine results</em><br>you can use it to make sure that we provided accurate results
          nullable: true
        datetime:
          type: string
          description: '<em>date and time when the result was received</em><br>in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”<br>example:<br><code class="long-string">2019-11-15 12:57:46 +00:00</code>'
          nullable: true
        spell:
          type: object
          oneOf:
            - $ref: '#/components/schemas/SpellInfo'
          description: '<em>autocorrection of the search engine</em><br>if the search engine provided results for a keyword that was corrected, we will specify the keyword corrected by the search engine and the type of autocorrection'
          nullable: true
        item_types:
          type: array
          items:
            type: string
            nullable: true
          description: '<em>types of search results in SERP</em><br>contains types of search results (<code>items</code>) found in SERP.<br>possible item type: <code>dataset</code>'
          nullable: true
        se_results_count:
          type: integer
          description: <em> total number of results in SERP</em>
          format: int64
          nullable: true
        items_count:
          type: integer
          description: <em>the number of results returned in the <strong><code>items</code></strong> array</em>
          format: int64
          nullable: true
        items:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/Dataset'
            nullable: true
          description: <em>items of the element</em>
          nullable: true
    SerpGoogleDatasetSearchTaskGetAdvancedTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleDatasetSearchTaskGetAdvancedResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    SerpGoogleDatasetSearchTaskGetAdvancedResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleDatasetSearchTaskGetAdvancedTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    SerpGoogleDatasetSearchLiveAdvancedRequestInfo:
      type: object
      properties:
        keyword:
          type: string
          description: '<p><em>keyword</em><p><strong>required field</strong><p>you can specify <strong>up to 700 characters</strong> in the <code>keyword</code> field<p>all %## will be decoded (plus character ‘+’ will be decoded to a space character)<p>if you need to use the “%” character for your <code>keyword</code>, please specify it as “%25”;<p>if you need to use the “+” character for your <code>keyword</code>, please specify it as “%2B”;</p><br><p>learn more about rules and limitations of <code>keyword</code> and <code>keywords</code> fields in DataForSEO APIs in this <a href="https://dataforseo.com/help-center/rules-and-limitations-of-keyword-and-keywords-fields-in-dataforseo-apis" rel="noopener noreferrer" target="_blank">Help Center article</a></p>'
        language_code:
          type: string
          description: '<p><em>search engine language code</em><p>optional field if you don''t specify <code>language_name</code><p>if you use this field, you don''t need to specify <code>language_name</code><p>possible value:<p><code class="long-string">en</code></p>'
          nullable: true
        depth:
          type: integer
          description: '<p><em>parsing depth</em><p>optional field<p>number of results in SERP<p>default value: <code>20</code><p>max value: <code>200</code></p><br><strong>Your account will be billed per each SERP containing up to 20 results;</strong><p>Setting depth above 20 may result in additional charges if the search engine returns more than 20 results;<p>If the specified depth is higher than the number of results in the response, the difference will be refunded to your account balance automatically.'
          nullable: true
        device:
          type: string
          description: '<p><em>device type</em><p>optional field<p>return results for a specific device type<p>possible value: <code>desktop</code></p>'
          nullable: true
        language_name:
          type: string
          description: '<p><em>full name of search engine language</em><p>optional field<p>if you use this field, you don''t need to specify <code>language_code</code><p>possible value:<p><code class="long-string">English</code></p>'
          nullable: true
        os:
          type: string
          description: '<p><em>device operating system</em><p>optional field<p>choose from the following values: <code>windows</code>, <code>macos</code><p>default value: <code>windows</code></p>'
          nullable: true
        tag:
          type: string
          description: <p><em>user-defined task identifier</em><p>optional field<p><em>the character limit is 255</em><p>you can use this parameter to identify the task and match it with the result<p>you will find the specified <code>tag</code> value in the <code>data</code> object of the response</p>
          nullable: true
        last_updated:
          type: string
          description: '<p><em>last time the dataset was updated</em><p>optional field<p>possible values: <code>1m</code>, <code>1y</code>, <code>3y</code></p>'
          nullable: true
        file_formats:
          type: array
          items:
            type: string
          description: '<p><em>file formats of the dataset</em><p>optional field<p>possible values: <code>other</code>, <code>archive</code>, <code>text</code>, <code>image</code>, <code>document</code>, <code>tabular</code></p>'
          nullable: true
        usage_rights:
          type: string
          description: '<p><em>usage rights of the dataset</em><p>optional field<p>possible values: <code>commercial</code>, <code>noncommercial</code></p>'
          nullable: true
        is_free:
          type: boolean
          description: '<p><em>indicates whether displayed datasets are free</em><p>optional field<p>possible values: <code>true</code>, <code>false</code></p>'
          nullable: true
        topics:
          type: array
          items:
            type: string
          description: '<p><em>dataset topics</em><p>optional field<p>possible values: <code>humanities</code>, <code>social_sciences</code>, <code>life_sciences</code>, <code>agriculture</code>, <code>natural_sciences</code>, <code>geo</code>, <code>computer</code>, <code>architecture_and_urban_planning</code>, <code>engineering</code></p>'
          nullable: true
      example:
        - keyword: water quality
          last_updated: 1m
          file_formats:
            - archive
            - image
          usage_rights: noncommercial
          is_free: true
          topics:
            - natural_sciences
            - geo
    SerpGoogleDatasetSearchLiveAdvancedResultInfo:
      type: object
      properties:
        keyword:
          type: string
          description: <em>keyword received in a POST array<br></em><strong>the keyword is returned with decoded %## (plus character '+' will be decoded to a space character)</strong>
          nullable: true
        se_domain:
          type: string
          description: <em>search engine domain in a POST array</em>
          nullable: true
        language_code:
          type: string
          description: <em>language code in a POST array</em>
          nullable: true
        check_url:
          type: string
          description: <em>direct URL to search engine results</em><br>you can use it to make sure that we provided accurate results
          nullable: true
        datetime:
          type: string
          description: '<em>date and time when the result was received</em><br>in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”<br>example:<br><code class="long-string">2019-11-15 12:57:46 +00:00</code>'
          nullable: true
        spell:
          type: object
          oneOf:
            - $ref: '#/components/schemas/SpellInfo'
          description: '<em>autocorrection of the search engine</em><br>if the search engine provided results for a keyword that was corrected, we will specify the keyword corrected by the search engine and the type of autocorrection'
          nullable: true
        item_types:
          type: array
          items:
            type: string
            nullable: true
          description: '<em>types of search results in SERP</em><br>contains types of search results (<code>items</code>) found in SERP.<br>possible item type: <code>dataset</code>'
          nullable: true
        se_results_count:
          type: integer
          description: <em> total number of results in SERP</em>
          format: int64
          nullable: true
        items_count:
          type: integer
          description: <em>the number of results returned in the <strong><code>items</code></strong> array</em>
          format: int64
          nullable: true
        items:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/Dataset'
            nullable: true
          description: <em>items of the element</em>
          nullable: true
    SerpGoogleDatasetSearchLiveAdvancedTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleDatasetSearchLiveAdvancedResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    SerpGoogleDatasetSearchLiveAdvancedResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleDatasetSearchLiveAdvancedTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    SerpGoogleDatasetInfoTaskPostRequestInfo:
      type: object
      properties:
        dataset_id:
          type: string
          description: <p><em>ID of the dataset</em><p><strong>required field</strong><p>you can find dataset ID in the dataset URL or <code>dataset</code> item of <a href="https://docs.dataforseo.com/v3/serp/google/dataset_search/live/advanced">Google Dataset Search</a> result<p>example:<p><code>L2cvMTFqbl85ZHN6MQ==</code></p>
        language_code:
          type: string
          description: '<p><em>search engine language code</em><p>optional field<p>if you use this field, you don''t need to specify <code>language_name</code><p>possible value:<p><code class="long-string">en</code></p>'
          nullable: true
        priority:
          type: integer
          description: <p><em>task priority</em><p>optional field<p>can take the following values:<p>1 – normal execution priority (set by default)<p>2 – high execution priority</p><br>You will be additionally charged for the tasks with high execution priority.<p>The cost can be calculated on the <a title="Pricing" href="https://dataforseo.com/pricing/serp/google-dataset-info-serp-api" target="_blank" rel="noopener noreferrer">Pricing</a> page.
          nullable: true
        device:
          type: string
          description: '<p><em>device type</em><p>optional field<p>return results for a specific device type<p>possible value: <code>desktop</code></p>'
          nullable: true
        pingback_url:
          type: string
          description: '<p><em>notification URL of a completed task</em><p>optional field<p>when a task is completed we will notify you by GET request sent to the URL you have specified<p>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<p>example:<p><code>http://your-server.com/pingscript?id=$id</code><p><code>http://your-server.com/pingscript?id=$id&amp;tag=$tag</code><p><strong>Note:</strong> special characters in <code>pingback_url</code> will be urlencoded;<p>i.a., the <code>#</code> character will be encoded into <code>%23</code></p><br><p>learn more on our <a href="https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api" target="_blank" rel="noopener noreferrer">Help Center</a></p>'
          nullable: true
        postback_url:
          type: string
          description: '<p><em>URL for sending task results</em><p>optional field<p>once the task is completed, we will send a POST request with its results compressed in the <code>gzip</code> format to the <code>postback_url</code> you specified<p>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request<p>example:<p><code>http://your-server.com/postbackscript?id=$id</code><p><code>http://your-server.com/postbackscript?id=$id&amp;tag=$tag</code><p><strong>Note:</strong> special characters in <code>postback_url</code> will be urlencoded;<p>i.a., the <code>#</code> character will be encoded into <code>%23</code></p><br><p>learn more on our <a href="https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api" target="_blank" rel="noopener noreferrer">Help Center</a></p>'
          nullable: true
        postback_data:
          type: string
          description: '<p><em>postback_url datatype</em><p><strong>required field if you specify <code>postback_url</code></strong><p>corresponds to the datatype that will be sent to your server<p>possible value: <code>advanced</code></p>'
        language_name:
          type: string
          description: '<p><em>full name of search engine language</em><p>optional field<p>if you use this field, you don''t need to specify <code>language_code</code><p>possible value:<p><code class="long-string">English</code></p>'
          nullable: true
        os:
          type: string
          description: '<p><em>device operating system</em><p>optional field<p>choose from the following values: <code>windows</code>, <code>macos</code><p>default value: <code>windows</code></p>'
          nullable: true
        tag:
          type: string
          description: <p><em>user-defined task identifier</em><p>optional field<p><em>the character limit is 255</em><p>you can use this parameter to identify the task and match it with the result<p>you will find the specified <code>tag</code> value in the <code>data</code> object of the response</p>
          nullable: true
      example:
        - dataset_id: L2cvMTFqbl85ZHN6MQ==
    SerpGoogleDatasetInfoTaskPostTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: object
              description: '<em>array of results</em><br>in this case, the value will be <code>null</code>'
              nullable: true
    SerpGoogleDatasetInfoTaskPostResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleDatasetInfoTaskPostTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    SerpGoogleDatasetInfoTasksReadyResultInfo:
      type: object
      properties:
        id:
          type: string
          description: <em>task identifier of the completed task</em><br><strong>unique task identifier in our system in the <a href="https://en.wikipedia.org/wiki/Universally_unique_identifier">UUID</a> format</strong>
          nullable: true
        se:
          type: string
          description: <em>search engine specified when setting the task</em>
          nullable: true
        se_type:
          type: string
          description: '<em>type of search engine</em><br>example: <code>{{low_se_type_under}}</code>'
          nullable: true
        date_posted:
          type: string
          description: <em>date when the task was posted (in the UTC format)</em>
          nullable: true
        tag:
          type: string
          description: <em>user-defined task identifier</em>
          nullable: true
        endpoint_regular:
          type: string
          description: '<em>URL for collecting the results of the SERP Regular task</em><br>if SERP Regular is not supported in the specified endpoint, the value will be <code>null</code>'
          nullable: true
        endpoint_advanced:
          type: string
          description: '<em>URL for collecting the results of the SERP Advanced task</em><br>if SERP Advanced is not supported in the specified endpoint, the value will be <code>null</code>'
          nullable: true
        endpoint_html:
          type: string
          description: '<em>URL for collecting the results of the SERP HTML task</em><br>if SERP HTML is not supported in the specified endpoint, the value will be <code>null</code>'
          nullable: true
    SerpGoogleDatasetInfoTasksReadyTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleDatasetInfoTasksReadyResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    SerpGoogleDatasetInfoTasksReadyResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleDatasetInfoTasksReadyTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    SerpGoogleDatasetInfoTasksFixedResultInfo:
      type: object
      properties:
        id:
          type: string
          description: <em>task identifier of the completed task</em><br><strong>unique task identifier in our system in the <a href="https://en.wikipedia.org/wiki/Universally_unique_identifier">UUID</a> format</strong>
          nullable: true
        se:
          type: string
          description: <em>search engine specified when setting the task</em>
          nullable: true
        se_type:
          type: string
          description: '<em>type of search engine</em><br>can take the following values: <code>{{low_se_type_under}}</code>'
          nullable: true
        date_posted:
          type: string
          nullable: true
        tag:
          type: string
          description: <em>user-defined task identifier</em>
          nullable: true
        endpoint_regular:
          type: string
          description: '<em>URL for collecting the results of the SERP Regular task</em><br>if SERP Regular is not supported in the specified endpoint, the value will be <code>null</code>'
          nullable: true
        endpoint_advanced:
          type: string
          description: '<em>URL for collecting the results of the SERP Advanced task</em><br>if SERP Advanced is not supported in the specified endpoint, the value will be <code>null</code>'
          nullable: true
        endpoint_html:
          type: string
          description: '<em>URL for collecting the results of the SERP HTML task</em><br>if SERP HTML is not supported in the specified endpoint, the value will be <code>null</code>'
          nullable: true
    SerpGoogleDatasetInfoTasksFixedTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleDatasetInfoTasksFixedResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    SerpGoogleDatasetInfoTasksFixedResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleDatasetInfoTasksFixedTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    SerpGoogleDatasetInfoTaskGetAdvancedResultInfo:
      type: object
      properties:
        keyword:
          type: string
          description: <em>keyword received in a POST array<br></em><strong>the keyword is returned with decoded %## (plus symbol '+' will be decoded to a space character)</strong>
          nullable: true
        se_domain:
          type: string
          description: <em>search engine domain in a POST array</em>
          nullable: true
        language_code:
          type: string
          description: <em>language code in a POST array</em>
          nullable: true
        check_url:
          type: string
          description: <em>direct URL to search engine results</em><br>you can use it to make sure that we provided accurate results
          nullable: true
        datetime:
          type: string
          description: '<em>date and time when the result was received</em><br>in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”<br>example:<br><code class="long-string">2019-11-15 12:57:46 +00:00</code>'
          nullable: true
        spell:
          type: object
          oneOf:
            - $ref: '#/components/schemas/SpellInfo'
          description: '<em>autocorrection of the search engine</em><br>if the search engine provided results for a keyword that was corrected, we will specify the keyword corrected by the search engine and the type of autocorrection'
          nullable: true
        item_types:
          type: array
          items:
            type: string
            nullable: true
          description: '<em>types of search results in SERP</em><br>contains types of search results (<code>items</code>) found in SERP.<br>possible item type: <code>dataset</code>'
          nullable: true
        se_results_count:
          type: integer
          description: <em> total number of results in SERP</em>
          format: int64
          nullable: true
        items_count:
          type: integer
          description: <em>the number of results returned in the <strong><code>items</code></strong> array</em>
          format: int64
          nullable: true
        items:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/Dataset'
            nullable: true
          description: <em>elements of search results found in SERP</em>
          nullable: true
    SerpGoogleDatasetInfoTaskGetAdvancedTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleDatasetInfoTaskGetAdvancedResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    SerpGoogleDatasetInfoTaskGetAdvancedResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleDatasetInfoTaskGetAdvancedTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    SerpGoogleDatasetInfoLiveAdvancedRequestInfo:
      type: object
      properties:
        dataset_id:
          type: string
          description: <p><em>ID of the dataset</em><p><strong>required field</strong><p>you can find dataset ID in the dataset URL or <code>dataset</code> item of <a href="https://docs.dataforseo.com/v3/serp/google/dataset_search/live/advanced">Google Dataset Search</a> result<p>example:<p><code>L2cvMTFqbl85ZHN6MQ==</code></p>
        language_code:
          type: string
          description: '<p><em>search engine language code</em><p>optional field<p>if you use this field, you don''t need to specify <code>language_name</code><p>possible value:<p><code class="long-string">en</code></p>'
          nullable: true
        device:
          type: string
          description: '<p><em>device type</em><p>optional field<p>return results for a specific device type<p>possible value: <code>desktop</code></p>'
          nullable: true
        language_name:
          type: string
          description: '<p><em>full name of search engine language</em><p>optional field<p>if you use this field, you don''t need to specify <code>language_code</code><p>possible value:<p><code class="long-string">English</code></p>'
          nullable: true
        os:
          type: string
          description: '<p><em>device operating system</em><p>optional field<p>possible values: <code>windows</code>, <code>macos</code><p>default value: <code>windows</code></p>'
          nullable: true
        tag:
          type: string
          description: <p><em>user-defined task identifier</em><p>optional field<p><em>the character limit is 255</em><p>you can use this parameter to identify the task and match it with the result<p>you will find the specified <code>tag</code> value in the <code>data</code> object of the response</p>
          nullable: true
      example:
        - dataset_id: L2cvMTFqbl85ZHN6MQ==
    SerpGoogleDatasetInfoLiveAdvancedResultInfo:
      type: object
      properties:
        keyword:
          type: string
          description: <em>keyword received in a POST array<br></em><strong>the keyword is returned with decoded %## (plus character '+' will be decoded to a space character)</strong>
          nullable: true
        se_domain:
          type: string
          description: <em>search engine domain in a POST array</em>
          nullable: true
        language_code:
          type: string
          description: <em>language code in a POST array</em>
          nullable: true
        check_url:
          type: string
          description: <em>direct URL to search engine results</em><br>you can use it to make sure that we provided accurate results
          nullable: true
        datetime:
          type: string
          description: '<em>date and time when the result was received</em><br>in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”<br>example:<br><code class="long-string">2019-11-15 12:57:46 +00:00</code>'
          nullable: true
        spell:
          type: object
          oneOf:
            - $ref: '#/components/schemas/SpellInfo'
          description: '<em>autocorrection of the search engine</em><br>if the search engine provided results for a keyword that was corrected, we will specify the keyword corrected by the search engine and the type of autocorrection'
          nullable: true
        item_types:
          type: array
          items:
            type: string
            nullable: true
          description: '<em>types of search results in SERP</em><br>contains types of search results (<code>items</code>) found in SERP.<br>possible item type: <code>dataset</code>'
          nullable: true
        se_results_count:
          type: integer
          description: <em> total number of results in SERP</em>
          format: int64
          nullable: true
        items_count:
          type: integer
          description: <em>the number of results returned in the <strong><code>items</code></strong> array</em>
          format: int64
          nullable: true
        items:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/Dataset'
            nullable: true
          description: <em>elements of search results found in SERP</em>
          nullable: true
    SerpGoogleDatasetInfoLiveAdvancedTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleDatasetInfoLiveAdvancedResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    SerpGoogleDatasetInfoLiveAdvancedResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleDatasetInfoLiveAdvancedTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    SerpGoogleAdsAdvertisersLocationsResultInfo:
      type: object
      properties:
        location_code:
          type: integer
          description: <em>location code</em>
          nullable: true
        location_name:
          type: string
          description: <em>full name of the location</em>
          nullable: true
        location_code_parent:
          type: integer
          description: '<em>the code of the superordinate location</em><br>example:<br><code>"location_code": 9041134,<br>"location_name": "Vienna International Airport,Lower Austria,Austria",<br>"location_code_parent": 20044</code><p>where <code>location_code_parent</code> corresponds to:<p><code>"location_code": 20044,<br>"location_name": "Lower Austria,Austria"</code>'
          nullable: true
        country_iso_code:
          type: string
          description: <em>ISO country code of the location</em>
          nullable: true
        location_type:
          type: string
          description: <em>location type</em>
          nullable: true
    SerpGoogleAdsAdvertisersLocationsTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleAdsAdvertisersLocationsResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    SerpGoogleAdsAdvertisersLocationsResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleAdsAdvertisersLocationsTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    SerpGoogleAdsAdvertisersTaskPostRequestInfo:
      type: object
      properties:
        keyword:
          type: string
          description: '<p><em>keyword</em><p><strong>required field</strong><p>you can specify <strong>up to 700 characters</strong> in the <code>keyword</code> field<p>all %## will be decoded (plus character ‘+’ will be decoded to a space character)<p>if you need to use the “%” character for your <code>keyword</code>, please specify it as “%25”;<p>if you need to use the “+” character for your <code>keyword</code>, please specify it as “%2B”</p><br><p>learn more about rules and limitations of <code>keyword</code> and <code>keywords</code> fields in DataForSEO APIs in this <a href="https://dataforseo.com/help-center/rules-and-limitations-of-keyword-and-keywords-fields-in-dataforseo-apis" rel="noopener noreferrer" target="_blank">Help Center article</a></p>'
        priority:
          type: integer
          description: <p><em>task priority</em><p>optional field<p>can take the following values:<p>1 – normal execution priority (set by default)<p>2 – high execution priority</p><br>You will be additionally charged for the tasks with high execution priority.<p>The cost can be calculated on the <a title="Pricing" href="https://dataforseo.com/pricing/serp/google-ads-advertisers-serp-api" target="_blank" rel="noopener noreferrer">Pricing</a> page.
          nullable: true
        location_code:
          type: integer
          description: '<p><em>search engine location code</em><p>optional field<p><strong>if you use this field, you don''t need to specify <code>location_name</code> or <code>location_coordinate</code></strong><p>you can receive the list of available locations of the search engines with their <code>location_code</code> by making a separate request to the <code>https://api.dataforseo.com/v3/serp/google/ads_advertisers/locations</code><p>example:<p><code class="long-string">2840</code></p><br><p><strong>Note:</strong> if you don''t specify <code>location_name</code>, <code>location_code</code>, or <code>location_coordinate</code>, advertisers will be searched across all the available locations</p>'
          nullable: true
        pingback_url:
          type: string
          description: '<p><em>notification URL of a completed task</em><p>optional field<p>when a task is completed we will notify you by GET request sent to the URL you have specified<p>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<p>example:<p><code>http://your-server.com/pingscript?id=$id</code><p><code>http://your-server.com/pingscript?id=$id&amp;tag=$tag</code><p><strong>Note:</strong> special characters in <code>pingback_url</code> will be urlencoded;<p>i.a., the <code>#</code> character will be encoded into <code>%23</code></p><br><p>learn more on our <a href="https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api" target="_blank" rel="noopener noreferrer">Help Center</a></p>'
          nullable: true
        postback_url:
          type: string
          description: '<p><em>URL for sending task results</em><p>optional field<p>once the task is completed, we will send a POST request with its results compressed in the <code>gzip</code> format to the <code>postback_url</code> you specified<p>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<p>example:<p><code>http://your-server.com/postbackscript?id=$id</code><p><code>http://your-server.com/postbackscript?id=$id&amp;tag=$tag</code><p><strong>Note:</strong> special characters in <code>postback_url</code> will be urlencoded;<p>i.a., the <code>#</code> character will be encoded into <code>%23</code></p><br><p>learn more on our <a href="https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api" target="_blank" rel="noopener noreferrer">Help Center</a></p>'
          nullable: true
        postback_data:
          type: string
          description: <p><em>postback_url datatype</em><p><strong>required field if you specify <code>postback_url</code></strong><p>corresponds to the function you used for setting a task<p>possible values:<p><code>advanced</code></p>
        location_name:
          type: string
          description: '<p><em>full name of search engine location</em><p>optional field<p><strong>if you use this field, you don''t need to specify <code>location_code</code> or <code>location_coordinate</code></strong><p>you can receive the list of available locations of the search engine with their <code>location_name</code> by making a separate request to the <code>https://api.dataforseo.com/v3/serp/google/ads_advertisers/locations</code><p>example:<p><code class="long-string">London,England,United Kingdom</code></p><br><p><strong>Note:</strong> if you don''t specify <code>location_name</code>, <code>location_code</code>, or <code>location_coordinate</code>, advertisers will be searched across all the available locations</p>'
          nullable: true
        location_coordinate:
          type: string
          description: '<p><em>GPS coordinates of a location</em><p>optional field<p><strong>if you use this field, you don''t need to specify <code>location_name</code> or <code>location_code</code></strong><p>example:<p><code class="long-string">52.6178549,-155.352142</code></p><br><p><strong>Note:</strong> if you don''t specify <code>location_name</code>, <code>location_code</code>, or <code>location_coordinate</code>, advertisers will be searched across all the available locations</p>'
          nullable: true
        tag:
          type: string
          description: <p><em>user-defined task identifier</em><p>optional field<p><em>the character limit is 255</em><p>you can use this parameter to identify the task and match it with the result<p>you will find the specified <code>tag</code> value in the <code>data</code> object of the response</p>
          nullable: true
      example:
        - location_code: 2840
          keyword: apple
    SerpGoogleAdsAdvertisersTaskPostTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: object
              description: '<em>array of results</em><br>in this case, the value will be <code>null</code>'
              nullable: true
    SerpGoogleAdsAdvertisersTaskPostResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleAdsAdvertisersTaskPostTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    SerpGoogleAdsAdvertisersTasksReadyResultInfo:
      type: object
      properties:
        id:
          type: string
          description: <em>task identifier of the completed task</em><br><strong>unique task identifier in our system in the <a href="https://en.wikipedia.org/wiki/Universally_unique_identifier">UUID</a> format</strong>
          nullable: true
        se:
          type: string
          description: <em>search engine specified when setting the task</em>
          nullable: true
        se_type:
          type: string
          description: '<em>type of search engine</em><br>example: <code>{{low_se_type_under}}</code>'
          nullable: true
        date_posted:
          type: string
          description: <em>date when the task was posted (in the UTC format)</em>
          nullable: true
        tag:
          type: string
          description: <em>user-defined task identifier</em>
          nullable: true
        endpoint_regular:
          type: string
          description: '<em>URL for collecting the results of the SERP Regular task</em><br>if SERP Regular is not supported in the specified endpoint, the value will be <code>null</code>'
          nullable: true
        endpoint_advanced:
          type: string
          description: '<em>URL for collecting the results of the SERP Advanced task</em><br>if SERP Advanced is not supported in the specified endpoint, the value will be <code>null</code>'
          nullable: true
        endpoint_html:
          type: string
          description: '<em>URL for collecting the results of the SERP HTML task</em><br>if SERP HTML is not supported in the specified endpoint, the value will be <code>null</code>'
          nullable: true
    SerpGoogleAdsAdvertisersTasksReadyTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleAdsAdvertisersTasksReadyResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    SerpGoogleAdsAdvertisersTasksReadyResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleAdsAdvertisersTasksReadyTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    Advertiser:
      type: object
      properties:
        type:
          type: string
          description: type of element
          nullable: true
        advertiser_id:
          type: string
          description: <em>unique identifier of the advertiser account</em><br>can be used to obtain data on advertising campaigns from the <a href="/v3/serp/google/ads_search/task_post/" rel="noopener noreferrer" target="_blank">Google Ads Search endpoint</a>
          nullable: true
        location:
          type: string
          description: <em>location of the advertiser account</em><br>country code associated with the advertiser account
          nullable: true
        verified:
          type: boolean
          description: <em>verified advertiser account</em><br>equals <code>true</code> if advertiser account is verified by Google Ads
          nullable: true
        approx_ads_count:
          type: integer
          description: <em>ads count</em><br>the approximate number of ads that are run by the advertiser account across all available Google Ads platforms
          format: int64
          nullable: true
    SerpApiAdsMultiAccountAdvertiserElementItem:
      type: object
      allOf:
        - type: object
          oneOf:
            - $ref: '#/components/schemas/BaseSerpApiAdsAdvertiserElementItem'
          nullable: true
        - type: object
          properties:
            title:
              type: string
              description: <em>title of the element</em>
              nullable: true
            location:
              type: string
              description: <em>advertiser location</em>
              nullable: true
            approx_ads_count:
              type: integer
              description: <em>ads count</em><br>the approximate number of ads that are run by the advertiser across all available Google Ads platforms
              format: int64
              nullable: true
            advertisers:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/Advertiser'
                nullable: true
              description: <em>associated advertiser accounts</em><br>contains objects with data on associated advertiser accounts
              nullable: true
    SerpApiAdsAdvertiserElementItem:
      type: object
      allOf:
        - type: object
          oneOf:
            - $ref: '#/components/schemas/BaseSerpApiAdsAdvertiserElementItem'
          nullable: true
        - type: object
          properties:
            title:
              type: string
              description: <em>title of the element</em>
              nullable: true
            advertiser_id:
              type: string
              description: <em>unique identifier of the advertiser account</em><br>can be used to obtain data on advertising campaigns from the <a href="/v3/serp/google/ads_search/task_post/" rel="noopener noreferrer" target="_blank">Google Ads Search endpoint</a>
              nullable: true
            location:
              type: string
              description: <em>advertiser location</em>
              nullable: true
            verified:
              type: boolean
              description: <em>verified advertiser account</em><br>equals <code>true</code> if advertiser account is verified by Google Ads
              nullable: true
            approx_ads_count:
              type: integer
              description: <em>ads count</em><br>the approximate number of ads that are run by the advertiser across all available Google Ads platforms
              format: int64
              nullable: true
    SerpApiAdsDomainElementItem:
      type: object
      allOf:
        - type: object
          oneOf:
            - $ref: '#/components/schemas/BaseSerpApiAdsAdvertiserElementItem'
          nullable: true
        - type: object
          properties:
            domain:
              type: string
              description: <em>domain in SERP</em>
              nullable: true
    SerpGoogleAdsAdvertisersTaskGetAdvancedResultInfo:
      type: object
      properties:
        keyword:
          type: string
          description: <em>keyword received in a POST array<br></em><strong>the keyword is returned with decoded %## (plus symbol '+' will be decoded to a space character)</strong>
          nullable: true
        type:
          type: string
          description: type of element
          nullable: true
        se_domain:
          type: string
          description: <em>search engine domain in a POST array</em>
          nullable: true
        location_code:
          type: integer
          description: <em>location code in a POST array</em>
          nullable: true
        language_code:
          type: string
          description: <em>language code in a POST array</em>
          nullable: true
        check_url:
          type: string
          description: <em>direct URL to search engine results</em><br>you can use it to make sure that we provided accurate results
          nullable: true
        datetime:
          type: string
          description: '<em>date and time when the result was received</em><br>in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”<br>example:<br><code class="long-string">2019-11-15 12:57:46 +00:00</code>'
          nullable: true
        spell:
          type: object
          oneOf:
            - $ref: '#/components/schemas/SpellInfo'
          description: '<em>autocorrection of the search engine</em><br>if the search engine provided results for a keyword that was corrected, we will specify the keyword corrected by the search engine and the type of autocorrection;<br>in this case, equals <code>null</code>'
          nullable: true
        refinement_chips:
          type: object
          oneOf:
            - $ref: '#/components/schemas/RefinementChipsInfo'
          description: <em>search refinement chips</em>
          nullable: true
        item_types:
          type: array
          items:
            type: string
            nullable: true
          description: '<em>types of search results in SERP</em><br>contains types of search results (<code>items</code>) found in SERP.<br>possible item types:<br><code>ads_muti_account_advertiser</code>, <code>ads_advertiser</code>, <code>ads_domain</code>'
          nullable: true
        se_results_count:
          type: integer
          description: <em> total number of results in SERP</em>
          format: int64
          nullable: true
        items_count:
          type: integer
          description: <em>the number of results returned in the <strong><code>items</code></strong> array</em>
          format: int64
          nullable: true
        items:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/BaseSerpApiAdsAdvertiserElementItem'
            nullable: true
          description: <em>items of the element</em>
          nullable: true
    SerpGoogleAdsAdvertisersTaskGetAdvancedTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleAdsAdvertisersTaskGetAdvancedResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    SerpGoogleAdsAdvertisersTaskGetAdvancedResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleAdsAdvertisersTaskGetAdvancedTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    SerpGoogleAdsSearchLocationsResultInfo:
      type: object
      properties:
        location_code:
          type: integer
          description: <em>location code</em>
          nullable: true
        location_name:
          type: string
          description: <em>full name of the location</em>
          nullable: true
        location_code_parent:
          type: integer
          description: '<em>the code of the superordinate location</em><br>example:<br>`"location_code": 9041134`,<br>`"location_name": "Vienna International Airport,Lower Austria,Austria"`,<br>`"location_code_parent": 20044`<p>where `location_code_parent` corresponds to:<p>`"location_code": 20044`,<br>`"location_name": "Lower Austria,Austria"`'
          nullable: true
        country_iso_code:
          type: string
          description: <em>ISO country code of the location</em>
          nullable: true
        location_type:
          type: string
          description: <em>location type</em>
          nullable: true
    SerpGoogleAdsSearchLocationsTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleAdsSearchLocationsResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    SerpGoogleAdsSearchLocationsResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleAdsSearchLocationsTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    SerpGoogleAdsSearchTaskPostRequestInfo:
      type: object
      properties:
        advertiser_ids:
          type: array
          items:
            type: string
          description: <p><em>advertiser identifiers</em><p><strong>required field if <code>target</code> is not specified</strong></p><br><p>you can specify the maximum of 25 values in this array;<p><code>advertiser_ids</code> values for this parameter can be found in the <a href="http://docs.dataforseo.com/v3/serp/google/ads_advertisers/task_get/advanced/" rel="noopener noreferrer" target="_blank">Google Ads Advertisers</a> endpoint;</p>
        target:
          type: string
          description: <p><em>domain name</em><p><strong>required field if <code>advertiser_ids</code> is not specified</strong><p>domain name associated with an advertiser account</p>
        location_code:
          type: integer
          description: '<p><em>search engine location code</em><p>optional field<p><strong>if you use this field, you don''t need to specify <code>location_name</code> or <code>location_coordinate</code></strong><p>you can receive the list of available locations of the search engines with their <code>location_code</code> by making a separate request to the <code>https://api.dataforseo.com/v3/serp/google/ads_search/locations</code><p>example:<p><code class="long-string">2840</code></p><br><p><strong>Note:</strong> if you don''t specify <code>location_name</code>, <code>location_code</code>, or <code>location_coordinate</code>, the ads will be searched across all the available locations</p>'
          nullable: true
        depth:
          type: integer
          description: '<p><em>parsing depth</em><p>optional field<p>number of results in SERP<p>default value: <code>40</code><p>max value: <code>700</code></p><br><strong>Your account will be billed per each SERP containing up to 40 results;</strong><p>Setting depth above 40 may result in additional charges <a href="https://dataforseo.com/help-center/how-many-results-scraped" rel="noopener noreferrer" target="_blank">if the search engine returns more than 40 results</a>;<p>The cost can be calculated on the <a title="Pricing" href="https://dataforseo.com/pricing/serp/google-ads-search-serp-api" target="_blank" rel="noopener noreferrer">Pricing</a> page.'
          nullable: true
        priority:
          type: integer
          description: <p><em>task priority</em><p>optional field<p>can take the following values:<p>1 – normal execution priority (set by default)<p>2 – high execution priority</p><br>You will be additionally charged for the tasks with high execution priority.<p>The cost can be calculated on the <a title="Pricing" href="https://dataforseo.com/pricing/serp/google-ads-search-serp-api" target="_blank" rel="noopener noreferrer">Pricing</a> page.
          nullable: true
        pingback_url:
          type: string
          description: '<p><em>notification URL of a completed task</em><p>optional field<p>when a task is completed we will notify you by GET request sent to the URL you have specified<p>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<p>example:<p><code>http://your-server.com/pingscript?id=$id</code><p><code>http://your-server.com/pingscript?id=$id&amp;tag=$tag</code><p><strong>Note:</strong> special characters in <code>pingback_url</code> will be urlencoded;<p>i.a., the <code>#</code> character will be encoded into <code>%23</code></p><br><p>learn more on our <a href="https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api" target="_blank" rel="noopener noreferrer">Help Center</a></p>'
          nullable: true
        postback_url:
          type: string
          description: '<p><em>URL for sending task results</em><p>optional field<p>once the task is completed, we will send a POST request with its results compressed in the <code>gzip</code> format to the <code>postback_url</code> you specified<p>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<p>example:<p><code>http://your-server.com/postbackscript?id=$id</code><p><code>http://your-server.com/postbackscript?id=$id&amp;tag=$tag</code><p><strong>Note:</strong> special characters in <code>postback_url</code> will be urlencoded;<p>i.a., the <code>#</code> character will be encoded into <code>%23</code></p><br><p>learn more on our <a href="https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api" target="_blank" rel="noopener noreferrer">Help Center</a></p>'
          nullable: true
        postback_data:
          type: string
          description: <p><em>postback_url datatype</em><p><strong>required field if you specify <code>postback_url</code></strong><p>corresponds to the function you used for setting a task<p>possible values:<p><code>advanced</code></p>
        location_name:
          type: string
          description: '<p><em>full name of search engine location</em><p>optional field<p><strong>if you use this field, you don''t need to specify <code>location_code</code> or <code>location_coordinate</code></strong><p>you can receive the list of available locations of the search engine with their <code>location_name</code> by making a separate request to the <code>https://api.dataforseo.com/v3/serp/google/ads_search/locations</code><p>example:<p><code class="long-string">London,England,United Kingdom</code></p><br><p><strong>Note:</strong> if you don''t specify <code>location_name</code>, <code>location_code</code>, or <code>location_coordinate</code>, the ads will be searched across all the available locations</p>'
          nullable: true
        location_coordinate:
          type: string
          description: '<p><em>GPS coordinates of a location</em><p>optional field<p><strong>if you use this field, you don''t need to specify <code>location_name</code> or <code>location_code</code></strong><p>example:<p><code class="long-string">52.6178549,-155.352142</code></p><br><p><strong>Note:</strong> if you don''t specify <code>location_name</code>, <code>location_code</code>, or <code>location_coordinate</code>, the ads will be searched across all the available locations</p>'
          nullable: true
        tag:
          type: string
          description: <p><em>user-defined task identifier</em><p>optional field<p><em>the character limit is 255</em><p>you can use this parameter to identify the task and match it with the result<p>you will find the specified <code>tag</code> value in the <code>data</code> object of the response</p>
          nullable: true
        platform:
          type: string
          description: '<p><em>advertising platform</em><p>optional field<p>possible values: <code>all</code>, <code>google_play</code>, <code>google_maps</code>, <code>google_search</code>, <code>google_shopping</code>, <code>youtube</code><p>default value: <code>all</code></p>'
          nullable: true
        format:
          type: string
          description: '<p><em>ad format</em><p>optional field<p>possible values: <code>all</code>, <code>text</code>, <code>image</code>, <code>video</code></p>'
          nullable: true
        date_from:
          type: string
          description: '<p><em>starting date of the time range</em><p>optional field<p>required field if <code>date_to</code> is specified; </p><br><p>date format: <code>"yyyy-mm-dd"</code><p>minimum value: 2018-05-31<p>maximum value: today''s date<p>example:<p><code>"2020-01-01"</code></p>'
        date_to:
          type: string
          description: '<p><em>ending date of the time range</em><p>optional field<p>required field if <code>date_from</code> is specified; </p><br><p>date format: <code>"yyyy-mm-dd"</code><p>minimum value: 2018-05-31<p>maximum value: today''s date<p>example:<p><code>"2020-01-01"</code></p>'
      example:
        - location_code: 2840
          platform: google_search
          advertiser_ids:
            - AR13752565271262920705
            - AR02439908557932462081
    SerpGoogleAdsSearchTaskPostTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: object
              description: '<em>array of results</em><br>in this case, the value will be <code>null</code>'
              nullable: true
    SerpGoogleAdsSearchTaskPostResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleAdsSearchTaskPostTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    SerpGoogleAdsSearchTasksReadyResultInfo:
      type: object
      properties:
        id:
          type: string
          description: <em>task identifier of the completed task</em><br><strong>unique task identifier in our system in the <a href="https://en.wikipedia.org/wiki/Universally_unique_identifier">UUID</a> format</strong>
          nullable: true
        se:
          type: string
          description: <em>search engine specified when setting the task</em>
          nullable: true
        se_type:
          type: string
          description: '<em>type of search engine</em><br>example: <code>{{low_se_type_under}}</code>'
          nullable: true
        date_posted:
          type: string
          description: <em>date when the task was posted (in the UTC format)</em>
          nullable: true
        tag:
          type: string
          description: <em>user-defined task identifier</em>
          nullable: true
        endpoint_regular:
          type: string
          description: '<em>URL for collecting the results of the SERP Regular task</em><br>if SERP Regular is not supported in the specified endpoint, the value will be <code>null</code>'
          nullable: true
        endpoint_advanced:
          type: string
          description: '<em>URL for collecting the results of the SERP Advanced task</em><br>if SERP Advanced is not supported in the specified endpoint, the value will be <code>null</code>'
          nullable: true
        endpoint_html:
          type: string
          description: '<em>URL for collecting the results of the SERP HTML task</em><br>if SERP HTML is not supported in the specified endpoint, the value will be <code>null</code>'
          nullable: true
    SerpGoogleAdsSearchTasksReadyTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleAdsSearchTasksReadyResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    SerpGoogleAdsSearchTasksReadyResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleAdsSearchTasksReadyTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    PreviewImage:
      type: object
      properties:
        url:
          type: string
          description: <em>search URL with refinement parameters</em>
          nullable: true
        height:
          type: integer
          description: <em>height of the preview image</em>
          nullable: true
        width:
          type: integer
          description: <em>width of the preview image</em>
          format: int64
          nullable: true
    AdsSearch:
      type: object
      properties:
        type:
          type: string
          description: type of element
          nullable: true
        rank_group:
          type: integer
          description: <em>group rank in SERP</em><br>position within a group of elements with identical <code>type</code> values<br>positions of elements with different <code>type</code> values are omitted from <code>rank_group</code>
          nullable: true
        rank_absolute:
          type: integer
          description: <em>absolute rank in SERP</em><br>absolute position among all the elements in SERP
          nullable: true
        advertiser_id:
          type: string
          description: <em>unique identifier of the advertiser account</em>
          nullable: true
        creative_id:
          type: string
          description: <em>unique identifier of the advertisement</em>
          nullable: true
        title:
          type: string
          description: <em>title of the element</em>
          nullable: true
        url:
          type: string
          description: <em>search URL with refinement parameters</em>
          nullable: true
        verified:
          type: boolean
          description: <em>verified advertiser account</em><br>equals <code>true</code> if advertiser account is verified by Google Ads
          nullable: true
        format:
          type: string
          description: '<em>format of the advertisement</em><br>possible values: <code>text</code>, <code>image</code>, <code>video</code>'
          nullable: true
        preview_image:
          type: object
          oneOf:
            - $ref: '#/components/schemas/PreviewImage'
          description: <em>preview image of the advertisement</em>
          nullable: true
        preview_url:
          type: string
          description: <em>url pointing to the ad preview</em>
          nullable: true
        first_shown:
          type: string
          description: '<em>date and time when the ad was shown for the first time</em><br>in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”'
          nullable: true
        last_shown:
          type: string
          description: '<em>date and time when the ad was shown the last time</em><br>in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”'
          nullable: true
    SerpGoogleAdsSearchTaskGetAdvancedResultInfo:
      type: object
      properties:
        keyword:
          type: string
          description: <em>keyword received in a POST array<br></em><strong>the keyword is returned with decoded %## (plus symbol '+' will be decoded to a space character)</strong>
          nullable: true
        type:
          type: string
          description: type of element
          nullable: true
        se_domain:
          type: string
          description: <em>search engine domain in a POST array</em>
          nullable: true
        location_code:
          type: integer
          description: <em>location code in a POST array</em>
          nullable: true
        language_code:
          type: string
          description: <em>language code in a POST array</em>
          nullable: true
        check_url:
          type: string
          description: '<em>direct URL to search engine results</em><br>in this case, equals <code>null</code>'
          nullable: true
        datetime:
          type: string
          description: '<em>date and time when the result was received</em><br>in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”<br>example:<br><code class="long-string">2019-11-15 12:57:46 +00:00</code>'
          nullable: true
        spell:
          type: object
          oneOf:
            - $ref: '#/components/schemas/SpellInfo'
          description: '<em>autocorrection of the search engine</em><br>if the search engine provided results for a keyword that was corrected, we will specify the keyword corrected by the search engine and the type of autocorrection;<br>in this case, equals <code>null</code>'
          nullable: true
        refinement_chips:
          type: object
          oneOf:
            - $ref: '#/components/schemas/RefinementChipsInfo'
          description: <em>search refinement chips</em>
          nullable: true
        item_types:
          type: array
          items:
            type: string
            nullable: true
          description: <em>types of search results in SERP</em><br>contains types of search results (<code>items</code>) found in SERP.<br>possible item types:<br><code>ads_search</code>
          nullable: true
        se_results_count:
          type: integer
          description: <em> total number of results in SERP</em>
          format: int64
          nullable: true
        items_count:
          type: integer
          description: <em>the number of results returned in the <strong><code>items</code></strong> array</em>
          format: int64
          nullable: true
        items:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/AdsSearch'
            nullable: true
          description: <em>items of the element</em>
          nullable: true
    SerpGoogleAdsSearchTaskGetAdvancedTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleAdsSearchTaskGetAdvancedResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    SerpGoogleAdsSearchTaskGetAdvancedResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleAdsSearchTaskGetAdvancedTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    SerpBingLocationsResultInfo:
      type: object
      properties:
        location_code:
          type: integer
          description: <em>location code</em>
          nullable: true
        location_name:
          type: string
          description: <em>full name of the location</em>
          nullable: true
        location_code_parent:
          type: integer
          description: '<em>the code of the superordinate location</em><br>example:<br>`"location_code": 9041134`,<br>`"location_name": "Vienna International Airport,Lower Austria,Austria"`,<br>`"location_code_parent": 20044`<p>where `location_code_parent` corresponds to:<p>`"location_code": 20044`,<br>`"location_name": "Lower Austria,Austria"`'
          nullable: true
        country_iso_code:
          type: string
          description: <em>ISO country code of the location</em>
          nullable: true
        location_type:
          type: string
          description: '<em>location type</em><br>indicates the geographic classification of the location<br>example:<br>`"location_type": "Country"`, or `"location_type": "State"`'
          nullable: true
    SerpBingLocationsTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpBingLocationsResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    SerpBingLocationsResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpBingLocationsTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    SerpBingLocationsCountryResultInfo:
      type: object
      properties:
        location_code:
          type: integer
          description: <em>location code</em>
          nullable: true
        location_name:
          type: string
          description: <em>full name of the location</em>
          nullable: true
        location_code_parent:
          type: integer
          description: '<em>the code of the superordinate location</em><br>example:<br>`"location_code": 9041134`,<br>`"location_name": "Vienna International Airport,Lower Austria,Austria"`,<br>`"location_code_parent": 20044`<p>where `location_code_parent` corresponds to:<p>`"location_code": 20044`,<br>`"location_name": "Lower Austria,Austria"`'
          nullable: true
        country_iso_code:
          type: string
          description: <em>ISO country code of the location</em>
          nullable: true
        location_type:
          type: string
          description: '<em>location type</em><br>indicates the geographic classification of the location<br>example:<br>`"location_type": "Country"`, or `"location_type": "State"`'
          nullable: true
    SerpBingLocationsCountryTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpBingLocationsCountryResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    SerpBingLocationsCountryResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpBingLocationsCountryTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    SerpBingLanguagesResultInfo:
      type: object
      properties:
        language_name:
          type: string
          description: <em>language name</em>
          nullable: true
        language_code:
          type: string
          description: <em>language code according to <a href="https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes" target="_blank" rel="noopener noreferrer">ISO 639-1</a></em>
          nullable: true
    SerpBingLanguagesTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpBingLanguagesResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    SerpBingLanguagesResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpBingLanguagesTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    SerpBingOrganicTaskPostRequestInfo:
      type: object
      properties:
        keyword:
          type: string
          description: '<p><em>keyword</em><p><strong>required field</strong><p>you can specify <strong>up to 700 characters</strong> in the <code>keyword</code> field<p><strong>all %## will be decoded (plus character ''+'' will be decoded to a space character)</strong><p>if you need to use the "%" character for your <code>keyword</code>, please specify it as "%25";<p>if you need to use the “+” character for your <code>keyword</code>, please specify it as “%2B”</p><br><p>learn more about rules and limitations of <code>keyword</code> and <code>keywords</code> fields in DataForSEO APIs in this <a href="https://dataforseo.com/help-center/rules-and-limitations-of-keyword-and-keywords-fields-in-dataforseo-apis" rel="noopener noreferrer" target="_blank">Help Center article</a></p>'
        location_code:
          type: integer
          description: '<p><em>search engine location code</em><p><strong>required field if you don''t specify</strong> <code>location_name</code>&nbsp;or <code>location_coordinate</code><p><strong>if you use this field, you don''t need to specify <code>location_name</code> or <code>location_coordinate</code></strong><p>you can receive the list of available locations of the search engines with their <code>location_code</code> by making a separate request to the <code>https://api.dataforseo.com/v3/serp/{{low_se_name}}/locations</code><p>example:<p><code class="long-string">2840</code></p>'
        language_code:
          type: string
          description: '<p><em>search engine language code</em><p><strong>required field if you don''t specify</strong> <code>language_name</code><p><strong>if you use this field, you don''t need to specify <code>language_name</code></strong><p>you can receive the list of available languages of the search engine with their <code>language_code</code>&nbsp;by making a separate request to the <code>https://api.dataforseo.com/v3/serp/{{low_se_name}}/languages</code><em><p></em>example:<em><p></em><code class="long-string">en</code></p>'
        depth:
          type: integer
          description: '<p><em>parsing depth</em><p>optional field<p>number of results in SERP<p>default value: <code>10</code><p>max value: <code>700</code></p><br><strong>Your account will be billed per each SERP containing up to 10 results;</strong><p>Setting depth above 10 may result in additional charges <a href="https://dataforseo.com/help-center/how-many-results-scraped" rel="noopener noreferrer" target="_blank">if the search engine returns more than 10 results</a>;<p>The cost can be calculated on the <a title="Pricing" href="https://dataforseo.com/pricing/serp/bing-organic-serp-api" target="_blank" rel="noopener noreferrer">Pricing</a> page.'
          nullable: true
        priority:
          type: integer
          description: <p><em>task priority</em><p>optional field<p>can take the following values:<p>1 – normal execution priority (set by default)<p>2 – high execution priority</p><br>You will be additionally charged for the tasks with high execution priority.<p>The cost can be calculated on the <a title="Pricing" href="https://dataforseo.com/pricing/serp/bing-organic-serp-api" target="_blank" rel="noopener noreferrer">Pricing</a> page.
          nullable: true
        device:
          type: string
          description: '<p><em>device type</em><p>optional field<p>return results for a specific device type<p>can take the values:<code>desktop</code>, <code>mobile</code><p>default value: <code>desktop</code></p>'
          nullable: true
        pingback_url:
          type: string
          description: '<p><em>notification URL of a completed task</em><p>optional field<p>when a task is completed we will notify you by GET request sent to the URL you have specified<p>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<p>example:<p><code>http://your-server.com/pingscript?id=$id</code><p><code>http://your-server.com/pingscript?id=$id&amp;tag=$tag</code><p><strong>Note:</strong> special characters in <code>pingback_url</code> will be urlencoded;<p>i.a., the <code>#</code> character will be encoded into <code>%23</code></p><br><p>learn more on our <a href="https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api" target="_blank" rel="noopener noreferrer">Help Center</a></p>'
          nullable: true
        postback_url:
          type: string
          description: '<p><em>URL for sending task results</em><p>optional field<p>once the task is completed, we will send a POST request with its results compressed in the <code>gzip</code> format to the <code>postback_url</code> you specified<p>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<p>example:<p><code>http://your-server.com/postbackscript?id=$id</code><p><code>http://your-server.com/postbackscript?id=$id&amp;tag=$tag</code><p><strong>Note:</strong> special characters in <code>postback_url</code> will be urlencoded;<p>i.a., the <code>#</code> character will be encoded into <code>%23</code></p><br><p>learn more on our <a href="https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api" target="_blank" rel="noopener noreferrer">Help Center</a></p>'
          nullable: true
        postback_data:
          type: string
          description: '<p><em>postback_url datatype</em><p><strong>required field if you specify <code>postback_url</code></strong><p>corresponds to the datatype that will be sent to your server<p>possible values:<p><code>regular</code>, <code>advanced</code>, <code>html</code></p>'
        location_name:
          type: string
          description: '<p><em>full name of search engine location</em><p><strong>required field if you don''t specify</strong> <code>location_code</code> or <code>location_coordinate</code><p><strong>if you use this field, you don''t need to specify <code>location_code</code> or <code>location_coordinate</code></strong><p>you can receive the list of available locations of the search engine with their <code>location_name</code> by making a separate request to the <code>https://api.dataforseo.com/v3/serp/{{low_se_name}}/locations</code><p>example:<p><code class="long-string">London,England,United Kingdom</code></p>'
        language_name:
          type: string
          description: '<p><em>full name of search engine language</em><p><strong>required field if you don''t specify</strong> <code>language_code</code><p><strong>if you use this field, you don''t need to specify <code>language_code</code></strong><p>you can receive the list of available languages of the search engine with their <code>language_name</code> by making a separate request to the <code>https://api.dataforseo.com/v3/serp/{{low_se_name}}/languages</code><p>example:<p><code class="long-string">English</code></p>'
        os:
          type: string
          description: '<p><em>device operating system</em><p>optional field<p>if you specify <code>desktop</code> in the <code>device</code> field, choose from the following values: <code>windows</code>, <code>macos</code><p>default value: <code>windows</code><p>if you specify <code>mobile</code> in the <code>device</code> field, choose from the following values: <code>android</code>, <code>ios</code><p>default value: <code>android</code></p>'
          nullable: true
        tag:
          type: string
          description: <p><em>user-defined task identifier</em><p>optional field<p><em>the character limit is 255</em><p>you can use this parameter to identify the task and match it with the result<p>you will find the specified <code>tag</code> value in the <code>data</code> object of the response</p>
          nullable: true
        stop_crawl_on_match:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/SerpApiStopCrawlOnMatchInfo'
            nullable: true
          description: "array of targets to stop crawling\noptional field\nif specified, the response will contain SERP results up to and including the specified match_value;\nyou can specify up to 10 target values in this array\nexample:\n\"stop_crawl_on_match\":[{\"match_value\":\"dataforseo.com\",\"match_type\":\"with_subdomains\"}]\nlearn more about this parameter on our Help Center - https://dataforseo.com/help-center/using-the-stop_crawl_on_match-parameter-in-serp-api\nYour account will be billed per each SERP crawled through the specified targets"
          nullable: true
        match_type:
          type: string
          description: <p><em>target match type</em><p><strong>required field if <code>stop_crawl_on_match</code> is specified</strong><p>type of match for the <code>match_value</code><p>possible values:<p><code>domain</code> – specific domain or subdomain<p><code>with_subdomains</code> – main domain and subdomains<p><code>wildcard</code> –  wildcard pattern</p>
        match_value:
          type: string
          description: '<p><em>target domain, subdomain, or wildcard value</em><p><strong>required field if <code>stop_crawl_on_match</code> is specified</strong><p>specify a target domain, subdomain, or wildcard value;<p><strong>Note:</strong> domain or subdomain must be specified without a request protocol;<p>example: <code>"match_value": "dataforseo.com"</code>,<p><code>"match_value": "/blog/post-*"</code></p>'
        max_crawl_pages:
          type: integer
          description: '<p><em>page crawl limit</em><p>optional field<p>number of search results pages to crawl<p>default value: <code>1</code><p>max value: <code>100</code><p><strong>Note:</strong> the <code>max_crawl_pages</code> and <code>depth</code> parameters complement each other;<p>learn more at <a href="https://dataforseo.com/help-center/what-is-max-crawl-pages-and-how-does-it-work" target="_blank" rel="noopener noreferrer">our help center</a></p>'
          nullable: true
        search_param:
          type: string
          description: <p><em>additional parameters of the search query</em><p>optional field<p><a href="https://dataforseo.com/help-center/bing-search-engine-parameters-and-how-to-use-them">get the list of available parameters and additional details here</a></p>
          nullable: true
        calculate_rectangles:
          type: boolean
          description: '<p><em>calcualte pixel rankings for SERP elements in advanced results</em><p>optional field<p>pixel ranking refers to the distance between the result snippet and top left corner of the screen;<p><a href="https://dataforseo.com/help-center/pixel-ranking-in-serp-api">Visit Help Center to learn more&gt;&gt;</a><p>by default, the parameter is set to <code>false</code><p><strong>Note:</strong> you will be charged extra $0.0006 for using this parameter</p>'
          nullable: true
        browser_screen_width:
          type: integer
          description: '<p><em>browser screen width</em><p>optional field<p>you can set a custom browser screen width to calculate pixel rankings for a particular device;<p>can be specified within the following range: <code>240-9999</code>;<p>by default, the parameter is set to:<p><code>1920</code> for <code>desktop</code>;<p><code>360</code> for <code>mobile</code> on <code>android</code>;<p><code>375</code> for <code>mobile</code> on <code>iOS</code>;<p><strong>Note:</strong> to use this parameter, set <code>calculate_rectangles</code> to <code>true</code></p>'
          format: int64
          nullable: true
        browser_screen_height:
          type: integer
          description: '<p><em>browser screen height</em><p>optional field<p>you can set a custom browser screen height to calculate pixel rankings for a particular device;<p>can be specified within the following range: <code>240-9999</code>;<p>by default, the parameter is set to:<p><code>1080</code> for <code>desktop</code>;<p><code>640</code> for <code>mobile</code> on <code>android</code>;<p><code>812</code> for <code>mobile</code> on <code>iOS</code>;<p><strong>Note:</strong> to use this parameter, set <code>calculate_rectangles</code> to <code>true</code></p>'
          nullable: true
        browser_screen_resolution_ratio:
          type: integer
          description: '<p><em>browser screen resolution ratio</em><p>optional field<p>you can set a custom browser screen resolution ratio to calculate pixel rankings for a particular device;<p>can be specified within the following range: <code>0.5-3</code>;<p>by default, the parameter is set to:<p><code>1</code> for <code>desktop</code>;<p><code>3</code> for <code>mobile</code> on <code>android</code>;<p><code>3</code> for <code>mobile</code> on <code>iOS</code>;<p><strong>Note:</strong> to use this parameter, set <code>calculate_rectangles</code> to <code>true</code></p>'
          nullable: true
        url:
          type: string
          description: '<p><em>direct URL of the search query</em><p>optional field<p>you can specify a direct URL and we will sort it out to the necessary fields. Note that this method is the most difficult for our API to process and also requires you to specify the exact language and location in the URL. In most cases, we wouldn’t recommend using this method.<p>example:<p><code class="long-string">https://www.bing.com/search?q=rank%20checker&amp;count=50&amp;first=1&amp;setlang=en&amp;cc=US&amp;safesearch=Moderate&amp;FORM=SEPAGE</code></p>'
          nullable: true
        location_coordinate:
          type: string
          description: '<p><em>GPS coordinates of a location</em><p><strong>required field if you don''t specify</strong> <code>location_name</code>&nbsp;or <code>location_code</code><p><strong>if you use this field, you don''t need to specify <code>location_name</code> or <code>location_code</code></strong><p><code>location_coordinate</code> parameter should be specified in the <em>"latitude,longitude"</em> format<p>the maximum number of decimal digits for <em>"latitude"</em> and <em>"longitude"</em>: 7<p>example:<p><code class="long-string">53.476225,-2.243572</code></p>'
      example:
        - language_code: en
          location_code: 2840
          keyword: albert einstein
    SerpBingOrganicTaskPostTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: object
              description: '<em>array of results</em><br>in this case, the value will be <code>null</code>'
              nullable: true
    SerpBingOrganicTaskPostResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpBingOrganicTaskPostTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    SerpBingOrganicTasksReadyResultInfo:
      type: object
      properties:
        id:
          type: string
          description: <em>task identifier of the completed task</em><br><strong>unique task identifier in our system in the <a href="https://en.wikipedia.org/wiki/Universally_unique_identifier">UUID</a> format</strong>
          nullable: true
        se:
          type: string
          description: <em>search engine specified when setting the task</em>
          nullable: true
        se_type:
          type: string
          description: '<em>type of search engine</em><br>example: <code>{{low_se_type_under}}</code>'
          nullable: true
        date_posted:
          type: string
          description: <em>date when the task was posted (in the UTC format)</em>
          nullable: true
        tag:
          type: string
          description: <em>user-defined task identifier</em>
          nullable: true
        endpoint_regular:
          type: string
          description: '<em>URL for collecting the results of the SERP Regular task</em><br>if SERP Regular is not supported in the specified endpoint, the value will be <code>null</code>'
          nullable: true
        endpoint_advanced:
          type: string
          description: '<em>URL for collecting the results of the SERP Advanced task</em><br>if SERP Advanced is not supported in the specified endpoint, the value will be <code>null</code>'
          nullable: true
        endpoint_html:
          type: string
          description: '<em>URL for collecting the results of the SERP HTML task</em><br>if SERP HTML is not supported in the specified endpoint, the value will be <code>null</code>'
          nullable: true
    SerpBingOrganicTasksReadyTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpBingOrganicTasksReadyResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    SerpBingOrganicTasksReadyResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpBingOrganicTasksReadyTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    SerpBingOrganicTasksFixedResultInfo:
      type: object
      properties:
        id:
          type: string
          description: <em>task identifier of the completed task</em><br><strong>unique task identifier in our system in the <a href="https://en.wikipedia.org/wiki/Universally_unique_identifier">UUID</a> format</strong>
          nullable: true
        se:
          type: string
          description: <em>search engine specified when setting the task</em>
          nullable: true
        se_type:
          type: string
          description: '<em>type of search engine</em><br>can take the following values: <code>{{low_se_type_under}}</code>'
          nullable: true
        date_posted:
          type: string
          nullable: true
        tag:
          type: string
          description: <em>user-defined task identifier</em>
          nullable: true
        endpoint_regular:
          type: string
          description: '<em>URL for collecting the results of the SERP Regular task</em><br>if SERP Regular is not supported in the specified endpoint, the value will be <code>null</code>'
          nullable: true
        endpoint_advanced:
          type: string
          description: '<em>URL for collecting the results of the SERP Advanced task</em><br>if SERP Advanced is not supported in the specified endpoint, the value will be <code>null</code>'
          nullable: true
        endpoint_html:
          type: string
          description: '<em>URL for collecting the results of the SERP HTML task</em><br>if SERP HTML is not supported in the specified endpoint, the value will be <code>null</code>'
          nullable: true
    SerpBingOrganicTasksFixedTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpBingOrganicTasksFixedResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    SerpBingOrganicTasksFixedResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpBingOrganicTasksFixedTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    BingOrganicSerpElementItem:
      type: object
      allOf:
        - type: object
          oneOf:
            - $ref: '#/components/schemas/BaseBingSerpApiElementItem'
          nullable: true
        - type: object
          properties:
            domain:
              type: string
              description: <em>domain in SERP</em>
              nullable: true
            title:
              type: string
              description: <em>title of the results element in SERP</em>
              nullable: true
            description:
              type: string
              description: <em>description of the results element in SERP</em>
              nullable: true
            url:
              type: string
              description: <em> relevant URL in SERP</em>
              nullable: true
            breadcrumb:
              type: string
              description: <em>breadcrumb in SERP</em>
              nullable: true
            cache_url:
              type: string
              description: <em>cached version of the page</em>
              nullable: true
            related_search_url:
              type: string
              description: <em>URL to a similar search</em><br>            URL to a new search for the same keyword(s) on related sites
              nullable: true
            website_name:
              type: string
              description: <em>name of the source website</em>
              nullable: true
            is_image:
              type: boolean
              description: <em>indicates whether the element contains an <code class="prettyprint">image</code></em>
              nullable: true
            is_video:
              type: boolean
              description: <em>indicates whether the element contains a <code class="prettyprint">video</code></em>
              nullable: true
            is_featured_snippet:
              type: boolean
              description: <em>indicates whether the element is a <code class="prettyprint">featured_snippet</code></em>
              nullable: true
            is_malicious:
              type: boolean
              description: <em>indicates whether the element is marked as malicious</em>
              nullable: true
            is_web_story:
              type: boolean
              description: <em>indicates whether the element is marked as a web story</em>
              nullable: true
            checks:
              type: array
              items:
                type: string
                description: <em>indicates whether the element contains a <code class="prettyprint">video</code></em>
                nullable: true
              nullable: true
            pre_snippet:
              type: string
              description: <em>includes additional information appended before the result description in SERP</em>
              nullable: true
            extended_snippet:
              type: string
              description: <em>includes additional information appended after the result description in SERP</em>
              nullable: true
            images:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AiModeImagesElementInfo'
                nullable: true
              description: <em>images of the element</em>
              nullable: true
            amp_version:
              type: boolean
              description: <em>Accelerated Mobile Pages</em><br>            indicates whether an item has the Accelerated Mobile Page (AMP) version
              nullable: true
            rating:
              type: object
              oneOf:
                - $ref: '#/components/schemas/RatingInfo'
              description: <em>the item's rating </em><br>            the popularity rate based on reviews and displayed in SERP
              nullable: true
            price:
              type: object
              oneOf:
                - $ref: '#/components/schemas/PriceInfo'
              description: <em>pricing details</em><br>            contains the pricing details of the product or service featured in the result
              nullable: true
            highlighted:
              type: array
              items:
                type: string
                nullable: true
              description: <em>words highlighted in bold within the results <code>description</code></em>
              nullable: true
            links:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/LinkElement'
                nullable: true
              description: '<em>sitelinks</em><br>            the links shown below some search results<br>            if there are none, equals <code>null</code>'
              nullable: true
            faq:
              type: object
              oneOf:
                - $ref: '#/components/schemas/FaqBox'
              description: '<em>frequently asked questions</em><br>            questions and answers extension shown below some search results<br>            if there are none, equals <code>null</code>'
              nullable: true
              deprecated: true
            extended_people_also_search:
              type: array
              items:
                type: string
                nullable: true
              description: <em>extension of the organic element</em><br>            extension of the organic result containing related search queries<br>            <strong>Note:</strong> extension appears in SERP upon clicking on the result and then bouncing back to search results
              nullable: true
            about_this_result:
              type: object
              oneOf:
                - $ref: '#/components/schemas/AboutThisResultElement'
              description: '<em>contains information from the ''About this result'' panel</em><br>            <strong>note:</strong> <code>about_this_result</code> feature is not available in Bing search engine, that’s why it always equals <code>null</code>'
              nullable: true
              deprecated: true
            related_result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/RelatedResult'
                nullable: true
              description: '<em>related result from the same domain</em><br>            related result from the same domain appears as a part of the main result snippet;<br>            <strong>note:</strong> <code>related_result</code> feature is not available in Bing search engine, that’s why it always equals <code>null</code>'
              nullable: true
            timestamp:
              type: string
              description: '<em>date and time when the result was published</em><br>            in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”<br>            example:<br>            <code class="long-string">2019-11-15 12:57:46 +00:00</code>'
              nullable: true
    BingPaidSerpElementItem:
      type: object
      allOf:
        - type: object
          oneOf:
            - $ref: '#/components/schemas/BaseBingSerpApiElementItem'
          nullable: true
        - type: object
          properties:
            domain:
              type: string
              description: <em>domain of the ad element in SERP</em>
              nullable: true
            title:
              type: string
              description: <em>title of the ad element in SERP</em>
              nullable: true
            description:
              type: string
              description: <em>description of the ad element in SERP</em>
              nullable: true
            url:
              type: string
              description: <em>relevant URL of the ad element in SERP</em>
              nullable: true
            breadcrumb:
              type: string
              description: <em>breadcrumb of the ad element in SERP</em>
              nullable: true
            website_name:
              type: string
              description: <em>website name in SERP</em>
              nullable: true
            is_image:
              type: boolean
              description: <em>indicates whether the element contains an <code class="prettyprint">image</code></em>
              nullable: true
            is_video:
              type: boolean
              description: <em>indicates whether the element contains a <code class="prettyprint">video</code></em>
              nullable: true
            checks:
              type: array
              items:
                type: string
                nullable: true
              nullable: true
            images:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AiModeImagesElementInfo'
                nullable: true
              description: '<em>images of the element</em><br>            if there are none, equals <code>null</code>'
              nullable: true
            highlighted:
              type: array
              items:
                type: string
                nullable: true
              description: <em>words highlighted in bold within the results <code>description</code></em>
              nullable: true
            extra:
              type: object
              additionalProperties:
                type: string
                nullable: true
              description: <em>additional information about the result</em>
              nullable: true
            description_rows:
              type: array
              items:
                type: string
                nullable: true
              description: '<em>extended description</em><br>            if there is none, equals <code>null</code>'
              nullable: true
            links:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AdLinkElement'
                nullable: true
              description: <em>links featured in the organic result</em>
              nullable: true
            price:
              type: object
              oneOf:
                - $ref: '#/components/schemas/PriceInfo'
              description: <em>price of booking a place for the specified dates of stay</em>
              nullable: true
            rating:
              type: object
              oneOf:
                - $ref: '#/components/schemas/RatingInfo'
              description: <em>the item's rating </em><br>            the popularity rate based on reviews and displayed in SERP
              nullable: true
    BingFeaturedSnippetSerpElementItem:
      type: object
      allOf:
        - type: object
          oneOf:
            - $ref: '#/components/schemas/BaseBingSerpApiElementItem'
          nullable: true
        - type: object
          properties:
            domain:
              type: string
              description: <em>domain of the ad element in SERP</em>
              nullable: true
            title:
              type: string
              description: <em>title of the ad element in SERP</em>
              nullable: true
            description:
              type: string
              description: <em>description of the ad element in SERP</em>
              nullable: true
            url:
              type: string
              description: <em>relevant URL of the ad element in SERP</em>
              nullable: true
            breadcrumb:
              type: string
              description: <em>breadcrumb of the ad element in SERP</em>
              nullable: true
            featured_title:
              type: string
              description: <em>the title of the featured snippets source page</em>
              nullable: true
            timestamp:
              type: string
              description: '<em>date and time when the result was published</em><br>            in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”<br>            example:<br>            <code class="long-string">2019-11-15 12:57:46 +00:00</code>'
              nullable: true
            images:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AiModeImagesElementInfo'
                nullable: true
              description: '<em>images of the element</em><br>            if there are none, equals <code>null</code>'
              nullable: true
            table:
              type: object
              oneOf:
                - $ref: '#/components/schemas/Table'
              description: '<em>results table</em><br>            if there are none, equals <code>null</code>'
              nullable: true
    BingRelatedSearchesSerpElementItem:
      type: object
      allOf:
        - type: object
          oneOf:
            - $ref: '#/components/schemas/BaseBingSerpApiElementItem'
          nullable: true
        - type: object
          properties:
            items:
              type: array
              items:
                type: string
                nullable: true
              description: <em>items in SERP</em>
              nullable: true
    SerpBingOrganicTaskGetRegularResultInfo:
      type: object
      properties:
        keyword:
          type: string
          description: <em>keyword received in a POST array</em><br><strong>keyword is returned with decoded %## (plus symbol '+' will be decoded to a space character)</strong>
          nullable: true
        type:
          type: string
          description: type of element
          nullable: true
        se_domain:
          type: string
          description: <em>search engine domain in a POST array</em>
          nullable: true
        location_code:
          type: integer
          description: <em>location code in a POST array</em>
          nullable: true
        language_code:
          type: string
          description: <em>language code in a POST array</em>
          nullable: true
        check_url:
          type: string
          description: <em>direct URL to search engine results</em><br>you can use it to make sure that we provided accurate results
          nullable: true
        datetime:
          type: string
          description: '<em>date and time when the result was received</em><br>in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”<br>example:<br><code class="long-string">2019-11-15 12:57:46 +00:00</code>'
          nullable: true
        spell:
          type: object
          oneOf:
            - $ref: '#/components/schemas/SpellInfo'
          description: '<em>autocorrection of the search engine</em><br>if the search engine provided results for a keyword that was corrected, we will specify the keyword corrected by the search engine and the type of autocorrection'
          nullable: true
        refinement_chips:
          type: object
          oneOf:
            - $ref: '#/components/schemas/RefinementChipsInfo'
          description: <em>search refinement chips</em><br>equals <code>null</code>
          nullable: true
        item_types:
          type: array
          items:
            type: string
            nullable: true
          description: '<em>types of search results in SERP</em><br>contains types of search results (<code>items</code>) found in SERP.<br>possible item types: <code>organic</code>, <code>paid</code>'
          nullable: true
        se_results_count:
          type: integer
          description: <em>total number of results in SERP</em>
          format: int64
          nullable: true
        pages_count:
          type: integer
          description: <em>total pages retrieved</em><br>total number of retrieved SERPs in the result
          format: int64
          nullable: true
        items_count:
          type: integer
          description: <em>the number of results returned in the <strong><code>items</code></strong> array</em>
          format: int64
          nullable: true
        items:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/BaseBingSerpApiElementItem'
            nullable: true
          description: <em>items inside the element</em><br>array of 8 search queries related to the keyword
          nullable: true
    SerpBingOrganicTaskGetRegularTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpBingOrganicTaskGetRegularResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    SerpBingOrganicTaskGetRegularResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpBingOrganicTaskGetRegularTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    SerpApiBingAiOverviewElementItem:
      type: object
      allOf:
        - type: object
          oneOf:
            - $ref: '#/components/schemas/BaseSerpApiBingAiOverviewElementItem'
          nullable: true
        - type: object
          properties:
            position:
              type: string
              description: '<em>the alignment of the element in SERP</em><br>            can take the following values:<br>            <code>left</code>, <code>right</code>'
              nullable: true
            title:
              type: string
              description: <em>title of the result in SERP</em>
              nullable: true
            text:
              type: string
              description: <em>text or description of the element in SERP</em>
              nullable: true
            markdown:
              type: string
              description: <em>content of the element in markdown format</em>
              nullable: true
            links:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/LinkElement'
                nullable: true
              description: '<em>sitelinks</em><br>            the links shown below some search results<br>            if there are none, equals <code>null</code>'
              nullable: true
            images:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AiModeImagesElementInfo'
                nullable: true
              description: <em>images of the element</em>
              nullable: true
            references:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AiModeAiOverviewReferenceInfo'
                nullable: true
              description: <em>references relevant to the element</em><br>            includes references to webpages that were used to generate the <code>ai_overview_element</code>
              nullable: true
    SerpApiBingAiOverviewVideoElementItem:
      type: object
      allOf:
        - type: object
          oneOf:
            - $ref: '#/components/schemas/BaseSerpApiBingAiOverviewElementItem'
          nullable: true
        - type: object
          properties:
            position:
              type: string
              description: '<em>the alignment of the element in SERP</em><br>            can take the following values:<br>            <code>left</code>, <code>right</code>'
              nullable: true
            title:
              type: string
              description: <em>link anchor text</em>
              nullable: true
            snippet:
              type: string
              description: <em>text snippet of the video</em>
              nullable: true
            url:
              type: string
              description: <em>link URL</em>
              nullable: true
            domain:
              type: string
              description: <em>domain in SERP</em>
              nullable: true
            image_url:
              type: string
              description: <em>URL of the image</em><br>            the URL leading to the image on the original resource or DataForSEO storage (in case the original source is not available)
              nullable: true
            source:
              type: string
              description: <i>source of the element</i><br>            indicates the source of information included in the <code>questions_and_answers_element</code>
              nullable: true
            date:
              type: string
              description: <em>the date when the page source of the element was published</em>
              nullable: true
            timestamp:
              type: string
              description: '<em>date and time when the result was published</em><br>            in the UTC format: "yyyy-mm-dd hh-mm-ss +00:00"<br>            example:<br>            <code class="long-string">2019-11-15 12:57:46 +00:00</code>'
              nullable: true
    SerpApiBingAiOverviewVideosElementItem:
      type: object
      allOf:
        - type: object
          oneOf:
            - $ref: '#/components/schemas/BaseSerpApiBingAiOverviewElementItem'
          nullable: true
        - type: object
          properties:
            items:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/VideoElement'
                nullable: true
              description: <em>elements of search results found in SERP</em>
              nullable: true
    SerpApiBingAiOverviewImagesElementItem:
      type: object
      allOf:
        - type: object
          oneOf:
            - $ref: '#/components/schemas/BaseSerpApiBingAiOverviewElementItem'
          nullable: true
        - type: object
          properties:
            url:
              type: string
              description: <em>URL link</em>
              nullable: true
            title:
              type: string
              description: <em>title of the link element</em>
              nullable: true
            items:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AiModeImagesElementInfo'
                nullable: true
              description: <em>items featured in the faq_box</em>
              nullable: true
    SerpApiBingAiOverviewOrganicElementItem:
      type: object
      allOf:
        - type: object
          oneOf:
            - $ref: '#/components/schemas/BaseSerpApiBingAiOverviewElementItem'
          nullable: true
        - type: object
          properties:
            title:
              type: string
              description: <em>title of the link</em>
              nullable: true
            url:
              type: string
              description: <em>relevant URL </em>
              nullable: true
            domain:
              type: string
              description: <em>domain in SERP</em>
              nullable: true
            snippet:
              type: string
              description: <em>text snippet from the organic result</em>
              nullable: true
            breadcrumb:
              type: string
              description: <em>breadcrumb in SERP</em>
              nullable: true
            website_name:
              type: string
              description: <em>website name in SERP</em>
              nullable: true
            links:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/LinkElement'
                nullable: true
              description: <em>links featured in the faq_box_element</em>
              nullable: true
            highlighted:
              type: array
              items:
                type: string
                nullable: true
              description: <em>words highlighted in bold within the results <code>description</code></em>
              nullable: true
    BingAiOverviewSerpElementItem:
      type: object
      allOf:
        - type: object
          oneOf:
            - $ref: '#/components/schemas/BaseBingSerpApiElementItem'
          nullable: true
        - type: object
          properties:
            markdown:
              type: string
              description: <em>content of the element in markdown format</em>
              nullable: true
            items:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/BaseSerpApiBingAiOverviewElementItem'
                nullable: true
              description: '<em>additional items present in the element</em><br>            if there are none, equals <code>null</code>'
              nullable: true
            references:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AiModeAiOverviewReferenceInfo'
                nullable: true
              description: <em>additional references relevant to the item</em><br>            includes references to webpages that may have been used to generate the <code>ai_overview</code>
              nullable: true
    BingImagesSerpElementItem:
      type: object
      allOf:
        - type: object
          oneOf:
            - $ref: '#/components/schemas/BaseBingSerpApiElementItem'
          nullable: true
        - type: object
          properties:
            title:
              type: string
              description: <em>title of the item</em>
              nullable: true
            url:
              type: string
              description: <em>URL</em>
              nullable: true
            items:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AiModeImagesElementInfo'
                nullable: true
              description: <em>contains results featured in the 'hotels_pack' element of SERP</em>
              nullable: true
            related_image_searches:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/RelatedImageSearchesElement'
                nullable: true
              description: '<em>contains keywords and images related to the specified search term</em><br>            if there are none, equals <code>null</code>'
              nullable: true
              deprecated: true
    BingVideoSerpElementItem:
      type: object
      allOf:
        - type: object
          oneOf:
            - $ref: '#/components/schemas/BaseBingSerpApiElementItem'
          nullable: true
        - type: object
          properties:
            items:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/VideoElement'
                nullable: true
              description: <em>contains results featured in the 'hotels_pack' element of SERP</em>
              nullable: true
    BingShoppingSerpElementItem:
      type: object
      allOf:
        - type: object
          oneOf:
            - $ref: '#/components/schemas/BaseBingSerpApiElementItem'
          nullable: true
        - type: object
          properties:
            title:
              type: string
              description: <em>title of the item</em>
              nullable: true
            items:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/ShoppingElement'
                nullable: true
              description: <em>contains results featured in the 'hotels_pack' element of SERP</em>
              nullable: true
    BingAnswerBoxSerpElementItem:
      type: object
      allOf:
        - type: object
          oneOf:
            - $ref: '#/components/schemas/BaseBingSerpApiElementItem'
          nullable: true
        - type: object
          properties:
            text:
              type: array
              items:
                type: string
                nullable: true
              description: '<em>text</em><br>            if there is none, equals <code>null</code>'
              nullable: true
            links:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/LinkElement'
                nullable: true
              description: <em>links featured in the organic result</em>
              nullable: true
    BingLocalPackSerpElementItem:
      type: object
      allOf:
        - type: object
          oneOf:
            - $ref: '#/components/schemas/BaseBingSerpApiElementItem'
          nullable: true
        - type: object
          properties:
            title:
              type: string
              description: <em>title of the item</em>
              nullable: true
            description:
              type: string
              description: <em>description of the results element in SERP</em>
              nullable: true
            domain:
              type: string
              description: <em>domain where the video is hosted</em>
              nullable: true
            phone:
              type: string
              description: <em>phone number</em>
              nullable: true
            booking_url:
              type: string
              nullable: true
            url:
              type: string
              description: <em>URL</em>
              nullable: true
            is_paid:
              type: boolean
              description: <em>indicates whether the element is an ad</em>
              nullable: true
            rating:
              type: object
              oneOf:
                - $ref: '#/components/schemas/RatingInfo'
              description: <em>the item's rating </em><br>            the popularity rate based on reviews and displayed in SERP
              nullable: true
            cid:
              type: string
              description: <em>bing-defined client id</em><br>            unique id of a local establishment
              nullable: true
            is_claimed:
              type: boolean
              description: '<em>business listing is claimed</em><br>            if <code>true</code>, the business listing is claimed by the owner or representative'
              nullable: true
    BingQuestionsAndAnswersSerpElementItem:
      type: object
      allOf:
        - type: object
          oneOf:
            - $ref: '#/components/schemas/BaseBingSerpApiElementItem'
          nullable: true
        - type: object
          properties:
            items:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/QuestionsAndAnswersElement'
                nullable: true
              description: <em>contains results featured in the 'hotels_pack' element of SERP</em>
              nullable: true
    BingHotelsPackSerpElementItem:
      type: object
      allOf:
        - type: object
          oneOf:
            - $ref: '#/components/schemas/BaseBingSerpApiElementItem'
          nullable: true
        - type: object
          properties:
            title:
              type: string
              description: <em>title of the item</em>
              nullable: true
            date_from:
              type: string
              description: <em>starting date of stay</em><br>            in the format “year-month-date”<br>            example:<br>            2019-11-15
              nullable: true
            date_to:
              type: string
              description: <em>ending date of stay</em><br>            in the format “year-month-date”<br>            example:<br>            2019-11-17
              nullable: true
            items:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/HotelsPackElement'
                nullable: true
              description: <em>contains results featured in the 'hotels_pack' element of SERP</em>
              nullable: true
    BingJobsSerpElementItem:
      type: object
      allOf:
        - type: object
          oneOf:
            - $ref: '#/components/schemas/BaseBingSerpApiElementItem'
          nullable: true
        - type: object
          properties:
            title:
              type: string
              description: <em>title of the item</em>
              nullable: true
            url:
              type: string
              description: <em>URL</em>
              nullable: true
            items:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/JobsElement'
                nullable: true
              description: <em>contains results featured in the 'hotels_pack' element of SERP</em>
              nullable: true
    BingTopStoriesSerpElementItem:
      type: object
      allOf:
        - type: object
          oneOf:
            - $ref: '#/components/schemas/BaseBingSerpApiElementItem'
          nullable: true
        - type: object
          properties:
            title:
              type: string
              description: <em>title of the item</em>
              nullable: true
            items:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/TopStoriesElement'
                nullable: true
              description: <em>contains results featured in the 'hotels_pack' element of SERP</em>
              nullable: true
    BingCarouselSerpElementItem:
      type: object
      allOf:
        - type: object
          oneOf:
            - $ref: '#/components/schemas/BaseBingSerpApiElementItem'
          nullable: true
        - type: object
          properties:
            title:
              type: string
              description: <em>title of the item</em>
              nullable: true
            items:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpApiCarouselElement'
                nullable: true
              description: <em>contains results featured in the 'hotels_pack' element of SERP</em>
              nullable: true
    BingMapSerpElementItem:
      type: object
      allOf:
        - type: object
          oneOf:
            - $ref: '#/components/schemas/BaseBingSerpApiElementItem'
          nullable: true
        - type: object
          properties:
            title:
              type: string
              description: <em>title of the item</em>
              nullable: true
            url:
              type: string
              description: <em>URL</em>
              nullable: true
    BingEventsSerpElementItem:
      type: object
      allOf:
        - type: object
          oneOf:
            - $ref: '#/components/schemas/BaseBingSerpApiElementItem'
          nullable: true
        - type: object
          properties:
            title:
              type: string
              description: <em>title of the item</em>
              nullable: true
            url:
              type: string
              description: <em>URL</em>
              nullable: true
            items:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/EventsElement'
                nullable: true
              description: <em>contains results featured in the 'hotels_pack' element of SERP</em>
              nullable: true
    BingRecipesSerpElementItem:
      type: object
      allOf:
        - type: object
          oneOf:
            - $ref: '#/components/schemas/BaseBingSerpApiElementItem'
          nullable: true
        - type: object
          properties:
            items:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/RecipesElement'
                nullable: true
              description: <em>contains results featured in the 'hotels_pack' element of SERP</em>
              nullable: true
    SerpApiBingPeopleAlsoAskExpandedElementItem:
      type: object
      allOf:
        - type: object
          oneOf:
            - $ref: '#/components/schemas/BaseSerpApiBingPeopleAlsoAskExpandedElementItem'
          nullable: true
        - type: object
    BingPeopleAlsoAskSerpElementItem:
      type: object
      allOf:
        - type: object
          oneOf:
            - $ref: '#/components/schemas/BaseBingSerpApiElementItem'
          nullable: true
        - type: object
          properties:
            items:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/PeopleAlsoAskElement'
                nullable: true
              description: <em>contains results featured in the 'hotels_pack' element of SERP</em>
              nullable: true
    BingPeopleAlsoSearchSerpElementItem:
      type: object
      allOf:
        - type: object
          oneOf:
            - $ref: '#/components/schemas/BaseBingSerpApiElementItem'
          nullable: true
        - type: object
          properties:
            title:
              type: string
              description: <em>title of the item</em>
              nullable: true
            items:
              type: array
              items:
                type: string
                nullable: true
              description: <em>contains results featured in the 'hotels_pack' element of SERP</em>
              nullable: true
    SerpBingOrganicTaskGetAdvancedResultInfo:
      type: object
      properties:
        keyword:
          type: string
          description: <em>keyword received in a POST array<br>        </em><strong>the keyword is returned with decoded %## (plus symbol '+' will be decoded to a space character)</strong>
          nullable: true
        type:
          type: string
          description: type of element
          nullable: true
        se_domain:
          type: string
          description: <em>search engine domain in a POST array</em>
          nullable: true
        location_code:
          type: integer
          description: <em>location code in a POST array</em>
          nullable: true
        language_code:
          type: string
          description: <em>language code in a POST array</em>
          nullable: true
        check_url:
          type: string
          description: <em>direct URL to search engine results</em><br>            you can use it to make sure that we provided accurate results
          nullable: true
        datetime:
          type: string
          description: '<em>date and time when the result was received</em><br>            in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”<br>            example:<br>            <code class="long-string">2019-11-15 12:57:46 +00:00</code>'
          nullable: true
        spell:
          type: object
          oneOf:
            - $ref: '#/components/schemas/SpellInfo'
          description: '<em>autocorrection of the search engine</em><br>            if the search engine provided results for a keyword that was corrected, we will specify the keyword corrected by the search engine and the type of autocorrection'
          nullable: true
        refinement_chips:
          type: object
          oneOf:
            - $ref: '#/components/schemas/RefinementChipsInfo'
          description: <em>search refinement chips</em><br>            equals <code>null</code>
          nullable: true
        item_types:
          type: array
          items:
            type: string
            nullable: true
          description: '<em>types of search results in SERP</em><br>            contains types of search results (<code>items</code>) found in SERP.<br>            possible item types:<br>            <span><a href="#answer_box"><code>answer_box</code></a>, <a href="#carousel"><code>carousel</code></a>, <a href="#events"><code>events</code></a>, <a href="#featured_snippet"><code>featured_snippet</code></a>, <a href="#hotels"><code>hotels_pack</code></a>, <a href="#images"><code>images</code></a>, <a href="#jobs"><code>jobs</code></a>, <a href="#local_pack"><code>local_pack</code></a>, <a href="#map"><code>map</code></a>, <a href="#organic"><code>organic</code></a>, <a href="#paid"><code>paid</code></a>, <a href="#people_also_ask"><code>people_also_ask</code></a>, <a href="#people_also_search"><code>people_also_search</code></a>, <a href="#questions_and_answers"><code>questions_and_answers</code></a>,<a href="#recipes"><code>recipes</code></a>, <a href="#related_searches"><code>related_searches</code></a>, <a href="#shopping"><code>shopping</code></a>, <a href="#top_stories"><code>top_stories</code></a>, <a href="#video"><code>video</code></a></span>, <a href="#ai_overview"><code>ai_overview</code></a></span>'
          nullable: true
        se_results_count:
          type: integer
          description: <em> total number of results in SERP</em>
          format: int64
          nullable: true
        pages_count:
          type: integer
          description: <em>total pages retrieved</em><br>            total number of retrieved SERPs in the result
          format: int64
          nullable: true
        items_count:
          type: integer
          description: <em>the number of results returned in the <strong><code>items</code></strong> array</em>
          format: int64
          nullable: true
        items:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/BaseBingSerpApiElementItem'
            nullable: true
          description: '<em>additional items present in the element</em><br>            if there are none, equals <code>null</code>'
          nullable: true
    SerpBingOrganicTaskGetAdvancedTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpBingOrganicTaskGetAdvancedResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    SerpBingOrganicTaskGetAdvancedResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpBingOrganicTaskGetAdvancedTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    SerpBingOrganicTaskGetHtmlResultInfo:
      type: object
      properties:
        keyword:
          type: string
          description: <em>keyword received in a POST array<br></em><strong>keyword is returned with decoded %## (plus symbol '+' will be decoded to a space character)</strong>
          nullable: true
        type:
          type: string
          description: type of element
          nullable: true
        se_domain:
          type: string
          description: <em>search engine domain in a POST array</em>
          nullable: true
        location_code:
          type: integer
          description: <em>location code in a POST array</em>
          nullable: true
        language_code:
          type: string
          description: <em>language code in a POST array</em>
          nullable: true
        datetime:
          type: string
          description: '<em>date and time when the result was received</em><br>in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”<br>example:<br><code class="long-string">2019-11-15 12:57:46 +00:00</code>'
          nullable: true
        items_count:
          type: integer
          description: <em>the number of results returned in the <strong><code>items</code></strong> array</em>
          format: int64
          nullable: true
        items:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/HtmlItemInfo'
            nullable: true
          description: <em>elements of search results found in SERP</em>
          nullable: true
    SerpBingOrganicTaskGetHtmlTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpBingOrganicTaskGetHtmlResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    SerpBingOrganicTaskGetHtmlResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpBingOrganicTaskGetHtmlTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    SerpBingOrganicLiveRegularRequestInfo:
      type: object
      properties:
        keyword:
          type: string
          description: '<p><em>keyword</em><p><strong>required field</strong><p>you can specify <strong>up to 700 characters</strong> in the <code>keyword</code> field<p><strong>all %## will be decoded (plus character ''+'' will be decoded to a space character)</strong><p>if you need to use the "%" character for your <code>keyword</code>, please specify it as "%25";<p>if you need to use the “+” character for your <code>keyword</code>, please specify it as “%2B”;</p><br><p>learn more about rules and limitations of <code>keyword</code> and <code>keywords</code> fields in DataForSEO APIs in this <a href="https://dataforseo.com/help-center/rules-and-limitations-of-keyword-and-keywords-fields-in-dataforseo-apis" rel="noopener noreferrer" target="_blank">Help Center article</a></p>'
        location_code:
          type: integer
          description: '<p><em>search engine location code</em><p><strong>required field if you don''t specify</strong> <code>location_name</code>&nbsp;or <code>location_coordinate</code><p><strong>if you use this field, you don''t need to specify <code>location_name</code> or <code>location_coordinate</code></strong><p>you can receive the list of available locations of the search engines with their <code>location_code</code> by making a separate request to the <code>https://api.dataforseo.com/v3/serp/{{low_se_name}}/locations</code><p>example:<p><code class="long-string">2840</code></p>'
        language_code:
          type: string
          description: '<p><em>search engine language code</em><p><strong>required field if you don''t specify</strong> <code>language_name</code><p><strong>if you use this field, you don''t need to specify <code>language_name</code></strong><p>you can receive the list of available languages of the search engine with their <code>language_code</code>&nbsp;by making a separate request to the <code>https://api.dataforseo.com/v3/serp/{{low_se_name}}/languages</code><em><p></em>example:<em><p></em><code class="long-string">en</code></p>'
        depth:
          type: integer
          description: '<p><em>parsing depth</em><p>optional field<p>number of results in SERP<p>default value: <code>10</code><p>max value: <code>200</code></p><br><strong>Your account will be billed per each SERP containing up to 10 results;</strong><p>Setting depth above 10 may result in additional charges <a href="https://dataforseo.com/help-center/how-many-results-scraped" rel="noopener noreferrer" target="_blank">if the search engine returns more than 10 results</a>;<p>The cost can be calculated on the <a title="Pricing" href="https://dataforseo.com/pricing/serp/bing-organic-serp-api" target="_blank" rel="noopener noreferrer">Pricing</a> page.'
          nullable: true
        device:
          type: string
          description: '<p><em>device type</em><p>optional field<p>return results for a specific device type<p>can take the values:<code>desktop</code>, <code>mobile</code><p>default value: <code>desktop</code></p>'
          nullable: true
        location_name:
          type: string
          description: '<p><em>full name of search engine location</em><p><strong>required field if you don''t specify</strong> <code>location_code</code> or <code>location_coordinate</code><p><strong>if you use this field, you don''t need to specify <code>location_code</code> or <code>location_coordinate</code></strong><p>you can receive the list of available locations of the search engine with their <code>location_name</code> by making a separate request to the <code>https://api.dataforseo.com/v3/serp/{{low_se_name}}/locations</code><p>example:<p><code class="long-string">London,England,United Kingdom</code></p>'
        language_name:
          type: string
          description: '<p><em>full name of search engine language</em><p><strong>required field if you don''t specify</strong> <code>language_code</code><p><strong>if you use this field, you don''t need to specify <code>language_code</code></strong><p>you can receive the list of available languages of the search engine with their <code>language_name</code> by making a separate request to the <code>https://api.dataforseo.com/v3/serp/{{low_se_name}}/languages</code><p>example:<p><code class="long-string">English</code></p>'
        os:
          type: string
          description: '<p><em>device operating system</em><p>optional field<p>if you specify <code>desktop</code> in the <code>device</code> field, choose from the following values: <code>windows</code>, <code>macos</code><p>default value: <code>windows</code><p>if you specify <code>mobile</code> in the <code>device</code> field, choose from the following values: <code>android</code>, <code>ios</code><p>default value: <code>android</code></p>'
          nullable: true
        tag:
          type: string
          description: <p><em>user-defined task identifier</em><p>optional field<p><em>the character limit is 255</em><p>you can use this parameter to identify the task and match it with the result<p>you will find the specified <code>tag</code> value in the <code>data</code> object of the response</p>
          nullable: true
        target:
          type: string
          description: '<p><em>target domain, subdomain, or webpage to get results for</em><p>optional field<p>a domain or a subdomain should be specified without <code>https://</code> and <code>www.</code><p>note that the results of <code>target</code>-specific tasks will only include SERP elements that contain a <code>url</code> string;<p>you can also use a wildcard (‘*’) character to specify the search pattern in SERP and narrow down the results;<p>examples:<p><strong><code class="long-string">example.com</code></strong> - returns results for the website''s home page with URLs, such as <code class="long-string">https://example.com</code>, or <code class="long-string">https://www.example.com/</code>, or <code class="long-string">https://example.com/</code>;<p><strong><code class="long-string">example.com*</code></strong> - returns results for the domain, including all its pages;<p><strong><code class="long-string">*example.com*</code></strong> - returns results for the entire domain, including all its pages and subdomains;<p><strong><code class="long-string">*example.com</code></strong>  - returns results for the home page regardless of the subdomain, such as <code class="long-string">https://en.example.com</code>;<p><strong><code class="long-string">example.com/example-page</code></strong> - returns results for the exact URL;<p><strong><code class="long-string">example.com/example-page*</code></strong> - returns results for all domain''s URLs that start with the specified string</p>'
          nullable: true
        stop_crawl_on_match:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/SerpApiStopCrawlOnMatchInfo'
            nullable: true
          description: "array of targets to stop crawling\noptional field\nif specified, the response will contain SERP results up to and including the specified match_value;\nyou can specify up to 10 target values in this array\nexample:\n\"stop_crawl_on_match\":[{\"match_value\":\"dataforseo.com\",\"match_type\":\"with_subdomains\"}]\nlearn more about this parameter on our Help Center - https://dataforseo.com/help-center/using-the-stop_crawl_on_match-parameter-in-serp-api\nYour account will be billed per each SERP crawled through the specified targets"
          nullable: true
        match_type:
          type: string
          description: <p><em>target match type</em><p><strong>required field if <code>stop_crawl_on_match</code> is specified</strong><p>type of match for the <code>match_value</code><p>possible values:<p><code>domain</code> – specific domain or subdomain<p><code>with_subdomains</code> – main domain and subdomains<p><code>wildcard</code> –  wildcard pattern</p>
        match_value:
          type: string
          description: '<p><em>target domain, subdomain, or wildcard value</em><p><strong>required field if <code>stop_crawl_on_match</code> is specified</strong><p>specify a target domain, subdomain, or wildcard value;<p><strong>Note:</strong> domain or subdomain must be specified without a request protocol;<p>example: <code>"match_value": "dataforseo.com"</code>,<p><code>"match_value": "/blog/post-*"</code></p>'
        max_crawl_pages:
          type: integer
          description: '<p><em>page crawl limit</em><p>optional field<p>number of search results pages to crawl<p>default value: <code>1</code><p>max value: <code>100</code><p><strong>Note:</strong> the <code>max_crawl_pages</code> and <code>depth</code> parameters complement each other;<p>learn more at <a href="https://dataforseo.com/help-center/what-is-max-crawl-pages-and-how-does-it-work" rel="noopener noreferrer" target="_blank">our help center</a></p>'
          nullable: true
        search_param:
          type: string
          description: <p><em>additional parameters of the search query</em><p>optional field<p><a href="https://dataforseo.com/what-are-google-search-parameters-and-how-to-use-them-with-serp-api.html">get the list of available parameters and additional details here</a></p>
          nullable: true
        url:
          type: string
          description: '<p><em>direct URL of the search query</em><p>optional field<p>you can specify a direct URL and we will sort it out to the necessary fields. Note that this method is the most difficult for our API to process and also requires you to specify the exact language and location in the URL. In most cases, we wouldn’t recommend using this method.<p>example:<p><code class="long-string">https://www.bing.com/search?q=rank%20checker&amp;count=50&amp;first=1&amp;setlang=en&amp;cc=US&amp;safesearch=Moderate&amp;FORM=SEPAGE</code></p>'
          nullable: true
        location_coordinate:
          type: string
          description: '<p><em>GPS coordinates of a location</em><p><strong>required field if you don''t specify</strong> <code>location_name</code>&nbsp;or <code>location_code</code><p><strong>if you use this field, you don''t need to specify <code>location_name</code> or <code>location_code</code></strong><p><code>location_coordinate</code> parameter should be specified in the <em>"latitude,longitude"</em> format<p>the maximum number of decimal digits for <em>"latitude"</em> and <em>"longitude"</em>: 7<p>example:<p><code class="long-string">53.476225,-2.243572</code></p>'
      example:
        - language_code: en
          location_code: 2840
          keyword: albert einstein
    SerpBingOrganicLiveRegularResultInfo:
      type: object
      properties:
        keyword:
          type: string
          description: <em>keyword received in a POST array</em><br><strong>keyword is returned with decoded %## (plus character '+' will be decoded to a space character)</strong>
          nullable: true
        type:
          type: string
          description: type of element
          nullable: true
        se_domain:
          type: string
          description: <em>search engine domain in a POST array</em>
          nullable: true
        location_code:
          type: integer
          description: <em>location code in a POST array</em>
          nullable: true
        language_code:
          type: string
          description: <em>language code in a POST array</em>
          nullable: true
        check_url:
          type: string
          description: <em>direct URL to search engine results<br></em>you can use it to make sure that we provided exact results
          nullable: true
        datetime:
          type: string
          description: '<em>date and time when the result was received</em><br>in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”<br>example:<br><code class="long-string">2019-11-15 12:57:46 +00:00</code>'
          nullable: true
        spell:
          type: object
          oneOf:
            - $ref: '#/components/schemas/SpellInfo'
          description: '<em>autocorrection of the search engine</em><br>if the search engine provided results for a keyword that was corrected, we will specify the keyword corrected by the search engine and the type of autocorrection'
          nullable: true
        refinement_chips:
          type: object
          oneOf:
            - $ref: '#/components/schemas/RefinementChipsInfo'
          description: <em>search refinement chips</em><br>equals <code>null</code>
          nullable: true
        item_types:
          type: array
          items:
            type: string
            nullable: true
          description: '<em>types of search results in SERP</em><br>contains types of search results (<code>items</code>) found in SERP.<br>possible item types: <code>organic</code>, <code>paid</code>'
          nullable: true
        se_results_count:
          type: integer
          description: <em>total number of results in SERP</em>
          format: int64
          nullable: true
        pages_count:
          type: integer
          description: <em>total pages retrieved</em><br>total number of retrieved SERPs in the result
          format: int64
          nullable: true
        items_count:
          type: integer
          description: <em>the number of results returned in the <strong><code>items</code></strong> array</em>
          format: int64
          nullable: true
        items:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/BaseBingSerpApiElementItem'
            nullable: true
          description: <em>items in SERP</em>
          nullable: true
    SerpBingOrganicLiveRegularTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpBingOrganicLiveRegularResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    SerpBingOrganicLiveRegularResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpBingOrganicLiveRegularTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    SerpBingOrganicLiveAdvancedRequestInfo:
      type: object
      properties:
        keyword:
          type: string
          description: '<p><em>keyword</em><p><strong>required field</strong><p>you can specify <strong>up to 700 characters</strong> in the <code>keyword</code> field<p><strong>all %## will be decoded (plus character ''+'' will be decoded to a space character)</strong><p>if you need to use the "%" character for your <code>keyword</code>, please specify it as "%25";<p>if you need to use the “+” character for your <code>keyword</code>, please specify it as “%2B”;</p><br><p>learn more about rules and limitations of <code>keyword</code> and <code>keywords</code> fields in DataForSEO APIs in this <a href="https://dataforseo.com/help-center/rules-and-limitations-of-keyword-and-keywords-fields-in-dataforseo-apis" target="_blank" rel="noopener noreferrer">Help Center article</a></p>'
        location_code:
          type: integer
          description: '<p><em>search engine location code</em><p><strong>required field if you don''t specify</strong> <code>location_name</code>&nbsp;or <code>location_coordinate</code><p><strong>if you use this field, you don''t need to specify <code>location_name</code> or <code>location_coordinate</code></strong><p>you can receive the list of available locations of the search engines with their <code>location_code</code> by making a separate request to the <code>https://api.dataforseo.com/v3/serp/{{low_se_name}}/locations</code><p>example:<p><code class="long-string">2840</code></p>'
        language_code:
          type: string
          description: '<p><em>search engine language code</em><p><strong>required field if you don''t specify</strong> <code>language_name</code><p><strong>if you use this field, you don''t need to specify <code>language_name</code></strong><p>you can receive the list of available languages of the search engine with their <code>language_code</code>&nbsp;by making a separate request to the <code>https://api.dataforseo.com/v3/serp/{{low_se_name}}/languages</code><em><p></em>example:<em><p></em><code class="long-string">en</code></p>'
        depth:
          type: integer
          description: '<p><em>parsing depth</em><p>optional field<p>number of results in SERP<p>default value: <code>10</code><p>max value: <code>200</code></p><br><strong>Your account will be billed per each SERP containing up to 10 results;</strong><p>Setting depth above 10 may result in additional charges <a href="https://dataforseo.com/help-center/how-many-results-scraped" rel="noopener noreferrer" target="_blank">if the search engine returns more than 10 results</a>;<p>The cost can be calculated on the <a title="Pricing" href="https://dataforseo.com/pricing/serp/bing-organic-serp-api" target="_blank" rel="noopener noreferrer">Pricing</a> page.'
          nullable: true
        device:
          type: string
          description: '<p><em>device type</em><p>optional field<p>return results for a specific device type<p>can take the values:<code>desktop</code>, <code>mobile</code><p>default value: <code>desktop</code></p>'
          nullable: true
        location_name:
          type: string
          description: '<p><em>full name of search engine location</em><p><strong>required field if you don''t specify</strong> <code>location_code</code> or <code>location_coordinate</code><p><strong>if you use this field, you don''t need to specify <code>location_code</code> or <code>location_coordinate</code></strong><p>you can receive the list of available locations of the search engine with their <code>location_name</code> by making a separate request to the <code>https://api.dataforseo.com/v3/serp/{{low_se_name}}/locations</code><p>example:<p><code class="long-string">London,England,United Kingdom</code></p>'
        language_name:
          type: string
          description: '<p><em>full name of search engine language</em><p><strong>required field if you don''t specify</strong> <code>language_code</code><p><strong>if you use this field, you don''t need to specify <code>language_code</code></strong><p>you can receive the list of available languages of the search engine with their <code>language_name</code> by making a separate request to the <code>https://api.dataforseo.com/v3/serp/{{low_se_name}}/languages</code><p>example:<p><code class="long-string">English</code></p>'
        os:
          type: string
          description: '<p><em>device operating system</em><p>optional field<p>if you specify <code>desktop</code> in the <code>device</code> field, choose from the following values: <code>windows</code>, <code>macos</code><p>default value: <code>windows</code><p>if you specify <code>mobile</code> in the <code>device</code> field, choose from the following values: <code>android</code>, <code>ios</code><p>default value: <code>android</code></p>'
          nullable: true
        tag:
          type: string
          description: <p><em>user-defined task identifier</em><p>optional field<p><em>the character limit is 255</em><p>you can use this parameter to identify the task and match it with the result<p>you will find the specified <code>tag</code> value in the <code>data</code> object of the response</p>
          nullable: true
        target:
          type: string
          description: '<p><em>target domain, subdomain, or webpage to get results for</em><p>optional field<p>a domain or a subdomain should be specified without <code>https://</code> and <code>www.</code><p>note that the results of <code>target</code>-specific tasks will only include SERP elements that contain a <code>url</code> string;<p>you can also use a wildcard (‘*’) character to specify the search pattern in SERP and narrow down the results;<p>examples:<p><strong><code class="long-string">example.com</code></strong>  - returns results for the website''s home page with URLs, such as <code class="long-string">https://example.com</code>, or <code class="long-string">https://www.example.com/</code>, or <code class="long-string">https://example.com/</code>;<p><strong><code class="long-string">example.com*</code></strong> - returns results for the domain, including all its pages;<p><strong><code class="long-string">*example.com*</code></strong> - returns results for the entire domain, including all its pages and subdomains;<p><strong><code class="long-string">*example.com</code></strong>  - returns results for the home page regardless of the subdomain, such as <code class="long-string">https://en.example.com</code>;<p><strong><code class="long-string">example.com/example-page</code></strong>  - returns results for the exact URL;<p><strong><code class="long-string">example.com/example-page*</code></strong>  - returns results for all domain''s URLs that start with the specified string</p>'
          nullable: true
        stop_crawl_on_match:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/SerpApiStopCrawlOnMatchInfo'
            nullable: true
          description: "array of targets to stop crawling\noptional field\nif specified, the response will contain SERP results up to and including the specified match_value;\nyou can specify up to 10 target values in this array\nexample:\n\"stop_crawl_on_match\":[{\"match_value\":\"dataforseo.com\",\"match_type\":\"with_subdomains\"}]\nlearn more about this parameter on our Help Center - https://dataforseo.com/help-center/using-the-stop_crawl_on_match-parameter-in-serp-api\nYour account will be billed per each SERP crawled through the specified targets"
          nullable: true
        match_type:
          type: string
          description: <p><em>target match type</em><p><strong>required field if <code>stop_crawl_on_match</code> is specified</strong><p>type of match for the <code>match_value</code><p>possible values:<p><code>domain</code> – specific domain or subdomain<p><code>with_subdomains</code> – main domain and subdomains<p><code>wildcard</code> –  wildcard pattern</p>
        match_value:
          type: string
          description: '<p><em>target domain, subdomain, or wildcard value</em><p><strong>required field if <code>stop_crawl_on_match</code> is specified</strong><p>specify a target domain, subdomain, or wildcard value;<p><strong>Note:</strong> domain or subdomain must be specified without a request protocol;<p>example: <code>"match_value": "dataforseo.com"</code>,<p><code>"match_value": "/blog/post-*"</code></p>'
        max_crawl_pages:
          type: integer
          description: '<p><em>page crawl limit</em><p>optional field<p>number of search results pages to crawl<p>default value: <code>1</code><p>max value: <code>100</code><p><strong>Note:</strong> the <code>max_crawl_pages</code> and <code>depth</code> parameters complement each other;<p>learn more at <a href="https://dataforseo.com/help-center/what-is-max-crawl-pages-and-how-does-it-work" rel="noopener noreferrer" target="_blank">our help center</a></p>'
          nullable: true
        search_param:
          type: string
          description: <p><em>additional parameters of the search query</em><p>optional field<p><a href="https://dataforseo.com/help-center/bing-search-engine-parameters-and-how-to-use-them">get the list of available parameters and additional details here</a></p>
          nullable: true
        calculate_rectangles:
          type: boolean
          description: '<p><em>calculate pixel rankings for SERP elements in advanced results</em><p>optional field<p>pixel ranking refers to the distance between the result snippet and top left corner of the screen;<p><a href="https://dataforseo.com/help-center/pixel-ranking-in-serp-api">Visit Help Center to learn more&gt;&gt;</a><p>by default, the parameter is set to <code>false</code><p><strong>Note:</strong> you will be charged extra $0.002 for using this parameter</p>'
          nullable: true
        browser_screen_width:
          type: integer
          description: '<p><em>browser screen width</em><p>optional field<p>you can set a custom browser screen width to calculate pixel rankings for a particular device;<p>can be specified within the following range: <code>240-9999</code>;<p>by default, the parameter is set to:<p><code>1920</code> for <code>desktop</code>;<p><code>360</code> for <code>mobile</code> on <code>android</code>;<p><code>375</code> for <code>mobile</code> on <code>iOS</code>;<p><strong>Note:</strong> to use this parameter, set <code>calculate_rectangles</code> to <code>true</code></p>'
          format: int64
          nullable: true
        browser_screen_height:
          type: integer
          description: '<p><em>browser screen height</em><p>optional field<p>you can set a custom browser screen height to calculate pixel rankings for a particular device;<p>can be specified within the following range: <code>240-9999</code>;<p>by default, the parameter is set to:<p><code>1080</code> for <code>desktop</code>;<p><code>640</code> for <code>mobile</code> on <code>android</code>;<p><code>812</code> for <code>mobile</code> on <code>iOS</code>;<p><strong>Note:</strong> to use this parameter, set <code>calculate_rectangles</code> to <code>true</code></p>'
          nullable: true
        browser_screen_resolution_ratio:
          type: integer
          description: '<p><em>browser screen resolution ratio</em><p>optional field<p>you can set a custom browser screen resolution ratio to calculate pixel rankings for a particular device;<p>can be specified within the following range: <code>0.5-3</code>;<p>by default, the parameter is set to:<p><code>1</code> for <code>desktop</code>;<p><code>3</code> for <code>mobile</code> on <code>android</code>;<p><code>3</code> for <code>mobile</code> on <code>iOS</code>;<p><strong>Note:</strong> to use this parameter, set <code>calculate_rectangles</code> to <code>true</code></p>'
          nullable: true
        url:
          type: string
          description: '<p><em>direct URL of the search query</em><p>optional field<p>you can specify a direct URL and we will sort it out to the necessary fields. Note that this method is the most difficult for our API to process and also requires you to specify the exact language and location in the URL. In most cases, we wouldn’t recommend using this method.<p>example:<p><code class="long-string">https://www.bing.com/search?q=rank%20checker&amp;count=50&amp;first=1&amp;setlang=en&amp;cc=US&amp;safesearch=Moderate&amp;FORM=SEPAGE</code></p>'
          nullable: true
        location_coordinate:
          type: string
          description: '<p><em>GPS coordinates of a location</em><p><strong>required field if you don''t specify</strong> <code>location_name</code>&nbsp;or <code>location_code</code><p><strong>if you use this field, you don''t need to specify <code>location_name</code> or <code>location_code</code></strong><p><code>location_coordinate</code> parameter should be specified in the <em>"latitude,longitude"</em> format<p>the maximum number of decimal digits for <em>"latitude"</em> and <em>"longitude"</em>: 7<p>example:<p><code class="long-string">53.476225,-2.243572</code></p>'
      example:
        - language_code: en
          location_code: 2840
          keyword: flight ticket new york san francisco
    SerpBingOrganicLiveAdvancedResultInfo:
      type: object
      properties:
        keyword:
          type: string
          description: <em>keyword received in a POST array<br>        </em><strong>the keyword is returned with decoded %## (plus character '+' will be decoded to a space character)</strong>
          nullable: true
        type:
          type: string
          description: type of element
          nullable: true
        se_domain:
          type: string
          description: <em>search engine domain in a POST array</em>
          nullable: true
        location_code:
          type: integer
          description: <em>location code in a POST array</em>
          nullable: true
        language_code:
          type: string
          description: <em>language code in a POST array</em>
          nullable: true
        check_url:
          type: string
          description: <em>direct URL to search engine results</em><br>            you can use it to make sure that we provided accurate results
          nullable: true
        datetime:
          type: string
          description: '<em>date and time when the result was received</em><br>            in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”<br>            example:<br>            <code class="long-string">2019-11-15 12:57:46 +00:00</code>'
          nullable: true
        spell:
          type: object
          oneOf:
            - $ref: '#/components/schemas/SpellInfo'
          description: '<em>autocorrection of the search engine</em><br>            if the search engine provided results for a keyword that was corrected, we will specify the keyword corrected by the search engine and the type of autocorrection<br>            equals <code>null</code>'
          nullable: true
        refinement_chips:
          type: object
          oneOf:
            - $ref: '#/components/schemas/RefinementChipsInfo'
          description: <em>search refinement chips</em><br>            equals <code>null</code>
          nullable: true
        item_types:
          type: array
          items:
            type: string
            nullable: true
          description: '<em>types of search results in SERP</em><br>            contains types of search results (<code>items</code>) found in SERP.<br>            possible item types:<br>            <span><a href="#answer_box"><code>answer_box</code></a>, <a href="#carousel"><code>carousel</code></a>, <a href="#events"><code>events</code></a>, <a href="#featured_snippet"><code>featured_snippet</code></a>, <a href="#hotels"><code>hotels_pack</code></a>, <a href="#images"><code>images</code></a>, <a href="#jobs"><code>jobs</code></a>, <a href="#local_pack"><code>local_pack</code></a>, <a href="#map"><code>map</code></a>, <a href="#organic"><code>organic</code></a>, <a href="#paid"><code>paid</code></a>, <a href="#people_also_ask"><code>people_also_ask</code></a>, <a href="#people_also_search"><code>people_also_search</code></a>, <a href="#questions_and_answers"><code>questions_and_answers</code></a>,<a href="#recipes"><code>recipes</code></a>, <a href="#related_searches"><code>related_searches</code></a>, <a href="#shopping"><code>shopping</code></a>, <a href="#top_stories"><code>top_stories</code></a>, <a href="#video"><code>video</code></a></span>, <a href="#ai_overview"><code>ai_overview</code></a>'
          nullable: true
        se_results_count:
          type: integer
          description: <em> total number of results in SERP</em>
          format: int64
          nullable: true
        pages_count:
          type: integer
          description: <em>total pages retrieved</em><br>            total number of retrieved SERPs in the result
          format: int64
          nullable: true
        items_count:
          type: integer
          description: <em>the number of results returned in the <strong><code>items</code></strong> array</em>
          format: int64
          nullable: true
        items:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/BaseBingSerpApiElementItem'
            nullable: true
          description: <em>elements of search results found in SERP</em>
          nullable: true
    SerpBingOrganicLiveAdvancedTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpBingOrganicLiveAdvancedResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    SerpBingOrganicLiveAdvancedResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpBingOrganicLiveAdvancedTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    SerpBingOrganicLiveHtmlRequestInfo:
      type: object
      properties:
        keyword:
          type: string
          description: '<p><em>keyword</em><p><strong>required field</strong><p>you can specify <strong>up to 700 characters</strong> in the <code>keyword</code> field<p><strong>all %## will be decoded (plus character ''+'' will be decoded to a space character)</strong><p>if you need to use the "%" character for your <code>keyword</code>, please specify it as "%25";<p>if you need to use the “+” character for your <code>keyword</code>, please specify it as “%2B”;</p><br><p>learn more about rules and limitations of <code>keyword</code> and <code>keywords</code> fields in DataForSEO APIs in this <a href="https://dataforseo.com/help-center/rules-and-limitations-of-keyword-and-keywords-fields-in-dataforseo-apis" rel="noopener noreferrer" target="_blank">Help Center article</a></p>'
        location_code:
          type: integer
          description: '<p><em>search engine location code</em><p><strong>required field if you don''t specify</strong> <code>location_name</code>&nbsp;or <code>location_coordinate</code><p><strong>if you use this field, you don''t need to specify <code>location_name</code> or <code>location_coordinate</code></strong><p>you can receive the list of available locations of the search engines with their <code>location_code</code> by making a separate request to the <code>https://api.dataforseo.com/v3/serp/{{low_se_name}}/locations</code><p>example:<p><code class="long-string">2840</code></p>'
        language_code:
          type: string
          description: '<p><em>search engine language code</em><p><strong>required field if you don''t specify</strong> <code>language_name</code><p><strong>if you use this field, you don''t need to specify <code>language_name</code></strong><p>you can receive the list of available languages of the search engine with their <code>language_code</code>&nbsp;by making a separate request to the <code>https://api.dataforseo.com/v3/serp/{{low_se_name}}/languages</code><em><p></em>example:<em><p></em><code class="long-string">en</code></p>'
        depth:
          type: integer
          description: '<p><em>parsing depth</em><p>optional field<p>number of results in SERP<p>default value: <code>10</code><p>max value: <code>200</code></p><br><strong>Your account will be billed per each SERP containing up to 10 results;</strong><p>Setting depth above 10 may result in additional charges <a href="https://dataforseo.com/help-center/how-many-results-scraped" rel="noopener noreferrer" target="_blank">if the search engine returns more than 10 results</a>;<p>The cost can be calculated on the <a title="Pricing" href="https://dataforseo.com/pricing/serp/bing-organic-serp-api" target="_blank" rel="noopener noreferrer">Pricing</a> page.'
          nullable: true
        device:
          type: string
          description: '<p><em>device type</em><p>optional field<p>return results for a specific device type<p>can take the values:<code>desktop</code>, <code>mobile</code><p>default value: <code>desktop</code></p>'
          nullable: true
        location_name:
          type: string
          description: '<p><em>full name of search engine location</em><p><strong>required field if you don''t specify</strong> <code>location_code</code> or <code>location_coordinate</code><p><strong>if you use this field, you don''t need to specify <code>location_code</code> or <code>location_coordinate</code></strong><p>you can receive the list of available locations of the search engine with their <code>location_name</code> by making a separate request to the <code>https://api.dataforseo.com/v3/serp/{{low_se_name}}/locations</code><p>example:<p><code class="long-string">London,England,United Kingdom</code></p>'
        language_name:
          type: string
          description: '<p><em>full name of search engine language</em><p><strong>required field if you don''t specify</strong> <code>language_code</code><p><strong>if you use this field, you don''t need to specify <code>language_code</code></strong><p>you can receive the list of available languages of the search engine with their <code>language_name</code> by making a separate request to the <code>https://api.dataforseo.com/v3/serp/{{low_se_name}}/languages</code><p>example:<p><code class="long-string">English</code></p>'
        os:
          type: string
          description: '<p><em>device operating system</em><p>optional field<p>if you specify <code>desktop</code> in the <code>device</code> field, choose from the following values: <code>windows</code>, <code>macos</code><p>default value: <code>windows</code><p>if you specify <code>mobile</code> in the <code>device</code> field, choose from the following values: <code>android</code>, <code>ios</code><p>default value: <code>android</code></p>'
          nullable: true
        tag:
          type: string
          description: <p><em>user-defined task identifier</em><p>optional field<p><em>the character limit is 255</em><p>you can use this parameter to identify the task and match it with the result<p>you will find the specified <code>tag</code> value in the <code>data</code> object of the response</p>
          nullable: true
        stop_crawl_on_match:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/SerpApiStopCrawlOnMatchInfo'
            nullable: true
          description: "array of targets to stop crawling\noptional field\nif specified, the response will contain SERP results up to and including the specified match_value;\nyou can specify up to 10 target values in this array\nexample:\n\"stop_crawl_on_match\":[{\"match_value\":\"dataforseo.com\",\"match_type\":\"with_subdomains\"}]\nlearn more about this parameter on our Help Center - https://dataforseo.com/help-center/using-the-stop_crawl_on_match-parameter-in-serp-api\nYour account will be billed per each SERP crawled through the specified targets"
          nullable: true
        match_type:
          type: string
          description: <p><em>target match type</em><p><strong>required field if <code>stop_crawl_on_match</code> is specified</strong><p>type of match for the <code>match_value</code><p>possible values:<p><code>domain</code> – specific domain or subdomain<p><code>with_subdomains</code> – main domain and subdomains<p><code>wildcard</code> –  wildcard pattern</p>
        match_value:
          type: string
          description: '<p><em>target domain, subdomain, or wildcard value</em><p><strong>required field if <code>stop_crawl_on_match</code> is specified</strong><p>specify a target domain, subdomain, or wildcard value;<p><strong>Note:</strong> domain or subdomain must be specified without a request protocol;<p>example: <code>"match_value": "dataforseo.com"</code>,<p><code>"match_value": "/blog/post-*"</code></p>'
        max_crawl_pages:
          type: integer
          description: '<p><em>page crawl limit</em><p>optional field<p>number of search results pages to crawl<p>default value: <code>1</code><p>max value: <code>100</code><p><strong>Note:</strong> the <code>max_crawl_pages</code> and <code>depth</code> parameters complement each other;<p>learn more at <a href="https://dataforseo.com/help-center/what-is-max-crawl-pages-and-how-does-it-work" rel="noopener noreferrer" target="_blank">our help center</a></p>'
          nullable: true
        search_param:
          type: string
          description: <p><em>additional parameters of the search query</em><p>optional field<p><a href="https://dataforseo.com/what-are-google-search-parameters-and-how-to-use-them-with-serp-api.html">get the list of available parameters and additional details here</a></p>
          nullable: true
        url:
          type: string
          description: '<p><em>direct URL of the search query</em><p>optional field<p>you can specify a direct URL and we will sort it out to the necessary fields. Note that this method is the most difficult for our API to process and also requires you to specify the exact language and location in the URL. In most cases, we wouldn’t recommend using this method.<p>example:<p><code class="long-string">https://www.bing.com/search?q=rank%20checker&amp;count=50&amp;first=1&amp;setlang=en&amp;cc=US&amp;safesearch=Moderate&amp;FORM=SEPAGE</code></p>'
          nullable: true
        location_coordinate:
          type: string
          description: '<p><em>GPS coordinates of a location</em><p><strong>required field if you don''t specify</strong> <code>location_name</code>&nbsp;or <code>location_code</code><p><strong>if you use this field, you don''t need to specify <code>location_name</code> or <code>location_code</code></strong><p><code>location_coordinate</code> parameter should be specified in the <em>"latitude,longitude"</em> format<p>the maximum number of decimal digits for <em>"latitude"</em> and <em>"longitude"</em>: 7<p>example:<p><code class="long-string">53.476225,-2.243572</code></p>'
      example:
        - language_code: en
          location_code: 2840
          keyword: albert einstein
    SerpBingOrganicLiveHtmlResultInfo:
      type: object
      properties:
        keyword:
          type: string
          description: <em>keyword received in a POST array<br></em><strong>keyword is returned with decoded %## (plus character '+' will be decoded to a space character)</strong>
          nullable: true
        type:
          type: string
          description: type of element
          nullable: true
        se_domain:
          type: string
          description: <em>search engine domain in a POST array</em>
          nullable: true
        location_code:
          type: integer
          description: <em>location code in a POST array</em>
          nullable: true
        language_code:
          type: string
          description: <em>language code in a POST array</em>
          nullable: true
        datetime:
          type: string
          description: '<em>date and time when the result was received</em><br>in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”<br>example:<br><code class="long-string">2019-11-15 12:57:46 +00:00</code>'
          nullable: true
        items_count:
          type: integer
          description: <em>the number of results returned in the <strong><code>items</code></strong> array</em>
          format: int64
          nullable: true
        items:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/HtmlItemInfo'
            nullable: true
          description: <em>elements of search results found in SERP</em>
          nullable: true
    SerpBingOrganicLiveHtmlTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpBingOrganicLiveHtmlResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    SerpBingOrganicLiveHtmlResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpBingOrganicLiveHtmlTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    SerpYoutubeLocationsResultInfo:
      type: object
      properties:
        location_code:
          type: integer
          description: <em>location code</em>
          nullable: true
        location_name:
          type: string
          description: <em>full name of the location</em>
          nullable: true
        location_code_parent:
          type: integer
          description: '<em>the code of the superordinate location</em><br>example:<br>`"location_code": 9041134`,<br>`"location_name": "Vienna International Airport,Lower Austria,Austria"`,<br>`"location_code_parent": 20044`<p>where `location_code_parent` corresponds to:<p>`"location_code": 20044`,<br>`"location_name": "Lower Austria,Austria"`'
          nullable: true
        country_iso_code:
          type: string
          description: <em>ISO country code of the location</em>
          nullable: true
        location_type:
          type: string
          description: '<em>location type</em><br>indicates the geographic classification of the location<br>example:<br>`"location_type": "Country"`, or `"location_type": "State"`'
          nullable: true
    SerpYoutubeLocationsTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpYoutubeLocationsResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    SerpYoutubeLocationsResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpYoutubeLocationsTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    SerpYoutubeLocationsCountryResultInfo:
      type: object
      properties:
        location_code:
          type: integer
          description: <em>location code</em>
          nullable: true
        location_name:
          type: string
          description: <em>full name of the location</em>
          nullable: true
        location_code_parent:
          type: integer
          description: '<em>the code of the superordinate location</em><br>example:<br>`"location_code": 9041134`,<br>`"location_name": "Vienna International Airport,Lower Austria,Austria"`,<br>`"location_code_parent": 20044`<p>where `location_code_parent` corresponds to:<p>`"location_code": 20044`,<br>`"location_name": "Lower Austria,Austria"`'
          nullable: true
        country_iso_code:
          type: string
          description: <em>ISO country code of the location</em>
          nullable: true
        location_type:
          type: string
          description: '<em>location type</em><br>indicates the geographic classification of the location<br>example:<br>`"location_type": "Country"`, or `"location_type": "State"`'
          nullable: true
    SerpYoutubeLocationsCountryTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpYoutubeLocationsCountryResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    SerpYoutubeLocationsCountryResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpYoutubeLocationsCountryTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    SerpYoutubeLanguagesResultInfo:
      type: object
      properties:
        language_name:
          type: string
          description: <em>language name</em>
          nullable: true
        language_code:
          type: string
          description: <em>language code according to <a href="https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes" target="_blank" rel="noopener noreferrer">ISO 639-1</a></em>
          nullable: true
    SerpYoutubeLanguagesTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpYoutubeLanguagesResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    SerpYoutubeLanguagesResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpYoutubeLanguagesTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    SerpYoutubeVideoInfoTaskPostRequestInfo:
      type: object
      properties:
        video_id:
          type: string
          description: "ID of the video\nrequired field\nyou can find video ID in the URL or 'youtube_video' item of YouTube Organic result\nexample:\nvQXvyV0zIP4"
        location_code:
          type: integer
          description: "search engine location code\nrequired field if you don't specify location_name\nif you use this field, you don't need to specify location_name\nyou can receive the list of available locations of the search engines with their location_code by making a separate request to the https://api.dataforseo.com/v3/serp/youtube/locations\nexample:\n2840"
          nullable: true
        language_code:
          type: string
          description: "search engine language code\nrequired field if you don't specify language_name\nif you use this field, you don't need to specify language_name\nyou can receive the list of available languages of the search engine with their language_code by making a separate request to the https://api.dataforseo.com/v3/serp/youtube/languages\nexample:\nen"
          nullable: true
        priority:
          type: integer
          description: "task priority\noptional field\ncan take the following values:\n1 – normal execution priority (set by default)\n2 – high execution priority\nYou will be additionally charged for the tasks with high execution priority.\nThe cost can be calculated on the Pricing page."
          nullable: true
        device:
          type: string
          description: "device type\noptional field\nonly value: desktop"
          nullable: true
        pingback_url:
          type: string
          description: "notification URL of a completed task\noptional field\nwhen a task is completed we will notify you by GET request sent to the URL you have specified\nyou can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request.\nexample:\nhttp://your-server.com/pingscript?id=$id\nhttp://your-server.com/pingscript?id=$id&tag=$tag\nNote: special characters in pingback_url will be urlencoded;\ni.a., the # character will be encoded into %23\nlearn more on our Help Center"
          nullable: true
        postback_url:
          type: string
          description: "return URL for sending task results\noptional field\nonce the task is completed, we will send a POST request with its results compressed in the gzip format to the postback_url you specified\nyou can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request.\nexample:\nhttp://your-server.com/postbackscript?id=$id\nhttp://your-server.com/postbackscript?id=$id&tag=$tag\nNote: special characters in postback_url will be urlencoded;\ni.a., the # character will be encoded into %23\nlearn more on our Help Center"
          nullable: true
        postback_data:
          type: string
          description: "postback_url datatype\nrequired field if you specify postback_url\ncorresponds to the datatype that will be sent to your server\npossible value:\nadvanced"
          nullable: true
        location_name:
          type: string
          description: "full name of search engine location\nrequired field if you don't specify location_code\nif you use this field, you don't need to specify location_code\nyou can receive the list of available locations of the search engine with their location_name by making a separate request to the https://api.dataforseo.com/v3/serp/youtube/locations\nexample:\nUnited States"
          nullable: true
        language_name:
          type: string
          description: "full name of search engine language\nrequired field if you don't specify language_code\nif you use this field, you don't need to specify language_code\nyou can receive the list of available languages of the search engine with their language_name by making a separate request to the https://api.dataforseo.com/v3/serp/youtube/languages\nexample:\nEnglish"
          nullable: true
        os:
          type: string
          description: "device operating system\noptional field\nchoose from the following values: windows, macos\ndefault value: windows"
          nullable: true
        tag:
          type: string
          description: "user-defined task identifier\noptional field\nthe character limit is 255\nyou can use this parameter to identify the task and match it with the result\nyou will find the specified tag value in the data object of the response"
          nullable: true
      example:
        - language_code: en
          location_code: 2840
          video_id: vQXvyV0zIP4
    SerpYoutubeVideoInfoTaskPostTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: object
              description: 'array of resultsin this case, the value will be null'
              nullable: true
    SerpYoutubeVideoInfoTaskPostResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpYoutubeVideoInfoTaskPostTaskInfo'
                nullable: true
              description: array of tasks
              nullable: true
    SerpYoutubeVideoInfoTasksReadyResultInfo:
      type: object
      properties:
        id:
          type: string
          description: <em>task identifier of the completed task</em><br><strong>unique task identifier in our system in the <a href="https://en.wikipedia.org/wiki/Universally_unique_identifier">UUID</a> format</strong>
          nullable: true
        se:
          type: string
          description: <em>search engine specified when setting the task</em>
          nullable: true
        se_type:
          type: string
          description: '<em>type of search engine</em><br>example: <code>{{low_se_type_under}}</code>'
          nullable: true
        date_posted:
          type: string
          description: <em>date when the task was posted (in the UTC format)</em>
          nullable: true
        tag:
          type: string
          description: <em>user-defined task identifier</em>
          nullable: true
        endpoint_regular:
          type: string
          description: '<em>URL for collecting the results of the SERP Regular task</em><br>if SERP Regular is not supported in the specified endpoint, the value will be <code>null</code>'
          nullable: true
        endpoint_advanced:
          type: string
          description: '<em>URL for collecting the results of the SERP Advanced task</em><br>if SERP Advanced is not supported in the specified endpoint, the value will be <code>null</code>'
          nullable: true
        endpoint_html:
          type: string
          description: '<em>URL for collecting the results of the SERP HTML task</em><br>if SERP HTML is not supported in the specified endpoint, the value will be <code>null</code>'
          nullable: true
    SerpYoutubeVideoInfoTasksReadyTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpYoutubeVideoInfoTasksReadyResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    SerpYoutubeVideoInfoTasksReadyResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpYoutubeVideoInfoTasksReadyTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    SerpYoutubeVideoInfoTasksFixedResultInfo:
      type: object
      properties:
        id:
          type: string
          description: <em>task identifier of the completed task</em><br><strong>unique task identifier in our system in the <a href="https://en.wikipedia.org/wiki/Universally_unique_identifier">UUID</a> format</strong>
          nullable: true
        se:
          type: string
          description: <em>search engine specified when setting the task</em>
          nullable: true
        se_type:
          type: string
          description: '<em>type of search engine</em><br>can take the following values: <code>{{low_se_type_under}}</code>'
          nullable: true
        date_posted:
          type: string
          nullable: true
        tag:
          type: string
          description: <em>user-defined task identifier</em>
          nullable: true
        endpoint_regular:
          type: string
          description: '<em>URL for collecting the results of the SERP Regular task</em><br>if SERP Regular is not supported in the specified endpoint, the value will be <code>null</code>'
          nullable: true
        endpoint_advanced:
          type: string
          description: '<em>URL for collecting the results of the SERP Advanced task</em><br>if SERP Advanced is not supported in the specified endpoint, the value will be <code>null</code>'
          nullable: true
        endpoint_html:
          type: string
          description: '<em>URL for collecting the results of the SERP HTML task</em><br>if SERP HTML is not supported in the specified endpoint, the value will be <code>null</code>'
          nullable: true
    SerpYoutubeVideoInfoTasksFixedTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpYoutubeVideoInfoTasksFixedResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    SerpYoutubeVideoInfoTasksFixedResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpYoutubeVideoInfoTasksFixedTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    ChannelSubscribersCount:
      type: object
      properties:
        displayed_count:
          type: string
          description: <em>displayed subscriber count</em><br>            subscriber count as displayed on YouTube
          nullable: true
        count:
          type: integer
          description: <em>subscriber count</em>
          format: int64
          nullable: true
    Subtitles:
      type: object
      properties:
        language:
          type: string
          description: <em>language of subtitles</em>
          nullable: true
        is_translatable:
          type: boolean
          description: <em>defines if subtitles are translatable</em>
          nullable: true
        is_auto_generated:
          type: boolean
          description: <em>defines if subtitles are auto generated</em>
          nullable: true
    StreamingQualityElement:
      type: object
      properties:
        type:
          type: string
          description: type of element
          nullable: true
        label:
          type: string
          description: <em>label of the quality element</em>
          nullable: true
        width:
          type: integer
          description: <em>video width in pixels</em>
          format: int64
          nullable: true
        height:
          type: integer
          description: <em>video height in pixels</em>
          nullable: true
        bitrate:
          type: integer
          description: <em><a href="https://en.wikipedia.org/wiki/Bit_rate" target="_blank" rel="noopener noreferrer">bit rate</a> of the video</em>
          nullable: true
        mime_type:
          type: string
          description: <em><a href="https://en.wikipedia.org/wiki/Media_type" target="_blank" rel="noopener noreferrer">media type</a> of the video</em>
          nullable: true
        fps:
          type: integer
          description: <em><a href="https://en.wikipedia.org/wiki/Frame_rate" target="_blank" rel="noopener noreferrer">frame rate</a> of the video</em>
          nullable: true
    YoutubeVideoInfo:
      type: object
      properties:
        type:
          type: string
          description: type of element
          nullable: true
        rank_group:
          type: integer
          description: <em>group rank in SERP</em><br>            position within a group of elements with identical <code>type</code> values<br>            positions of elements with different <code>type</code> values are omitted from <code>rank_group</code>
          nullable: true
        rank_absolute:
          type: integer
          description: <em> absolute rank in SERP for the target domain</em><br>            absolute position among all the elements in SERP
          nullable: true
        video_id:
          type: string
          description: <em>ID of the video received in a POST array</em>
          nullable: true
        title:
          type: string
          description: <em>title of the video</em>
          nullable: true
        url:
          type: string
          description: <em>URL of the video</em>
          nullable: true
        thumbnail_url:
          type: string
          description: <em>the URL of the page where the thumbnail is hosted</em>
          nullable: true
        channel_id:
          type: string
          description: <em>the ID of the channel where the video is published</em>
          nullable: true
        channel_name:
          type: string
          description: <em>the name of the channel where the video is published</em>
          nullable: true
        channel_url:
          type: string
          description: <em>the URL of the channel where the video is published</em>
          nullable: true
        channel_logo:
          type: string
          description: <em>the URL of the page where the logo image of the channel is hosted</em>
          nullable: true
        description:
          type: string
          description: <em>description of the video</em>
          nullable: true
        views_count:
          type: integer
          description: <em>number of views of the video</em>
          format: int64
          nullable: true
        likes_count:
          type: integer
          description: <em>number of likes on the video</em>
          format: int64
          nullable: true
        comments_count:
          type: integer
          description: <em>number of comments on the video</em>
          format: int64
          nullable: true
        channel_subscribers_count:
          type: object
          oneOf:
            - $ref: '#/components/schemas/ChannelSubscribersCount'
          description: <em>number of subscribers of the channel</em>
          nullable: true
        publication_date:
          type: string
          description: <em>the date when the video is published</em>
          nullable: true
        timestamp:
          type: string
          description: '<em>date and time when the result is published</em><br>            in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”<br>            example:<br>            <code>2022-11-15 12:57:46 +00:00</code>'
          nullable: true
        keywords:
          type: array
          items:
            type: string
            nullable: true
          description: <em>keywords relevant to the video</em><br>            also known as 'YouTube tags'
          nullable: true
        category:
          type: string
          description: <em>the category the video belongs to</em>
          nullable: true
        is_live:
          type: boolean
          description: <em>indicates whether the video is on live</em>
          nullable: true
        is_embeddable:
          type: boolean
          description: <em>indicates whether the video is embeddable</em>
          nullable: true
        duration_time:
          type: string
          description: <em>duration of the video</em>
          nullable: true
        duration_time_seconds:
          type: integer
          description: <em>duration of the video in seconds</em>
          nullable: true
        subtitles:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/Subtitles'
            nullable: true
          description: <em>array of elements describing properties of subtitles in the video</em>
          nullable: true
        streaming_quality:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/StreamingQualityElement'
            nullable: true
          description: <em>array of elements that contain information about all possible streaming qualities of the video</em>
          nullable: true
    SerpYoutubeVideoInfoTaskGetAdvancedResultInfo:
      type: object
      properties:
        video_id:
          type: string
          description: <em>ID of the video received in a POST array</em>
          nullable: true
        se_domain:
          type: string
          description: <em>search engine domain in a POST array</em>
          nullable: true
        location_code:
          type: integer
          description: <em>location code in a POST array</em>
          nullable: true
        language_code:
          type: string
          description: <em>language code in a POST array</em>
          nullable: true
        check_url:
          type: string
          description: <em>direct URL to search engine results<br>        </em>you can use it to make sure that we provided accurate results
          nullable: true
        datetime:
          type: string
          description: '<em>date and time when the result was received</em><br>            in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”<br>            example:<br>            <code class="long-string">2019-11-15 12:57:46 +00:00</code>'
          nullable: true
        spell:
          type: object
          oneOf:
            - $ref: '#/components/schemas/SpellInfo'
          description: '<em>autocorrection of the search engine</em><br>            if the search engine provided results for a keyword that was corrected, we will specify the keyword corrected by the search engine and the type of autocorrection'
          nullable: true
        item_types:
          type: array
          items:
            type: string
            nullable: true
          description: <em>types of search results in SERP</em><br>            contains types of search results (<code>items</code>) found in SERP.<br>            possible item:<br>            <code>youtube_video_info</code>
          nullable: true
        items_count:
          type: integer
          description: <em>the number of results returned in the <strong><code>items</code></strong> array</em>
          format: int64
          nullable: true
        items:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/YoutubeVideoInfo'
            nullable: true
          description: <em>elements of search results found in SERP</em>
          nullable: true
    SerpYoutubeVideoInfoTaskGetAdvancedTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpYoutubeVideoInfoTaskGetAdvancedResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    SerpYoutubeVideoInfoTaskGetAdvancedResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpYoutubeVideoInfoTaskGetAdvancedTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    SerpYoutubeVideoInfoLiveAdvancedRequestInfo:
      type: object
      properties:
        video_id:
          type: string
          description: "ID of the video\nrequired field\nyou can find video ID in the URL or 'youtube_video' item of YouTube Organic result\nexample:\nvQXvyV0zIP4"
        location_code:
          type: integer
          description: "search engine location code\nrequired field if you don't specify location_name \nif you use this field, you don't need to specify location_name\nyou can receive the list of available locations of the search engines with their location_code by making a separate request to the https://api.dataforseo.com/v3/serp/youtube/locations\nexample:\n2840"
          nullable: true
        language_code:
          type: string
          description: "search engine language code\nrequired field if you don't specify language_name\nif you use this field, you don't need to specify language_name\nyou can receive the list of available languages of the search engine with their language_code by making a separate request to the https://api.dataforseo.com/v3/serp/youtube/languages\nexample:\nen"
          nullable: true
        device:
          type: string
          description: "device type\noptional field\nonly value: desktop"
          nullable: true
        location_name:
          type: string
          description: "full name of search engine location\nrequired field if you don't specify location_code\nif you use this field, you don't need to specify location_code\nyou can receive the list of available locations of the search engine with their location_name by making a separate request to the https://api.dataforseo.com/v3/serp/youtube/locations\nexample:\nUnited States"
          nullable: true
        language_name:
          type: string
          description: "full name of search engine language\nrequired field if you don't specify language_code\nif you use this field, you don't need to specify language_code\nyou can receive the list of available languages of the search engine with their language_name by making a separate request to the https://api.dataforseo.com/v3/serp/youtube/languages\nexample:\nEnglish"
          nullable: true
        os:
          type: string
          description: "device operating system\noptional field\nchoose from the following values: windows, macos\ndefault value: windows"
          nullable: true
        tag:
          type: string
          description: "user-defined task identifier\noptional field\nthe character limit is 255\nyou can use this parameter to identify the task and match it with the result\nyou will find the specified tag value in the data object of the response"
          nullable: true
      example:
        - language_code: en
          location_code: 2840
          video_id: vQXvyV0zIP4
    SerpYoutubeVideoInfoLiveAdvancedResultInfo:
      type: object
      properties:
        video_id:
          type: string
          description: ID of the video received in a POST array
          nullable: true
        se_domain:
          type: string
          description: search engine domain in a POST array
          nullable: true
        location_code:
          type: integer
          description: location code in a POST array
          nullable: true
        language_code:
          type: string
          description: language code in a POST array
          nullable: true
        check_url:
          type: string
          description: "direct URL to search engine results\nyou can use it to make sure that we provided accurate results"
          nullable: true
        datetime:
          type: string
          description: "date and time when the result was received\nin the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”\nexample:\n2019-11-15 12:57:46 +00:00"
          nullable: true
        spell:
          type: object
          oneOf:
            - $ref: '#/components/schemas/SpellInfo'
          description: "autocorrection of the search engine\nif the search engine provided results for a keyword that was corrected, we will specify the keyword corrected by the search engine and the type of autocorrection"
          nullable: true
        item_types:
          type: array
          items:
            type: string
            nullable: true
          description: "types of search results in SERP\ncontains types of search results (items) found in SERP.\npossible item:\nyoutube_video_info"
          nullable: true
        items_count:
          type: integer
          description: the number of results returned in the items array
          format: int64
          nullable: true
        items:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/YoutubeVideoInfo'
            nullable: true
          description: elements of search results found in SERP
          nullable: true
    SerpYoutubeVideoInfoLiveAdvancedTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpYoutubeVideoInfoLiveAdvancedResultInfo'
                nullable: true
              description: array of results
              nullable: true
    SerpYoutubeVideoInfoLiveAdvancedResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpYoutubeVideoInfoLiveAdvancedTaskInfo'
                nullable: true
              description: array of tasks
              nullable: true
    SerpYoutubeOrganicTaskPostRequestInfo:
      type: object
      properties:
        keyword:
          type: string
          description: "keyword\nrequired field\nyou can specify up to 700 characters in the keyword field\nall %## will be decoded (plus character ‘+’ will be decoded to a space character)\nif you need to use the “%” character for your keyword, please specify it as “%25”;\nif you need to use the “+” character for your keyword, please specify it as “%2B”;\nlearn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article"
        location_code:
          type: integer
          description: "search engine location code\nrequired field if you don't specify location_name\nif you use this field, you don't need to specify location_name\nyou can receive the list of available locations of the search engines with their location_code by making a separate request to the https://api.dataforseo.com/v3/serp/youtube/locations\nexample:\n2840"
          nullable: true
        language_code:
          type: string
          description: "search engine language code\nrequired field if you don't specify language_name\nif you use this field, you don't need to specify language_name\nyou can receive the list of available languages of the search engine with their language_code by making a separate request to the https://api.dataforseo.com/v3/serp/youtube/languages\nexample:\nen"
          nullable: true
        device:
          type: string
          description: "device type\noptional field\nreturn results for a specific device type\navailable values: desktop, mobile"
          nullable: true
        priority:
          type: integer
          description: "task priority\noptional field\ncan take the following values:\n1 – normal execution priority (set by default)\n2 – high execution priority\nYou will be additionally charged for the tasks with high execution priority.\nThe cost can be calculated on the Pricing page."
          nullable: true
        pingback_url:
          type: string
          description: "notification URL of a completed task\noptional field\nwhen a task is completed we will notify you by GET request sent to the URL you have specified\nyou can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request.\nexample:\nhttp://your-server.com/pingscript?id=$id\nhttp://your-server.com/pingscript?id=$id&tag=$tag\nNote: special characters in pingback_url will be urlencoded;\ni.a., the # character will be encoded into %23\nlearn more on our Help Center"
          nullable: true
        postback_url:
          type: string
          description: "return URL for sending task results\noptional field\nonce the task is completed, we will send a POST request with its results compressed in the gzip format to the postback_url you specified\nyou can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request.\nexample:\nhttp://your-server.com/postbackscript?id=$id\nhttp://your-server.com/postbackscript?id=$id&tag=$tag\nNote: special characters in postback_url will be urlencoded;\ni.a., the # character will be encoded into %23\nlearn more on our Help Center"
          nullable: true
        postback_data:
          type: string
          description: "postback_url datatype\nrequired field if you specify postback_url\ncorresponds to the datatype that will be sent to your server\npossible value:\nadvanced"
          nullable: true
        location_name:
          type: string
          description: "full name of search engine location\nrequired field if you don't specify location_code\nif you use this field, you don't need to specify location_code\nyou can receive the list of available locations of the search engine with their location_name by making a separate request to the https://api.dataforseo.com/v3/serp/youtube/locations\nexample:\nUnited States"
          nullable: true
        language_name:
          type: string
          description: "full name of search engine language\nrequired field if you don't specify language_code\nif you use this field, you don't need to specify language_code\nyou can receive the list of available languages of the search engine with their language_name by making a separate request to the https://api.dataforseo.com/v3/serp/youtube/languages\nexample:\nEnglish"
          nullable: true
        os:
          type: string
          description: "device operating system\noptional field\nif you specify desktop in the device field, choose from the following values: windows, macos\ndefault value: windows\nif you specify mobile in the device field, choose from the following values: android, ios\ndefault value: android"
          nullable: true
        tag:
          type: string
          description: "user-defined task identifier\noptional field\nthe character limit is 255\nyou can use this parameter to identify the task and match it with the result\nyou will find the specified tag value in the data object of the response"
          nullable: true
        search_param:
          type: string
          description: "additional parameters of the search query\noptional field\nexample:\nsp=EgIQAg%253D%253D"
          nullable: true
        block_depth:
          type: integer
          description: "parsing depth\noptional field\nnumber of blocks of results in SERP\ndefault value: 20\nmax value: 700\nNote: your account will be billed per each SERP containing up to 20 blocks of results;\nthus, setting a block depth above 20 may result in additional charges if the search engine returns more than 20 results;\nif the specified block depth is higher than the number of results in the response, the difference will be refunded automatically to your account balance"
          nullable: true
      example:
        - language_code: en
          location_code: 2840
          keyword: audi
    SerpYoutubeOrganicTaskPostTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: object
              description: 'array of resultsin this case, the value will be null'
              nullable: true
    SerpYoutubeOrganicTaskPostResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpYoutubeOrganicTaskPostTaskInfo'
                nullable: true
              description: array of tasks
              nullable: true
    SerpYoutubeOrganicTasksReadyResultInfo:
      type: object
      properties:
        id:
          type: string
          description: <em>task identifier of the completed task</em><br><strong>unique task identifier in our system in the <a href="https://en.wikipedia.org/wiki/Universally_unique_identifier">UUID</a> format</strong>
          nullable: true
        se:
          type: string
          description: <em>search engine specified when setting the task</em>
          nullable: true
        se_type:
          type: string
          description: '<em>type of search engine</em><br>example: <code>{{low_se_type_under}}</code>'
          nullable: true
        date_posted:
          type: string
          description: <em>date when the task was posted (in the UTC format)</em>
          nullable: true
        tag:
          type: string
          description: <em>user-defined task identifier</em>
          nullable: true
        endpoint_regular:
          type: string
          description: '<em>URL for collecting the results of the SERP Regular task</em><br>if SERP Regular is not supported in the specified endpoint, the value will be <code>null</code>'
          nullable: true
        endpoint_advanced:
          type: string
          description: '<em>URL for collecting the results of the SERP Advanced task</em><br>if SERP Advanced is not supported in the specified endpoint, the value will be <code>null</code>'
          nullable: true
        endpoint_html:
          type: string
          description: '<em>URL for collecting the results of the SERP HTML task</em><br>if SERP HTML is not supported in the specified endpoint, the value will be <code>null</code>'
          nullable: true
    SerpYoutubeOrganicTasksReadyTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpYoutubeOrganicTasksReadyResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    SerpYoutubeOrganicTasksReadyResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpYoutubeOrganicTasksReadyTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    SerpYoutubeOrganicTasksFixedResultInfo:
      type: object
      properties:
        id:
          type: string
          description: <em>task identifier of the completed task</em><br><strong>unique task identifier in our system in the <a href="https://en.wikipedia.org/wiki/Universally_unique_identifier">UUID</a> format</strong>
          nullable: true
        se:
          type: string
          description: <em>search engine specified when setting the task</em>
          nullable: true
        se_type:
          type: string
          description: '<em>type of search engine</em><br>can take the following values: <code>{{low_se_type_under}}</code>'
          nullable: true
        date_fixed:
          type: string
          description: <em>date when the task was fixed (in the UTC format)</em>
          nullable: true
        tag:
          type: string
          description: <em>user-defined task identifier</em>
          nullable: true
        endpoint_regular:
          type: string
          description: '<em>URL for collecting the results of the SERP Regular task</em><br>if SERP Regular is not supported in the specified endpoint, the value will be <code>null</code>'
          nullable: true
        endpoint_advanced:
          type: string
          description: '<em>URL for collecting the results of the SERP Advanced task</em><br>if SERP Advanced is not supported in the specified endpoint, the value will be <code>null</code>'
          nullable: true
        endpoint_html:
          type: string
          description: '<em>URL for collecting the results of the SERP HTML task</em><br>if SERP HTML is not supported in the specified endpoint, the value will be <code>null</code>'
          nullable: true
    SerpYoutubeOrganicTasksFixedTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpYoutubeOrganicTasksFixedResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    SerpYoutubeOrganicTasksFixedResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpYoutubeOrganicTasksFixedTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    SerpApiYoutubeChannelElementItem:
      type: object
      allOf:
        - type: object
          oneOf:
            - $ref: '#/components/schemas/BaseSerpApiYoutubeOrganicElementItem'
          nullable: true
        - type: object
          properties:
            name:
              type: string
              description: <em>name of the channel</em>
              nullable: true
            logo:
              type: string
              description: <em>the URL of the page where the logo image is hosted</em>
              nullable: true
            video_count:
              type: integer
              description: <em>the number of videos counted on the channel</em>
              format: int64
              nullable: true
            is_verified:
              type: boolean
              description: <em>indicates whether the channel has a "verified" label</em>
              nullable: true
            description:
              type: string
              description: <em>description of the channel</em>
              nullable: true
            highlighted:
              type: array
              items:
                type: string
                nullable: true
              description: <em>highlighted keywords in the description</em>
              nullable: true
    SerpApiYoutubeVideoElementItem:
      type: object
      allOf:
        - type: object
          oneOf:
            - $ref: '#/components/schemas/BaseSerpApiYoutubeOrganicElementItem'
          nullable: true
        - type: object
          properties:
            title:
              type: string
              description: <em>title of the video</em>
              nullable: true
            video_id:
              type: string
              description: <em>ID of the video</em>
              nullable: true
            thumbnail_url:
              type: string
              description: <em>the URL of the page where the thumbnail is hosted</em>
              nullable: true
            channel_name:
              type: string
              description: <em>the name of the channel where the video is published</em>
              nullable: true
            channel_url:
              type: string
              description: <em>the URL of the channel where the video is published</em>
              nullable: true
            channel_logo:
              type: string
              description: <em>the URL of the page where the logo image of the channel is hosted</em>
              nullable: true
            description:
              type: string
              description: <em>description of the channel</em>
              nullable: true
            highlighted:
              type: array
              items:
                type: string
                nullable: true
              description: <em>highlighted keywords in the description</em>
              nullable: true
            badges:
              type: array
              items:
                type: string
                nullable: true
              description: '<em>video badges</em><br>            example:<br>            <code>New</code>, <code>CC</code>, <code>4K</code><br>'
              nullable: true
            is_live:
              type: boolean
              description: <em>indicates whether the video is a live broadcast</em>
              nullable: true
            is_shorts:
              type: boolean
              description: <em>indicates whether the video is shorts</em>
              nullable: true
            is_movie:
              type: boolean
              description: <em>indicates whether the video is a movie</em>
              nullable: true
            views_count:
              type: integer
              description: <em>number of views of the video</em>
              format: int64
              nullable: true
            publication_date:
              type: string
              description: <em>the date when the video is published</em>
              nullable: true
            timestamp:
              type: string
              description: '<em>date and time when the result is published</em><br>            in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”<br>            example:<br>            <code>2022-11-15 12:57:46 +00:00</code><br>'
              nullable: true
            duration_time:
              type: string
              description: <em>duration of the video</em>
              nullable: true
            duration_time_seconds:
              type: integer
              description: <em>duration of the video in seconds</em>
              nullable: true
    SerpApiYoutubeVideoPaidElementItem:
      type: object
      allOf:
        - type: object
          oneOf:
            - $ref: '#/components/schemas/BaseSerpApiYoutubeOrganicElementItem'
          nullable: true
        - type: object
          properties:
            title:
              type: string
              description: <em>title of the video</em>
              nullable: true
            video_id:
              type: string
              description: <em>ID of the video</em>
              nullable: true
            thumbnail_url:
              type: string
              description: <em>the URL of the page where the thumbnail is hosted</em>
              nullable: true
            channel_name:
              type: string
              description: <em>the name of the channel where the video is published</em>
              nullable: true
            channel_url:
              type: string
              description: <em>the URL of the channel where the video is published</em>
              nullable: true
            channel_logo:
              type: string
              description: <em>the URL of the page where the logo image of the channel is hosted</em>
              nullable: true
            description:
              type: string
              description: <em>description of the channel</em>
              nullable: true
            highlighted:
              type: array
              items:
                type: string
                nullable: true
              description: <em>highlighted keywords in the description</em>
              nullable: true
            badges:
              type: array
              items:
                type: string
                nullable: true
              description: '<em>video badges</em><br>            example:<br>            <code>New</code>, <code>CC</code>, <code>4K</code><br>'
              nullable: true
            is_live:
              type: boolean
              description: <em>indicates whether the video is a live broadcast</em>
              nullable: true
            is_shorts:
              type: boolean
              description: <em>indicates whether the video is shorts</em>
              nullable: true
            is_movie:
              type: boolean
              description: <em>indicates whether the video is a movie</em>
              nullable: true
            views_count:
              type: integer
              description: <em>number of views of the video</em>
              format: int64
              nullable: true
            publication_date:
              type: string
              description: <em>the date when the video is published</em>
              nullable: true
            timestamp:
              type: string
              description: '<em>date and time when the result is published</em><br>            in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”<br>            example:<br>            <code>2022-11-15 12:57:46 +00:00</code><br>'
              nullable: true
            duration_time:
              type: string
              description: <em>duration of the video</em>
              nullable: true
            duration_time_seconds:
              type: integer
              description: <em>duration of the video in seconds</em>
              nullable: true
    PreviewVideos:
      type: object
      properties:
        video_id:
          type: string
          description: <em>ID of the video</em>
          nullable: true
        title:
          type: string
          description: <em>title of the video</em>
          nullable: true
        url:
          type: string
          description: <em>URL of the video</em>
          nullable: true
        duration_time:
          type: string
          description: <em>duration of the video</em>
          nullable: true
        duration_time_seconds:
          type: integer
          description: <em>duration of the video in seconds</em>
          nullable: true
    SerpApiYoutubePlaylistElementItem:
      type: object
      allOf:
        - type: object
          oneOf:
            - $ref: '#/components/schemas/BaseSerpApiYoutubeOrganicElementItem'
          nullable: true
        - type: object
          properties:
            title:
              type: string
              description: <em>title of the video</em>
              nullable: true
            playlist_id:
              type: string
              description: <em>ID of the video</em>
              nullable: true
            thumbnail_url:
              type: string
              description: <em>the URL of the page where the thumbnail is hosted</em>
              nullable: true
            channel_name:
              type: string
              description: <em>the name of the channel where the video is published</em>
              nullable: true
            channel_url:
              type: string
              description: <em>the URL of the channel where the video is published</em>
              nullable: true
            channel_logo:
              type: string
              description: <em>the URL of the page where the logo image of the channel is hosted</em>
              nullable: true
            videos_count:
              type: integer
              description: <em>the number of videos in playlist</em>
              format: int64
              nullable: true
            preview_videos:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/PreviewVideos'
                nullable: true
              description: <em>information about preview videos</em><br>            array of objects containing information about videos in the preview block of the playlist element
              nullable: true
    SerpYoutubeOrganicTaskGetAdvancedResultInfo:
      type: object
      properties:
        keyword:
          type: string
          description: <em>keyword received in a POST array<br>        </em><strong>the keyword is returned with decoded %## (plus symbol '+' will be decoded to a space character)</strong>
          nullable: true
        se_domain:
          type: string
          description: <em>search engine domain in a POST array</em>
          nullable: true
        location_code:
          type: integer
          description: <em>location code in a POST array</em>
          nullable: true
        language_code:
          type: string
          description: <em>language code in a POST array</em>
          nullable: true
        check_url:
          type: string
          description: <em>direct URL to search engine results<br>        </em>you can use it to make sure that we provided accurate results
          nullable: true
        datetime:
          type: string
          description: '<em>date and time when the result was received</em><br>            in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”<br>            example:<br>            <code class="long-string">2019-11-15 12:57:46 +00:00</code>'
          nullable: true
        spell:
          type: object
          oneOf:
            - $ref: '#/components/schemas/SpellInfo'
          description: '<em>autocorrection of the search engine</em><br>            if the search engine provided results for a keyword that was corrected, we will specify the keyword corrected by the search engine and the type of autocorrection'
          nullable: true
        item_types:
          type: array
          items:
            type: string
            nullable: true
          description: '<em>types of search results in SERP</em><br>            contains types of search results (<code>items</code>) found in SERP.<br>            possible item types:<br>            <code>youtube_channel</code>, <code>youtube_video</code>,  <code>youtube_video_paid</code>'
          nullable: true
        se_results_count:
          type: integer
          description: <em> total number of results in SERP</em>
          format: int64
          nullable: true
        items_count:
          type: integer
          description: <em>the number of results returned in the <strong><code>items</code></strong> array</em>
          format: int64
          nullable: true
        items:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/BaseSerpApiYoutubeOrganicElementItem'
            nullable: true
          description: <em>elements of search results found in SERP</em>
          nullable: true
    SerpYoutubeOrganicTaskGetAdvancedTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpYoutubeOrganicTaskGetAdvancedResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    SerpYoutubeOrganicTaskGetAdvancedResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpYoutubeOrganicTaskGetAdvancedTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    SerpYoutubeOrganicLiveAdvancedRequestInfo:
      type: object
      properties:
        keyword:
          type: string
          description: "keyword\nrequired field\nyou can specify up to 700 characters in the keyword field\nall %## will be decoded (plus character ‘+’ will be decoded to a space character)\nif you need to use the “%” character for your keyword, please specify it as “%25”;\nif you need to use the “+” character for your keyword, please specify it as “%2B”;\nlearn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article"
        location_code:
          type: integer
          description: "search engine location code\nrequired field if you don't specify location_name \nif you use this field, you don't need to specify location_name\nyou can receive the list of available locations of the search engines with their location_code by making a separate request to the https://api.dataforseo.com/v3/serp/youtube/locations\nexample:\n2840"
          nullable: true
        language_code:
          type: string
          description: "search engine language code\nrequired field if you don't specify language_name\nif you use this field, you don't need to specify language_name\nyou can receive the list of available languages of the search engine with their language_code by making a separate request to the https://api.dataforseo.com/v3/serp/youtube/languages\nexample:\nen"
          nullable: true
        device:
          type: string
          description: "device type\noptional field\nreturn results for a specific device type\navailable values: desktop, mobile"
          nullable: true
        block_depth:
          type: integer
          description: "parsing depth\noptional field\nnumber of blocks of results in SERP\ndefault value: 20\nmax value: 200\nNote: your account will be billed per each SERP containing up to 20 results;\nthus, setting a block depth above 20 may result in additional charges if the search engine returns more than 20 results;\nif the specified block depth is higher than the number of results in the response, the difference will be refunded automatically to your account balance"
          nullable: true
        location_name:
          type: string
          description: "full name of search engine location\nrequired field if you don't specify location_code\nif you use this field, you don't need to specify location_code\nyou can receive the list of available locations of the search engine with their location_name by making a separate request to the https://api.dataforseo.com/v3/serp/youtube/locations\nexample:\nUnited States"
          nullable: true
        language_name:
          type: string
          description: "full name of search engine language\nrequired field if you don't specify language_code\nif you use this field, you don't need to specify language_code\nyou can receive the list of available languages of the search engine with their language_name by making a separate request to the https://api.dataforseo.com/v3/serp/youtube/languages\nexample:\nEnglish"
          nullable: true
        os:
          type: string
          description: "device operating system\noptional field\nif you specify desktop in the device field, choose from the following values: windows, macos\ndefault value: windows\nif you specify mobile in the device field, choose from the following values: android, ios\ndefault value: android"
          nullable: true
        tag:
          type: string
          description: "user-defined task identifier\noptional field\nthe character limit is 255\nyou can use this parameter to identify the task and match it with the result\nyou will find the specified tag value in the data object of the response"
          nullable: true
        search_param:
          type: string
          description: "additional parameters of the search query\noptional field\nexample:\nsp=EgIQAg%253D%253D"
          nullable: true
      example:
        - language_code: en
          location_code: 2840
          keyword: audi
    SerpYoutubeOrganicLiveAdvancedResultInfo:
      type: object
      properties:
        keyword:
          type: string
          description: keyword received in a POST array        the keyword is returned with decoded %## (plus character '+' will be decoded to a space character)
          nullable: true
        se_domain:
          type: string
          description: search engine domain in a POST array
          nullable: true
        location_code:
          type: integer
          description: location code in a POST array
          nullable: true
        language_code:
          type: string
          description: language code in a POST array
          nullable: true
        check_url:
          type: string
          description: direct URL to search engine results        you can use it to make sure that we provided accurate results
          nullable: true
        datetime:
          type: string
          description: 'date and time when the result was received            in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”            example:            2019-11-15 12:57:46 +00:00'
          nullable: true
        spell:
          type: object
          oneOf:
            - $ref: '#/components/schemas/SpellInfo'
          description: 'autocorrection of the search engine            if the search engine provided results for a keyword that was corrected, we will specify the keyword corrected by the search engine and the type of autocorrection'
          nullable: true
        item_types:
          type: array
          items:
            type: string
            nullable: true
          description: 'types of search results in SERP            contains types of search results (items) found in SERP.            possible item types:            youtube_channel, youtube_video, youtube_video_paid, youtube_playlist'
          nullable: true
        se_results_count:
          type: integer
          description: total number of results in SERP
          format: int64
          nullable: true
        items_count:
          type: integer
          description: the number of results returned in the items array
          format: int64
          nullable: true
        items:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/BaseSerpApiYoutubeOrganicElementItem'
            nullable: true
          description: elements of search results found in SERP
          nullable: true
    SerpYoutubeOrganicLiveAdvancedTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpYoutubeOrganicLiveAdvancedResultInfo'
                nullable: true
              description: array of results
              nullable: true
    SerpYoutubeOrganicLiveAdvancedResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpYoutubeOrganicLiveAdvancedTaskInfo'
                nullable: true
              description: array of tasks
              nullable: true
    SerpYoutubeVideoSubtitlesTaskPostRequestInfo:
      type: object
      properties:
        video_id:
          type: string
          description: "ID of the video\nrequired field\nyou can find video ID in the URL or 'youtube_video' item of YouTube Organic result\nexample:\nY8Wu4rSNJms"
        location_code:
          type: integer
          description: "search engine location code\nrequired field if you don't specify location_name\nif you use this field, you don't need to specify location_name\nyou can receive the list of available locations of the search engines with their location_code by making a separate request to the https://api.dataforseo.com/v3/serp/youtube/locations\nexample:\n2840"
          nullable: true
        language_code:
          type: string
          description: "search engine language code\nrequired field if you don't specify language_name\nif you use this field, you don't need to specify language_name\nyou can receive the list of available languages of the search engine with their language_code by making a separate request to the https://api.dataforseo.com/v3/serp/youtube/languages\nexample:\nen"
          nullable: true
        priority:
          type: integer
          description: "task priority\noptional field\ncan take the following values:\n1 – normal execution priority (set by default)\n2 – high execution priority\nYou will be additionally charged for the tasks with high execution priority.\nThe cost can be calculated on the Pricing page."
          nullable: true
        device:
          type: string
          description: "device type\noptional field\nonly value: desktop"
          nullable: true
        pingback_url:
          type: string
          description: "notification URL of a completed task\noptional field\nwhen a task is completed we will notify you by GET request sent to the URL you have specified\nyou can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request.\nexample:\nhttp://your-server.com/pingscript?id=$id\nhttp://your-server.com/pingscript?id=$id&tag=$tag\nNote: special characters in pingback_url will be urlencoded;\ni.a., the # character will be encoded into %23\nlearn more on our Help Center"
          nullable: true
        postback_url:
          type: string
          description: "return URL for sending task results\noptional field\nonce the task is completed, we will send a POST request with its results compressed in the gzip format to the postback_url you specified\nyou can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request.\nexample:\nhttp://your-server.com/postbackscript?id=$id\nhttp://your-server.com/postbackscript?id=$id&tag=$tag\nNote: special characters in postback_url will be urlencoded;\ni.a., the # character will be encoded into %23\nlearn more on our Help Center"
          nullable: true
        postback_data:
          type: string
          description: "postback_url datatype\nrequired field if you specify postback_url\ncorresponds to the datatype that will be sent to your server\npossible value:\nadvanced"
          nullable: true
        location_name:
          type: string
          description: "full name of search engine location\nrequired field if you don't specify location_code\nif you use this field, you don't need to specify location_code\nyou can receive the list of available locations of the search engine with their location_name by making a separate request to the https://api.dataforseo.com/v3/serp/youtube/locations\nexample:\nUnited States"
          nullable: true
        language_name:
          type: string
          description: "full name of search engine language\nrequired field if you don't specify language_code\nif you use this field, you don't need to specify language_code\nyou can receive the list of available languages of the search engine with their language_name by making a separate request to the https://api.dataforseo.com/v3/serp/youtube/languages\nexample:\nEnglish"
          nullable: true
        os:
          type: string
          description: "device operating system\noptional field\nchoose from the following values: windows, macos\ndefault value: windows"
          nullable: true
        tag:
          type: string
          description: "user-defined task identifier\noptional field\nthe character limit is 255\nyou can use this parameter to identify the task and match it with the result\nyou will find the specified tag value in the data object of the response"
          nullable: true
        subtitles_language:
          type: string
          description: "language code of original text\nyou can get the language code from YouTube Video Info result"
          nullable: true
        subtitles_translate_language:
          type: string
          description: "language code of translated text\npossible values:\n\"az\", \"ay\", \"ak\", \"sq\", \"am\", \"en\", \"ar\", \"hy\", \"as\", \"af\", \"eu\", \"be\", \"bn\", \"my\", \"bg\", \"bs\", \"bho\", \"cy\", \"hu\", \"vi\", \"haw\", \"ht\", \"gl\", \"lg\", \"el\", \"ka\", \"gn\", \"gu\", \"gd\", \"da\", \"fy\", \"zu\", \"iw\", \"ig\", \"yi\", \"id\", \"ga\", \"is\", \"es\", \"it\", \"yo\", \"kk\", \"kn\", \"ca\", \"qu\", \"rw\", \"ky\", \"zh-Hant\", \"zh-Hans\", \"ko\", \"co\", \"xh\", \"ku\", \"km\", \"lo\", \"la\", \"lv\", \"ln\", \"lt\", \"lb\", \"mk\", \"mg\", \"ms\", \"ml\", \"dv\", \"mt\", \"mi\", \"mr\", \"mn\", \"und\", \"de\", \"ne\", \"nl\", \"no\", \"ny\", \"or\", \"om\", \"pa\", \"fa\", \"pl\", \"pt\", \"ps\", \"ro\", \"ru\", \"sm\", \"sa\", \"ceb\", \"nso\", \"sr\", \"si\", \"sd\", \"sk\", \"sl\", \"so\", \"sw\", \"su\", \"tg\", \"th\", \"ta\", \"tt\", \"te\", \"ti\", \"ts\", \"tr\", \"tk\", \"uz\", \"ug\", \"uk\", \"ur\", \"fil\", \"fi\", \"fr\", \"ha\", \"hi\", \"hmn\", \"hr\", \"cs\", \"sv\", \"sn\", \"ee\", \"eo\", \"et\", \"st\", \"jv\", \"ja\", \"kri\""
          nullable: true
      example:
        - language_code: en
          location_code: 2840
          video_id: Y8Wu4rSNJms
    SerpYoutubeVideoSubtitlesTaskPostTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: object
              description: 'array of resultsin this case, the value will be null'
              nullable: true
    SerpYoutubeVideoSubtitlesTaskPostResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpYoutubeVideoSubtitlesTaskPostTaskInfo'
                nullable: true
              description: array of tasks
              nullable: true
    SerpYoutubeVideoSubtitlesTasksReadyResultInfo:
      type: object
      properties:
        id:
          type: string
          description: <em>task identifier of the completed task</em><br><strong>unique task identifier in our system in the <a href="https://en.wikipedia.org/wiki/Universally_unique_identifier">UUID</a> format</strong>
          nullable: true
        se:
          type: string
          description: <em>search engine specified when setting the task</em>
          nullable: true
        se_type:
          type: string
          description: '<em>type of search engine</em><br>example: <code>{{low_se_type_under}}</code>'
          nullable: true
        date_posted:
          type: string
          description: <em>date when the task was posted (in the UTC format)</em>
          nullable: true
        tag:
          type: string
          description: <em>user-defined task identifier</em>
          nullable: true
        endpoint_regular:
          type: string
          description: '<em>URL for collecting the results of the SERP Regular task</em><br>if SERP Regular is not supported in the specified endpoint, the value will be <code>null</code>'
          nullable: true
        endpoint_advanced:
          type: string
          description: '<em>URL for collecting the results of the SERP Advanced task</em><br>if SERP Advanced is not supported in the specified endpoint, the value will be <code>null</code>'
          nullable: true
        endpoint_html:
          type: string
          description: '<em>URL for collecting the results of the SERP HTML task</em><br>if SERP HTML is not supported in the specified endpoint, the value will be <code>null</code>'
          nullable: true
    SerpYoutubeVideoSubtitlesTasksReadyTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpYoutubeVideoSubtitlesTasksReadyResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    SerpYoutubeVideoSubtitlesTasksReadyResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpYoutubeVideoSubtitlesTasksReadyTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    SerpYoutubeVideoSubtitlesTasksFixedResultInfo:
      type: object
      properties:
        id:
          type: string
          description: <em>task identifier of the completed task</em><br><strong>unique task identifier in our system in the <a href="https://en.wikipedia.org/wiki/Universally_unique_identifier">UUID</a> format</strong>
          nullable: true
        se:
          type: string
          description: <em>search engine specified when setting the task</em>
          nullable: true
        se_type:
          type: string
          description: '<em>type of search engine</em><br>can take the following values: <code>{{low_se_type_under}}</code>'
          nullable: true
        date_posted:
          type: string
          nullable: true
        tag:
          type: string
          description: <em>user-defined task identifier</em>
          nullable: true
        endpoint_regular:
          type: string
          description: '<em>URL for collecting the results of the SERP Regular task</em><br>if SERP Regular is not supported in the specified endpoint, the value will be <code>null</code>'
          nullable: true
        endpoint_advanced:
          type: string
          description: '<em>URL for collecting the results of the SERP Advanced task</em><br>if SERP Advanced is not supported in the specified endpoint, the value will be <code>null</code>'
          nullable: true
        endpoint_html:
          type: string
          description: '<em>URL for collecting the results of the SERP HTML task</em><br>if SERP HTML is not supported in the specified endpoint, the value will be <code>null</code>'
          nullable: true
    SerpYoutubeVideoSubtitlesTasksFixedTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpYoutubeVideoSubtitlesTasksFixedResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    SerpYoutubeVideoSubtitlesTasksFixedResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpYoutubeVideoSubtitlesTasksFixedTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    YoutubeSubtitles:
      type: object
      properties:
        type:
          type: string
          description: type of element
          nullable: true
        rank_group:
          type: integer
          description: <em>group rank in SERP</em><br>position within a group of elements with identical <code>type</code> values<br>positions of elements with different <code>type</code> values are omitted from <code>rank_group</code>
          nullable: true
        rank_absolute:
          type: integer
          description: <em> absolute rank in SERP for the target domain</em><br>absolute position among all the elements in SERP
          nullable: true
        text:
          type: string
          description: <em>text translated in subtitles</em>
          nullable: true
        start_time:
          type: number
          description: <em>the second subtitled text starts</em>
          nullable: true
        end_time:
          type: number
          description: <em>the second subtitled text ends</em>
          nullable: true
        duration_time:
          type: number
          description: <em>duration of subtitles in seconds</em>
          nullable: true
    SerpYoutubeVideoSubtitlesTaskGetAdvancedResultInfo:
      type: object
      properties:
        video_id:
          type: string
          description: <em>ID of the video received in a POST array</em>
          nullable: true
        se_domain:
          type: string
          description: <em>search engine domain in a POST array</em>
          nullable: true
        location_code:
          type: integer
          description: <em>location code in a POST array</em>
          nullable: true
        language_code:
          type: string
          description: <em>language code in a POST array</em>
          nullable: true
        check_url:
          type: string
          description: <em>direct URL to search engine results<br></em>you can use it to make sure that we provided accurate results
          nullable: true
        datetime:
          type: string
          description: '<em>date and time when the result was received</em><br>in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”<br>example:<br><code class="long-string">2019-11-15 12:57:46 +00:00</code>'
          nullable: true
        spell:
          type: object
          oneOf:
            - $ref: '#/components/schemas/SpellInfo'
          description: '<em>autocorrection of the search engine</em><br>if the search engine provided results for a keyword that was corrected, we will specify the keyword corrected by the search engine and the type of autocorrection'
          nullable: true
        item_types:
          type: array
          items:
            type: string
            nullable: true
          description: <em>types of search results in SERP</em><br>contains types of search results (<code>items</code>) found in SERP.<br>possible item:<br><code>youtube_subtitles</code>
          nullable: true
        unsupported_language:
          type: boolean
          description: <em>indicates whether the language is unsupported by the system</em>
          nullable: true
        translate_language:
          type: string
          description: <em>language code of translated text</em>
          nullable: true
        origin_language:
          type: string
          description: <em>language code of original text</em>
          nullable: true
        category:
          type: string
          description: <em>the category the video belongs to</em><br><strong>Note:</strong> this field is deprecated and always returns <code>null</code>
          nullable: true
        subtitles_count:
          type: integer
          description: <em>number of subtitles in the video</em>
          format: int64
          nullable: true
        title:
          type: string
          description: <em>title of the video</em>
          nullable: true
        items_count:
          type: integer
          description: <em>the number of results returned in the <strong><code>items</code></strong> array</em>
          format: int64
          nullable: true
        items:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/YoutubeSubtitles'
            nullable: true
          description: <em>elements of search results found in SERP</em>
          nullable: true
    SerpYoutubeVideoSubtitlesTaskGetAdvancedTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpYoutubeVideoSubtitlesTaskGetAdvancedResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    SerpYoutubeVideoSubtitlesTaskGetAdvancedResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpYoutubeVideoSubtitlesTaskGetAdvancedTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    SerpYoutubeVideoSubtitlesLiveAdvancedRequestInfo:
      type: object
      properties:
        video_id:
          type: string
          description: "ID of the video\nrequired field\nyou can find video ID in the URL or 'youtube_video' item of YouTube Organic result\nexample:\nY8Wu4rSNJms"
        location_code:
          type: integer
          description: "search engine location code\nrequired field if you don't specify location_name \nif you use this field, you don't need to specify location_name\nyou can receive the list of available locations of the search engines with their location_code by making a separate request to the https://api.dataforseo.com/v3/serp/youtube/locations\nexample:\n2840"
          nullable: true
        language_code:
          type: string
          description: "search engine language code\nrequired field if you don't specify language_name\nif you use this field, you don't need to specify language_name\nyou can receive the list of available languages of the search engine with their language_code by making a separate request to the https://api.dataforseo.com/v3/serp/youtube/languages\nexample:\nen"
          nullable: true
        device:
          type: string
          description: "device type\noptional field\nonly value: desktop"
          nullable: true
        location_name:
          type: string
          description: "full name of search engine location\nrequired field if you don't specify location_code\nif you use this field, you don't need to specify location_code\nyou can receive the list of available locations of the search engine with their location_name by making a separate request to the https://api.dataforseo.com/v3/serp/youtube/locations\nexample:\nUnited States"
          nullable: true
        language_name:
          type: string
          description: "full name of search engine language\nrequired field if you don't specify language_code\nif you use this field, you don't need to specify language_code\nyou can receive the list of available languages of the search engine with their language_name by making a separate request to the https://api.dataforseo.com/v3/serp/youtube/languages\nexample:\nEnglish"
          nullable: true
        os:
          type: string
          description: "device operating system\noptional field\nchoose from the following values: windows, macos\ndefault value: windows"
          nullable: true
        tag:
          type: string
          description: "user-defined task identifier\noptional field\nthe character limit is 255\nyou can use this parameter to identify the task and match it with the result\nyou will find the specified tag value in the data object of the response"
          nullable: true
        subtitles_language:
          type: string
          description: "language code of original text\nyou can get the language code from YouTube Video Info result"
          nullable: true
        subtitles_translate_language:
          type: string
          description: "language code of translated text\npossible values:\n\"az\", \"ay\", \"ak\", \"sq\", \"am\", \"en\", \"ar\", \"hy\", \"as\", \"af\", \"eu\", \"be\", \"bn\", \"my\", \"bg\", \"bs\", \"bho\", \"cy\", \"hu\", \"vi\", \"haw\", \"ht\", \"gl\", \"lg\", \"el\", \"ka\", \"gn\", \"gu\", \"gd\", \"da\", \"fy\", \"zu\", \"iw\", \"ig\", \"yi\", \"id\", \"ga\", \"is\", \"es\", \"it\", \"yo\", \"kk\", \"kn\", \"ca\", \"qu\", \"rw\", \"ky\", \"zh-Hant\", \"zh-Hans\", \"ko\", \"co\", \"xh\", \"ku\", \"km\", \"lo\", \"la\", \"lv\", \"ln\", \"lt\", \"lb\", \"mk\", \"mg\", \"ms\", \"ml\", \"dv\", \"mt\", \"mi\", \"mr\", \"mn\", \"und\", \"de\", \"ne\", \"nl\", \"no\", \"ny\", \"or\", \"om\", \"pa\", \"fa\", \"pl\", \"pt\", \"ps\", \"ro\", \"ru\", \"sm\", \"sa\", \"ceb\", \"nso\", \"sr\", \"si\", \"sd\", \"sk\", \"sl\", \"so\", \"sw\", \"su\", \"tg\", \"th\", \"ta\", \"tt\", \"te\", \"ti\", \"ts\", \"tr\", \"tk\", \"uz\", \"ug\", \"uk\", \"ur\", \"fil\", \"fi\", \"fr\", \"ha\", \"hi\", \"hmn\", \"hr\", \"cs\", \"sv\", \"sn\", \"ee\", \"eo\", \"et\", \"st\", \"jv\", \"ja\", \"kri\""
          nullable: true
      example:
        - language_code: en
          location_code: 2840
          video_id: Y8Wu4rSNJms
    SerpYoutubeVideoSubtitlesLiveAdvancedResultInfo:
      type: object
      properties:
        video_id:
          type: string
          description: ID of the video received in a POST array
          nullable: true
        se_domain:
          type: string
          description: search engine domain in a POST array
          nullable: true
        location_code:
          type: integer
          description: location code in a POST array
          nullable: true
        language_code:
          type: string
          description: language code in a POST array
          nullable: true
        check_url:
          type: string
          description: direct URL to search engine resultsyou can use it to make sure that we provided accurate results
          nullable: true
        datetime:
          type: string
          description: 'date and time when the result was receivedin the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”example:2019-11-15 12:57:46 +00:00'
          nullable: true
        spell:
          type: object
          oneOf:
            - $ref: '#/components/schemas/SpellInfo'
          description: 'autocorrection of the search engineif the search engine provided results for a keyword that was corrected, we will specify the keyword corrected by the search engine and the type of autocorrection'
          nullable: true
        item_types:
          type: array
          items:
            type: string
            nullable: true
          description: types of search results in SERPcontains types of search results (items) found in SERP.possible item:youtube_subtitles
          nullable: true
        unsupported_language:
          type: boolean
          description: indicates whether the language is unsupported by the system
          nullable: true
        translate_language:
          type: string
          description: language code of translated text
          nullable: true
        origin_language:
          type: string
          description: language code of original text
          nullable: true
        category:
          type: string
          description: 'the category the video belongs toNote: this field is deprecated and always returns null'
          nullable: true
        subtitles_count:
          type: integer
          description: number of subtitles in the video
          format: int64
          nullable: true
        title:
          type: string
          description: title of the video
          nullable: true
        items_count:
          type: integer
          description: the number of results returned in the items array
          format: int64
          nullable: true
        items:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/YoutubeSubtitles'
            nullable: true
          description: elements of search results found in SERP
          nullable: true
    SerpYoutubeVideoSubtitlesLiveAdvancedTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpYoutubeVideoSubtitlesLiveAdvancedResultInfo'
                nullable: true
              description: array of results
              nullable: true
    SerpYoutubeVideoSubtitlesLiveAdvancedResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpYoutubeVideoSubtitlesLiveAdvancedTaskInfo'
                nullable: true
              description: array of tasks
              nullable: true
    SerpYoutubeVideoCommentsTaskPostRequestInfo:
      type: object
      properties:
        video_id:
          type: string
          description: "ID of the video\nrequired field\nyou can find video ID in the URL or 'youtube_video' item of YouTube Organic result\nexample:\nvQXvyV0zIP4"
        location_code:
          type: integer
          description: "search engine location code\nrequired field if you don't specify location_name\nif you use this field, you don't need to specify location_name\nyou can receive the list of available locations of the search engines with their location_code by making a separate request to the https://api.dataforseo.com/v3/serp/youtube/locations\nexample:\n2840"
          nullable: true
        language_code:
          type: string
          description: "search engine language code\nrequired field if you don't specify language_name\nif you use this field, you don't need to specify language_name\nyou can receive the list of available languages of the search engine with their language_code by making a separate request to the https://api.dataforseo.com/v3/serp/youtube/languages\nexample:\nen"
          nullable: true
        depth:
          type: integer
          description: "parsing depth\noptional field\nnumber of results in SERP\ndefault value: 20\nmax value: 700\nNote: your account will be billed per each SERP containing up to 20 results;\nthus, setting a depth above 20 may result in additional charges if the search engine returns more than 20 results;\nif the specified depth is higher than the number of results in the response, the difference will be refunded automatically to your account balance"
          nullable: true
        priority:
          type: integer
          description: "task priority\noptional field\ncan take the following values:\n1 – normal execution priority (set by default)\n2 – high execution priority\nYou will be additionally charged for the tasks with high execution priority.\nThe cost can be calculated on the Pricing page."
          nullable: true
        device:
          type: string
          description: "device type\noptional field\nonly value: desktop"
          nullable: true
        pingback_url:
          type: string
          description: "notification URL of a completed task\noptional field\nwhen a task is completed we will notify you by GET request sent to the URL you have specified\nyou can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request.\nexample:\nhttp://your-server.com/pingscript?id=$id\nhttp://your-server.com/pingscript?id=$id&tag=$tag\nNote: special characters in pingback_url will be urlencoded;\ni.a., the # character will be encoded into %23\nlearn more on our Help Center"
          nullable: true
        postback_url:
          type: string
          description: "return URL for sending task results\noptional field\nonce the task is completed, we will send a POST request with its results compressed in the gzip format to the postback_url you specified\nyou can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request.\nexample:\nhttp://your-server.com/postbackscript?id=$id\nhttp://your-server.com/postbackscript?id=$id&tag=$tag\nNote: special characters in postback_url will be urlencoded;\ni.a., the # character will be encoded into %23\nlearn more on our Help Center"
          nullable: true
        postback_data:
          type: string
          description: "postback_url datatype\nrequired field if you specify postback_url\ncorresponds to the datatype that will be sent to your server\npossible value:\nadvanced"
          nullable: true
        location_name:
          type: string
          description: "full name of search engine location\nrequired field if you don't specify location_code\nif you use this field, you don't need to specify location_code\nyou can receive the list of available locations of the search engine with their location_name by making a separate request to the https://api.dataforseo.com/v3/serp/youtube/locations\nexample:\nUnited States"
          nullable: true
        language_name:
          type: string
          description: "full name of search engine language\nrequired field if you don't specify language_code\nif you use this field, you don't need to specify language_code\nyou can receive the list of available languages of the search engine with their language_name by making a separate request to the https://api.dataforseo.com/v3/serp/youtube/languages\nexample:\nEnglish"
          nullable: true
        os:
          type: string
          description: "device operating system\noptional field\nchoose from the following values: windows, macos\ndefault value: windows"
          nullable: true
        tag:
          type: string
          description: "user-defined task identifier\noptional field\nthe character limit is 255\nyou can use this parameter to identify the task and match it with the result\nyou will find the specified tag value in the data object of the response"
          nullable: true
      example:
        - language_code: en
          location_code: 2840
          video_id: vQXvyV0zIP4
    SerpYoutubeVideoCommentsTaskPostTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: object
              description: 'array of resultsin this case, the value will be null'
              nullable: true
    SerpYoutubeVideoCommentsTaskPostResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpYoutubeVideoCommentsTaskPostTaskInfo'
                nullable: true
              description: array of tasks
              nullable: true
    SerpYoutubeVideoCommentsTasksReadyResultInfo:
      type: object
      properties:
        id:
          type: string
          description: <em>task identifier of the completed task</em><br><strong>unique task identifier in our system in the <a href="https://en.wikipedia.org/wiki/Universally_unique_identifier">UUID</a> format</strong>
          nullable: true
        se:
          type: string
          description: <em>search engine specified when setting the task</em>
          nullable: true
        se_type:
          type: string
          description: '<em>type of search engine</em><br>example: <code>{{low_se_type_under}}</code>'
          nullable: true
        date_posted:
          type: string
          description: <em>date when the task was posted (in the UTC format)</em>
          nullable: true
        tag:
          type: string
          description: <em>user-defined task identifier</em>
          nullable: true
        endpoint_regular:
          type: string
          description: '<em>URL for collecting the results of the SERP Regular task</em><br>if SERP Regular is not supported in the specified endpoint, the value will be <code>null</code>'
          nullable: true
        endpoint_advanced:
          type: string
          description: '<em>URL for collecting the results of the SERP Advanced task</em><br>if SERP Advanced is not supported in the specified endpoint, the value will be <code>null</code>'
          nullable: true
        endpoint_html:
          type: string
          description: '<em>URL for collecting the results of the SERP HTML task</em><br>if SERP HTML is not supported in the specified endpoint, the value will be <code>null</code>'
          nullable: true
    SerpYoutubeVideoCommentsTasksReadyTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpYoutubeVideoCommentsTasksReadyResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    SerpYoutubeVideoCommentsTasksReadyResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpYoutubeVideoCommentsTasksReadyTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    SerpYoutubeVideoCommentsTasksFixedResultInfo:
      type: object
      properties:
        id:
          type: string
          description: <em>task identifier of the completed task</em><br><strong>unique task identifier in our system in the <a href="https://en.wikipedia.org/wiki/Universally_unique_identifier">UUID</a> format</strong>
          nullable: true
        se:
          type: string
          description: <em>search engine specified when setting the task</em>
          nullable: true
        se_type:
          type: string
          description: '<em>type of search engine</em><br>can take the following values: <code>{{low_se_type_under}}</code>'
          nullable: true
        date_posted:
          type: string
          nullable: true
        tag:
          type: string
          description: <em>user-defined task identifier</em>
          nullable: true
        endpoint_regular:
          type: string
          description: '<em>URL for collecting the results of the SERP Regular task</em><br>if SERP Regular is not supported in the specified endpoint, the value will be <code>null</code>'
          nullable: true
        endpoint_advanced:
          type: string
          description: '<em>URL for collecting the results of the SERP Advanced task</em><br>if SERP Advanced is not supported in the specified endpoint, the value will be <code>null</code>'
          nullable: true
        endpoint_html:
          type: string
          description: '<em>URL for collecting the results of the SERP HTML task</em><br>if SERP HTML is not supported in the specified endpoint, the value will be <code>null</code>'
          nullable: true
    SerpYoutubeVideoCommentsTasksFixedTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpYoutubeVideoCommentsTasksFixedResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    SerpYoutubeVideoCommentsTasksFixedResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpYoutubeVideoCommentsTasksFixedTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    YoutubeComment:
      type: object
      properties:
        type:
          type: string
          description: type of element
          nullable: true
        rank_group:
          type: integer
          description: <em>group rank in SERP</em><br>position within a group of elements with identical <code>type</code> values<br>positions of elements with different <code>type</code> values are omitted from <code>rank_group</code>
          nullable: true
        rank_absolute:
          type: integer
          description: <em> absolute rank in SERP for the target domain</em><br>absolute position among all the elements in SERP
          nullable: true
        author_name:
          type: string
          description: <em>name of the author of the comment</em>
          nullable: true
        author_thumbnail:
          type: string
          description: <em>the URL of the page where the author's channel logo is hosted</em>
          nullable: true
        author_url:
          type: string
          description: <em>URL of the author's channel</em>
          nullable: true
        text:
          type: string
          description: <em>text of the comment</em>
          nullable: true
        publication_date:
          type: string
          description: <em>displayed publication date</em>
          nullable: true
        timestamp:
          type: string
          description: '<em>date and time when the result was published</em><br>in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”<br>example:<br><code>2022-11-15 12:57:46 +00:00</code>'
          nullable: true
        likes_count:
          type: integer
          description: <em>number of likes on the comment</em>
          format: int64
          nullable: true
        reply_count:
          type: integer
          description: <em>number of replies on the comment</em>
          format: int64
          nullable: true
    SerpYoutubeVideoCommentsTaskGetAdvancedResultInfo:
      type: object
      properties:
        video_id:
          type: string
          description: <em>ID of the video received in a POST array</em>
          nullable: true
        se_domain:
          type: string
          description: <em>search engine domain in a POST array</em>
          nullable: true
        location_code:
          type: integer
          description: <em>location code in a POST array</em>
          nullable: true
        language_code:
          type: string
          description: <em>language code in a POST array</em>
          nullable: true
        check_url:
          type: string
          description: <em>direct URL to search engine results<br></em>you can use it to make sure that we provided accurate results
          nullable: true
        datetime:
          type: string
          description: '<em>date and time when the result was received</em><br>in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”<br>example:<br><code class="long-string">2019-11-15 12:57:46 +00:00</code>'
          nullable: true
        spell:
          type: object
          oneOf:
            - $ref: '#/components/schemas/SpellInfo'
          description: '<em>autocorrection of the search engine</em><br>if the search engine provided results for a keyword that was corrected, we will specify the keyword corrected by the search engine and the type of autocorrection'
          nullable: true
        item_types:
          type: array
          items:
            type: string
            nullable: true
          description: <em>types of search results in SERP</em><br>contains types of search results (<code>items</code>) found in SERP.<br>possible item:<br><code>youtube_comment</code>
          nullable: true
        title:
          type: string
          description: <em>title of the video</em>
          nullable: true
        comments_count:
          type: integer
          description: <em>number of comments on the video</em>
          format: int64
          nullable: true
        items_count:
          type: integer
          description: <em>the number of results returned in the <strong><code>items</code></strong> array</em>
          format: int64
          nullable: true
        items:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/YoutubeComment'
            nullable: true
          description: <em>elements of search results found in SERP</em>
          nullable: true
    SerpYoutubeVideoCommentsTaskGetAdvancedTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpYoutubeVideoCommentsTaskGetAdvancedResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    SerpYoutubeVideoCommentsTaskGetAdvancedResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpYoutubeVideoCommentsTaskGetAdvancedTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    SerpYoutubeVideoCommentsLiveAdvancedRequestInfo:
      type: object
      properties:
        video_id:
          type: string
          description: <em>ID of the video</em><br><strong>required field</strong><br>you can find video ID in the URL or 'youtube_video' item of <a href="/v3/serp/youtube/organic/live/advanced/" rel="noopener noreferrer" target="_blank">YouTube Organic</a> result<br>example:<br><code>vQXvyV0zIP4</code>
        location_name:
          type: string
          description: '<em>full name of search engine location</em><br><strong>required field if you don''t specify</strong> <code>location_code</code><br><strong>if you use this field, you don''t need to specify <code>location_code</code></strong><br>you can receive the list of available locations of the search engine with their <code>location_name</code> by making a separate request to the <code>https://api.dataforseo.com/v3/serp/youtube/locations</code><br>example:<br><code class="long-string">United States</code>'
        location_code:
          type: integer
          description: '<em>search engine location code</em><br><strong>required field if you don''t specify</strong> <code>location_name</code>_<br><strong>if you use this field, you don''t need to specify <code>location_name</code></strong><br>you can receive the list of available locations of the search engines with their <code>location_code</code> by making a separate request to the <code>https://api.dataforseo.com/v3/serp/youtube/locations</code><br>example:<br><code class="long-string">2840</code>n'
        language_name:
          type: string
          description: '<em>full name of search engine language</em><br><strong>required field if you don''t specify</strong> <code>language_code</code><br><strong>if you use this field, you don''t need to specify <code>language_code</code></strong><br>you can receive the list of available languages of the search engine with their <code>language_name</code> by making a separate request to the <code>https://api.dataforseo.com/v3/serp/youtube/languages</code><br>example:<br><code class="long-string">English</code>'
        language_code:
          type: string
          description: '<em>search engine language code</em><br><strong>required field if you don''t specify</strong> <code>language_name</code><br><strong>if you use this field, you don''t need to specify <code>language_name</code></strong><br>you can receive the list of available languages of the search engine with their <code>language_code</code>_by making a separate request to the <code>https://api.dataforseo.com/v3/serp/youtube/languages</code><em><br></em>example:<em><br></em><code class="long-string">en</code>n'
        device:
          type: string
          description: '<em>device type</em><br>optional field<br>only value: <code>desktop</code>'
          nullable: true
        os:
          type: string
          nullable: true
        depth:
          type: integer
          description: '<em>parsing depth</em><br>optional field<br>number of results in SERP<br>default value: <code>20</code><br>max value: <code>200</code><br><strong>Note:</strong> your account will be billed per each SERP containing up to 20 results;<br>thus, setting a depth above <code>20</code> may result in additional charges if the search engine returns more than 20 results;<br>if the specified depth is higher than the number of results in the response, the difference will be refunded automatically to your account balance'
          nullable: true
        tag:
          type: string
          description: <em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response
          nullable: true
      example:
        - language_code: en
          location_code: 2840
          video_id: vQXvyV0zIP4
    SerpYoutubeVideoCommentsLiveAdvancedResultInfo:
      type: object
      properties:
        video_id:
          type: string
          description: <em>ID of the video received in a POST array</em>
          nullable: true
        se_domain:
          type: string
          description: <em>search engine domain in a POST array</em>
          nullable: true
        location_code:
          type: integer
          description: <em>location code in a POST array</em>
          nullable: true
        language_code:
          type: string
          description: <em>language code in a POST array</em>
          nullable: true
        check_url:
          type: string
          description: <em>direct URL to search engine results<br></em>you can use it to make sure that we provided accurate results
          nullable: true
        datetime:
          type: string
          description: '<em>date and time when the result was received</em><br>in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”<br>example:<br><code class="long-string">2019-11-15 12:57:46 +00:00</code>'
          nullable: true
        spell:
          type: object
          oneOf:
            - $ref: '#/components/schemas/SpellInfo'
          description: '<em>autocorrection of the search engine</em><br>if the search engine provided results for a keyword that was corrected, we will specify the keyword corrected by the search engine and the type of autocorrection'
          nullable: true
        item_types:
          type: array
          items:
            type: string
            nullable: true
          description: <em>types of search results in SERP</em><br>contains types of search results (<code>items</code>) found in SERP.<br>possible item:<br><code>youtube_comment</code>
          nullable: true
        title:
          type: string
          description: <em>title of the video</em>
          nullable: true
        comments_count:
          type: integer
          description: <em>number of comments on the video</em>
          format: int64
          nullable: true
        items_count:
          type: integer
          description: <em>the number of results returned in the <strong><code>items</code></strong> array</em>
          format: int64
          nullable: true
        items:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/YoutubeComment'
            nullable: true
          description: <em>elements of search results found in SERP</em>
          nullable: true
    SerpYoutubeVideoCommentsLiveAdvancedTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpYoutubeVideoCommentsLiveAdvancedResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    SerpYoutubeVideoCommentsLiveAdvancedResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpYoutubeVideoCommentsLiveAdvancedTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    SerpYahooLocationsResultInfo:
      type: object
      properties:
        location_code:
          type: integer
          description: <em>location code</em>
          nullable: true
        location_name:
          type: string
          description: <em>full name of the location</em>
          nullable: true
        location_code_parent:
          type: integer
          description: '<em>the code of the superordinate location</em><br>example:<br>`"location_code": 9041134`,<br>`"location_name": "Vienna International Airport,Lower Austria,Austria"`,<br>`"location_code_parent": 20044`<p>where `location_code_parent` corresponds to:<p>`"location_code": 20044`,<br>`"location_name": "Lower Austria,Austria"`'
          nullable: true
        country_iso_code:
          type: string
          description: <em>ISO country code of the location</em>
          nullable: true
        location_type:
          type: string
          description: '<em>location type</em><br>indicates the geographic classification of the location<br>example:<br>`"location_type": "Country"`, or `"location_type": "State"`'
          nullable: true
    SerpYahooLocationsTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpYahooLocationsResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    SerpYahooLocationsResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpYahooLocationsTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    SerpYahooLocationsCountryResultInfo:
      type: object
      properties:
        location_code:
          type: integer
          description: <em>location code</em>
          nullable: true
        location_name:
          type: string
          description: <em>full name of the location</em>
          nullable: true
        location_code_parent:
          type: integer
          description: '<em>the code of the superordinate location</em><br>example:<br>`"location_code": 9041134`,<br>`"location_name": "Vienna International Airport,Lower Austria,Austria"`,<br>`"location_code_parent": 20044`<p>where `location_code_parent` corresponds to:<p>`"location_code": 20044`,<br>`"location_name": "Lower Austria,Austria"`'
          nullable: true
        country_iso_code:
          type: string
          description: <em>ISO country code of the location</em>
          nullable: true
        location_type:
          type: string
          description: '<em>location type</em><br>indicates the geographic classification of the location<br>example:<br>`"location_type": "Country"`, or `"location_type": "State"`'
          nullable: true
    SerpYahooLocationsCountryTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpYahooLocationsCountryResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    SerpYahooLocationsCountryResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpYahooLocationsCountryTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    SerpYahooLanguagesResultInfo:
      type: object
      properties:
        language_name:
          type: string
          description: <em>language name</em>
          nullable: true
        language_code:
          type: string
          description: <em>language code according to <a href="https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes" target="_blank" rel="noopener noreferrer">ISO 639-1</a></em>
          nullable: true
    SerpYahooLanguagesTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpYahooLanguagesResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    SerpYahooLanguagesResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpYahooLanguagesTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    SerpYahooOrganicTaskPostRequestInfo:
      type: object
      properties:
        url:
          type: string
          description: '<em>direct URL of the search query</em><br>optional field<br>you can specify a direct URL and we will sort it out to the necessary fields. Note that this method is the most difficult for our API to process and also requires you to specify the exact language and location in the URL. In most cases, we wouldn’t recommend using this method.<br>example:<br><code class="long-string">https://search.yahoo.com/search?p=rank+checker&amp;n=100&amp;vl=lang_en&amp;vc=us&amp;ei=UTF-8</code>'
          nullable: true
        keyword:
          type: string
          description: '<em>keyword</em><br><strong>required field</strong><br>you can specify <strong>up to 700 characters</strong> in the <code>keyword</code> field<br><strong>all %## will be decoded (plus character ''+'' will be decoded to a space character)</strong><br>if you need to use the "%" character for your <code>keyword</code>, please specify it as "%25";<br>if you need to use the “+” character for your <code>keyword</code>, please specify it as “%2B”<p>learn more about rules and limitations of <code>keyword</code> and <code>keywords</code> fields in DataForSEO APIs in this <a href="https://dataforseo.com/help-center/rules-and-limitations-of-keyword-and-keywords-fields-in-dataforseo-apis" rel="noopener noreferrer" target="_blank">Help Center article</a>'
        priority:
          type: integer
          description: <em>task priority</em><br>optional field<br>can take the following values:<br>1 – normal execution priority (set by default)<br>2 – high execution priorityYou will be additionally charged for the tasks with high execution priority.<br>The cost can be calculated on the <a title="Pricing" href="https://dataforseo.com/pricing/serp/yahoo-serp-api" target="_blank" rel="noopener noreferrer">Pricing</a> page.
          nullable: true
        location_name:
          type: string
          description: '<em>full name of search engine location</em><br><strong>required field if you don''t specify</strong> <code>location_code</code> or <code>location_coordinate</code><br><strong>if you use this field, you don''t need to specify <code>location_code</code> or <code>location_coordinate</code></strong><br>you can receive the list of available locations of the search engine with their <code>location_name</code> by making a separate request to the <code>https://api.dataforseo.com/v3/serp/{{low_se_name}}/locations</code><br>example:<br><code class="long-string">London,England,United Kingdom</code>'
        location_code:
          type: integer
          description: '<em>search engine location code</em><br><strong>required field if you don''t specify</strong> <code>location_name</code>_or <code>location_coordinate</code><br><strong>if you use this field, you don''t need to specify <code>location_name</code> or <code>location_coordinate</code></strong><br>you can receive the list of available locations of the search engines with their <code>location_code</code> by making a separate request to the <code>https://api.dataforseo.com/v3/serp/{{low_se_name}}/locations</code><br>example:<br><code class="long-string">2840</code>n'
        location_coordinate:
          type: string
          description: '<em>GPS coordinates of a location</em><br><strong>required field if you don''t specify</strong> <code>location_name</code>_or <code>location_code</code><br><strong>if you use this field, you don''t need to specify <code>location_name</code> or <code>location_code</code></strong><br><code>location_coordinate</code> parameter should be specified in the <em>"latitude,longitude,radius"</em> format<br>the maximum number of decimal digits for <em>"latitude"</em> and <em>"longitude"</em>: 7<br>the minimum value for <em>"radius"</em>: 199.9 (mm)<br>the maximum value for <em>"radius"</em>: 199999 (mm)<br>example:<br><code class="long-string">53.476225,-2.243572,200</code>n'
        language_name:
          type: string
          description: '<em>full name of search engine language</em><br><strong>required field if you don''t specify</strong> <code>language_code</code><br><strong>if you use this field, you don''t need to specify <code>language_code</code></strong><br>you can receive the list of available languages of the search engine with their <code>language_name</code> by making a separate request to the <code>https://api.dataforseo.com/v3/serp/{{low_se_name}}/languages</code><br>example:<br><code class="long-string">English</code>'
        language_code:
          type: string
          description: '<em>search engine language code</em><br><strong>required field if you don''t specify</strong> <code>language_name</code><br><strong>if you use this field, you don''t need to specify <code>language_name</code></strong><br>you can receive the list of available languages of the search engine with their <code>language_code</code>_by making a separate request to the <code>https://api.dataforseo.com/v3/serp/{{low_se_name}}/languages</code><em><br></em>example:<em><br></em><code class="long-string">en</code>n'
        device:
          type: string
          description: '<em>device type</em><br>optional field<br>return results for a specific device type<br>can take the values:<code>desktop</code>, <code>mobile</code><br>default value: <code>desktop</code>'
          nullable: true
        os:
          type: string
          description: '<em>device operating system</em><br>optional field<br>if you specify <code>desktop</code> in the <code>device</code> field, choose from the following values: <code>windows</code>, <code>macos</code><br>default value: <code>windows</code><br>if you specify <code>mobile</code> in the <code>device</code> field, choose from the following values: <code>android</code>, <code>ios</code><br>default value: <code>android</code>'
          nullable: true
        se_domain:
          type: string
          description: '<em>search engine domain</em><br>optional field<br>we choose the relevant search engine domain automatically according to the location and language you specify<br>however, you can set a custom search engine domain in this field<br>example:<br><code>au.search.yahoo.com</code>, <code>uk.search.yahoo.com</code>, <code>ca.search.yahoo.com</code>, etc.'
          nullable: true
        depth:
          type: integer
          description: '<em>parsing depth</em><br>optional field<br>number of results in SERP<br>default value: <code>6</code><br>max value: <code>700</code><br><strong>Your account will be billed per each SERP;</strong> <br>Each Yahoo SERP can contain fewer than 10 results, so setting depth above the default value may result in additional charges <a href="https://dataforseo.com/help-center/how-many-results-scraped" rel="noopener noreferrer" target="_blank"></a>;<br>The cost can be calculated on the <a title="Pricing" href="https://dataforseo.com/pricing/serp/yahoo-serp-api" target="_blank" rel="noopener noreferrer">Pricing</a> page.'
          nullable: true
        max_crawl_pages:
          type: integer
          description: '<em>page crawl limit</em><br>optional field<br>number of search results pages to crawl<br>default value: <code>1</code><br>max value: <code>100</code><br><strong>Note:</strong> the <code>max_crawl_pages</code> and <code>depth</code> parameters complement each other;<br>learn more at <a href="https://dataforseo.com/help-center/what-is-max-crawl-pages-and-how-does-it-work" target="_blank" rel="noopener noreferrer">our help center</a>'
          nullable: true
        search_param:
          type: string
          description: <em>additional parameters of the search query</em><br>optional field<br><a href="https://dataforseo.com/help-center/yahoo-search-engine-parameters-and-how-to-use-them">get the list of available parameters and additional details here</a>
          nullable: true
        stop_crawl_on_match:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/SerpApiStopCrawlOnMatchInfo'
            nullable: true
          description: "array of targets to stop crawling\noptional field\nif specified, the response will contain SERP results up to and including the specified match_value;\nyou can specify up to 10 target values in this array\nexample:\n\"stop_crawl_on_match\":[{\"match_value\":\"dataforseo.com\",\"match_type\":\"with_subdomains\"}]\nlearn more about this parameter on our Help Center - https://dataforseo.com/help-center/using-the-stop_crawl_on_match-parameter-in-serp-api\nYour account will be billed per each SERP crawled through the specified targets"
          nullable: true
        tag:
          type: string
          description: <em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response
          nullable: true
        postback_url:
          type: string
          description: '<em>URL for sending task results</em><br>optional field<br>once the task is completed, we will send a POST request with its results compressed in the <code>gzip</code> format to the <code>postback_url</code> you specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/postbackscript?id=$id</code><br><code>http://your-server.com/postbackscript?id=$id&amp;tag=$tag</code><br><strong>Note:</strong> special characters in <code>postback_url</code> will be urlencoded;<br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href="https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api" target="_blank" rel="noopener noreferrer">Help Center</a>'
          nullable: true
        postback_data:
          type: string
          description: '<em>postback_url datatype</em><br><strong>required field if you specify <code>postback_url</code></strong><br>corresponds to the datatype that will be sent to your server<br>possible values:<br><code>regular</code>, <code>html</code>'
        pingback_url:
          type: string
          description: '<em>notification URL of a completed task</em><br>optional field<br>when a task is completed we will notify you by GET request sent to the URL you have specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/pingscript?id=$id</code><br><code>http://your-server.com/pingscript?id=$id&amp;tag=$tag</code><br><strong>Note:</strong> special characters in <code>pingback_url</code> will be urlencoded;<br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href="https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api" target="_blank" rel="noopener noreferrer">Help Center</a>'
          nullable: true
      example:
        - language_code: en
          location_code: 2840
          keyword: albert einstein
    SerpYahooOrganicTaskPostTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: object
              description: '<em>array of results</em><br>in this case, the value will be <code>null</code>'
              nullable: true
    SerpYahooOrganicTaskPostResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpYahooOrganicTaskPostTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    SerpYahooOrganicTasksReadyResultInfo:
      type: object
      properties:
        id:
          type: string
          description: <em>task identifier of the completed task</em><br><strong>unique task identifier in our system in the <a href="https://en.wikipedia.org/wiki/Universally_unique_identifier">UUID</a> format</strong>
          nullable: true
        se:
          type: string
          description: <em>search engine specified when setting the task</em>
          nullable: true
        se_type:
          type: string
          description: '<em>type of search engine</em><br>example: <code>{{low_se_type_under}}</code>'
          nullable: true
        date_posted:
          type: string
          description: <em>date when the task was posted (in the UTC format)</em>
          nullable: true
        tag:
          type: string
          description: <em>user-defined task identifier</em>
          nullable: true
        endpoint_regular:
          type: string
          description: '<em>URL for collecting the results of the SERP Regular task</em><br>if SERP Regular is not supported in the specified endpoint, the value will be <code>null</code>'
          nullable: true
        endpoint_advanced:
          type: string
          description: '<em>URL for collecting the results of the SERP Advanced task</em><br>if SERP Advanced is not supported in the specified endpoint, the value will be <code>null</code>'
          nullable: true
        endpoint_html:
          type: string
          description: '<em>URL for collecting the results of the SERP HTML task</em><br>if SERP HTML is not supported in the specified endpoint, the value will be <code>null</code>'
          nullable: true
    SerpYahooOrganicTasksReadyTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpYahooOrganicTasksReadyResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    SerpYahooOrganicTasksReadyResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpYahooOrganicTasksReadyTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    SerpYahooOrganicTasksFixedResultInfo:
      type: object
      properties:
        id:
          type: string
          description: <em>task identifier of the completed task</em><br><strong>unique task identifier in our system in the <a href="https://en.wikipedia.org/wiki/Universally_unique_identifier">UUID</a> format</strong>
          nullable: true
        se:
          type: string
          description: <em>search engine specified when setting the task</em>
          nullable: true
        se_type:
          type: string
          description: '<em>type of search engine</em><br>can take the following values: <code>{{low_se_type_under}}</code>'
          nullable: true
        date_posted:
          type: string
          nullable: true
        tag:
          type: string
          description: <em>user-defined task identifier</em>
          nullable: true
        endpoint_regular:
          type: string
          description: '<em>URL for collecting the results of the SERP Regular task</em><br>if SERP Regular is not supported in the specified endpoint, the value will be <code>null</code>'
          nullable: true
        endpoint_advanced:
          type: string
          description: '<em>URL for collecting the results of the SERP Advanced task</em><br>if SERP Advanced is not supported in the specified endpoint, the value will be <code>null</code>'
          nullable: true
        endpoint_html:
          type: string
          description: '<em>URL for collecting the results of the SERP HTML task</em><br>if SERP HTML is not supported in the specified endpoint, the value will be <code>null</code>'
          nullable: true
    SerpYahooOrganicTasksFixedTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpYahooOrganicTasksFixedResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    SerpYahooOrganicTasksFixedResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpYahooOrganicTasksFixedTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    SerpYahooOrganicTaskGetRegularResultInfo:
      type: object
      properties:
        keyword:
          type: string
          description: <em>keyword received in a POST array</em><br><strong>keyword is returned with decoded %## (plus symbol '+' will be decoded to a space character)</strong>
          nullable: true
        type:
          type: string
          description: type of element
          nullable: true
        se_domain:
          type: string
          description: <em>search engine domain in a POST array</em>
          nullable: true
        location_code:
          type: integer
          description: <em>location code in a POST array</em>
          nullable: true
        language_code:
          type: string
          description: <em>language code in a POST array</em>
          nullable: true
        check_url:
          type: string
          description: <em>direct URL to search engine results</em><br>you can use it to make sure that we provided accurate results
          nullable: true
        datetime:
          type: string
          description: '<em>date and time when the result was received</em><br>in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”<br>example:<br><code class="long-string">2019-11-15 12:57:46 +00:00</code>'
          nullable: true
        spell:
          type: object
          oneOf:
            - $ref: '#/components/schemas/SpellInfo'
          description: '<em>autocorrection of the search engine</em><br>if the search engine provided results for a keyword that was corrected, we will specify the keyword corrected by the search engine and the type of autocorrection'
          nullable: true
        refinement_chips:
          type: object
          oneOf:
            - $ref: '#/components/schemas/RefinementChipsInfo'
          description: <em>search refinement chips</em><br>equals <code>null</code>
          nullable: true
        item_types:
          type: array
          items:
            type: string
            nullable: true
          description: '<em>types of search results found in SERP</em><br>contains types of all search results (<code>items</code>) found in the returned SERP<br>possible item types:<br><code>featured_snippet</code>, <code>images</code>, <code>local_pack</code>, <code>hotels_pack</code>, <code>organic</code>, <code>paid</code>, <code>people_also_ask</code>, <code>related_searches</code>, <code>shopping</code>, <code>recipes</code>, <code>top_stories</code>, <code>video</code>, <code>ai_overview</code>;<br><strong>note</strong> that this array contains all types of search results found in the returned SERP;<br>however, this endpoint provides data for <code>organic</code>, <code>paid</code>, and <code>featured_snippet</code> types only;<br>to get all items (including SERP features and rich snippets) found in the returned SERP, please refer to the <a href="/v3/serp/yahoo/organic/task_get/advanced/?bash" rel="noopener noreferrer" target="_blank">Yahoo Organiс Advanced SERP endpoint</a>'
          nullable: true
        se_results_count:
          type: integer
          description: <em>total number of results in SERP</em>
          format: int64
          nullable: true
        pages_count:
          type: integer
          description: <em>total pages retrieved</em><br>total number of retrieved SERPs in the result
          format: int64
          nullable: true
        items_count:
          type: integer
          description: <em>the number of results returned in the <strong><code>items</code></strong> array</em>
          format: int64
          nullable: true
        items:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/BaseSerpApiElementItem'
            nullable: true
          description: <em>items in SERP</em>
          nullable: true
    SerpYahooOrganicTaskGetRegularTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpYahooOrganicTaskGetRegularResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    SerpYahooOrganicTaskGetRegularResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpYahooOrganicTaskGetRegularTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    SerpYahooOrganicTaskGetAdvancedResultInfo:
      type: object
      properties:
        keyword:
          type: string
          description: <em>keyword received in a POST array<br></em><strong>the keyword is returned with decoded %## (plus symbol '+' will be decoded to a space character)</strong>
          nullable: true
        type:
          type: string
          description: type of element
          nullable: true
        se_domain:
          type: string
          description: <em>search engine domain in a POST array</em>
          nullable: true
        location_code:
          type: integer
          description: <em>location code in a POST array</em>
          nullable: true
        language_code:
          type: string
          description: <em>language code in a POST array</em>
          nullable: true
        check_url:
          type: string
          description: <em>direct URL to search engine results</em><br>you can use it to make sure that we provided accurate results
          nullable: true
        datetime:
          type: string
          description: '<em>date and time when the result was received</em><br>in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”<br>example:<br><code class="long-string">2019-11-15 12:57:46 +00:00</code>'
          nullable: true
        spell:
          type: object
          oneOf:
            - $ref: '#/components/schemas/SpellInfo'
          description: '<em>autocorrection of the search engine</em><br>if the search engine provided results for a keyword that was corrected, we will specify the keyword corrected by the search engine and the type of autocorrection'
          nullable: true
        refinement_chips:
          type: object
          oneOf:
            - $ref: '#/components/schemas/RefinementChipsInfo'
          description: <em>search refinement chips</em><br>equals <code>null</code>
          nullable: true
        item_types:
          type: array
          items:
            type: string
            nullable: true
          description: '<em>types of search results in SERP</em><br>contains types of search results (<code>items</code>) found in SERP.<br>possible item types:<br><span><a href="#featured_snippet"><code>featured_snippet</code></a>, <a href="#images"><code>images</code></a>, <a href="#local_pack"><code>local_pack</code></a>, <a href="#hotels_pack"><code>hotels_pack</code></a>, <a href="#organic"><code>organic</code></a>, <a href="#paid"><code>paid</code></a>, <a href="#people_also_ask"><code>people_also_ask</code></a>, <a href="#related_searches"><code>related_searches</code></a>, <a href="#shopping"><code>shopping</code></a>, <a href="#recipes"><code>recipes</code></a>, <a href="#top_stories"><code>top_stories</code></a>, <a href="#video"><code>video</code></a></span>, <a href="#ai_overview"><code>ai_overview</code></a></span>'
          nullable: true
        se_results_count:
          type: integer
          description: <em> total number of results in SERP</em>
          format: int64
          nullable: true
        pages_count:
          type: integer
          description: <em>total pages retrieved</em><br>total number of retrieved SERPs in the result
          format: int64
          nullable: true
        items_count:
          type: integer
          description: <em>the number of results returned in the <strong><code>items</code></strong> array</em>
          format: int64
          nullable: true
        items:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/BaseSerpApiElementItem'
            nullable: true
          description: '<em>additional items present in the element</em><br>if there are none, equals <code>null</code>'
          nullable: true
    SerpYahooOrganicTaskGetAdvancedTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpYahooOrganicTaskGetAdvancedResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    SerpYahooOrganicTaskGetAdvancedResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpYahooOrganicTaskGetAdvancedTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    SerpYahooOrganicTaskGetHtmlResultInfo:
      type: object
      properties:
        keyword:
          type: string
          description: <em>keyword received in a POST array<br></em><strong>keyword is returned with decoded %## (plus symbol '+' will be decoded to a space character)</strong>
          nullable: true
        type:
          type: string
          description: type of element
          nullable: true
        se_domain:
          type: string
          description: <em>search engine domain in a POST array</em>
          nullable: true
        location_code:
          type: integer
          description: <em>location code in a POST array</em>
          nullable: true
        language_code:
          type: string
          description: <em>language code in a POST array</em>
          nullable: true
        datetime:
          type: string
          description: '<em>date and time when the result was received</em><br>in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”<br>example:<br><code class="long-string">2019-11-15 12:57:46 +00:00</code>'
          nullable: true
        items_count:
          type: integer
          description: <em>the number of results returned in the <strong><code>items</code></strong> array</em>
          format: int64
          nullable: true
        items:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/HtmlItemInfo'
            nullable: true
          description: <em>elements of search results found in SERP</em>
          nullable: true
    SerpYahooOrganicTaskGetHtmlTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpYahooOrganicTaskGetHtmlResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    SerpYahooOrganicTaskGetHtmlResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpYahooOrganicTaskGetHtmlTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    SerpYahooOrganicLiveRegularRequestInfo:
      type: object
      properties:
        url:
          type: string
          description: '<em>direct URL of the search query</em><br>optional field<br>you can specify a direct URL and we will sort it out to the necessary fields. Note that this method is the most difficult for our API to process and also requires you to specify the exact language and location in the URL. In most cases, we wouldn’t recommend using this method.<br>example:<br><code class="long-string">https://search.yahoo.com/search?p=rank+checker&amp;n=100&amp;vl=lang_en&amp;vc=us&amp;ei=UTF-8</code>'
          nullable: true
        keyword:
          type: string
          description: '<em>keyword</em><br><strong>required field</strong><br>you can specify <strong>up to 700 characters</strong> in the <code>keyword</code> field<br><strong>all %## will be decoded (plus character ''+'' will be decoded to a space character)</strong><br>if you need to use the "%" character for your <code>keyword</code>, please specify it as "%25";<br>if you need to use the “+” character for your <code>keyword</code>, please specify it as “%2B”<p>learn more about rules and limitations of <code>keyword</code> and <code>keywords</code> fields in DataForSEO APIs in this <a href="https://dataforseo.com/help-center/rules-and-limitations-of-keyword-and-keywords-fields-in-dataforseo-apis" rel="noopener noreferrer" target="_blank">Help Center article</a>'
        location_name:
          type: string
          description: '<em>full name of search engine location</em><br><strong>required field if you don''t specify</strong> <code>location_code</code> or <code>location_coordinate</code><br><strong>if you use this field, you don''t need to specify <code>location_code</code> or <code>location_coordinate</code></strong><br>you can receive the list of available locations of the search engine with their <code>location_name</code> by making a separate request to the <code>https://api.dataforseo.com/v3/serp/{{low_se_name}}/locations</code><br>example:<br><code class="long-string">London,England,United Kingdom</code>'
        location_code:
          type: integer
          description: '<em>search engine location code</em><br><strong>required field if you don''t specify</strong> <code>location_name</code>_or <code>location_coordinate</code><br><strong>if you use this field, you don''t need to specify <code>location_name</code> or <code>location_coordinate</code></strong><br>you can receive the list of available locations of the search engines with their <code>location_code</code> by making a separate request to the <code>https://api.dataforseo.com/v3/serp/{{low_se_name}}/locations</code><br>example:<br><code class="long-string">2840</code>n'
        location_coordinate:
          type: string
          description: '<em>GPS coordinates of a location</em><br><strong>required field if you don''t specify</strong> <code>location_name</code>_or <code>location_code</code><br><strong>if you use this field, you don''t need to specify <code>location_name</code> or <code>location_code</code></strong><br><code>location_coordinate</code> parameter should be specified in the <em>"latitude,longitude,radius"</em> format<br>the maximum number of decimal digits for <em>"latitude"</em> and <em>"longitude"</em>: 7<br>the minimum value for <em>"radius"</em>: 199.9 (mm)<br>the maximum value for <em>"radius"</em>: 199999 (mm)<br>example:<br><code class="long-string">53.476225,-2.243572,200</code>n'
        language_name:
          type: string
          description: '<em>full name of search engine language</em><br><strong>required field if you don''t specify</strong> <code>language_code</code><br><strong>if you use this field, you don''t need to specify <code>language_code</code></strong><br>you can receive the list of available languages of the search engine with their <code>language_name</code> by making a separate request to the <code>https://api.dataforseo.com/v3/serp/{{low_se_name}}/languages</code><br>example:<br><code class="long-string">English</code>'
        language_code:
          type: string
          description: '<em>search engine language code</em><br><strong>required field if you don''t specify</strong> <code>language_name</code><br><strong>if you use this field, you don''t need to specify <code>language_name</code></strong><br>you can receive the list of available languages of the search engine with their <code>language_code</code>_by making a separate request to the <code>https://api.dataforseo.com/v3/serp/{{low_se_name}}/languages</code><em><br></em>example:<br><code class="long-string">en</code>n'
        device:
          type: string
          description: '<em>device type</em><br>optional field<br>can take the values:<code>desktop</code>, <code>mobile</code><br>default value: <code>desktop</code>'
          nullable: true
        os:
          type: string
          description: '<em>device operating system</em><br>optional field<br>if you specify <code>desktop</code> in the <code>device</code> field, choose from the following values: <code>windows</code>, <code>macos</code><br>default value: <code>windows</code><br>if you specify <code>mobile</code> in the <code>device</code> field, choose from the following values: <code>android</code>, <code>ios</code><br>default value: <code>android</code>'
          nullable: true
        se_domain:
          type: string
          description: '<em>search engine domain</em><br>optional field<br>we choose the relevant search engine domain automatically according to the location and language you specify<br>however, you can set a custom search engine domain in this field<br>example:<br><code>au.search.yahoo.com</code>, <code>uk.search.yahoo.com</code>, <code>ca.search.yahoo.com</code>, etc.'
          nullable: true
        depth:
          type: integer
          description: '<em>parsing depth</em><br>optional field<br>number of results in SERP<br>default value: <code>6</code><br>max value: <code>200</code><br><strong>Your account will be billed per each SERP;</strong> <br>Each Yahoo SERP can contain fewer than 10 results, so setting depth above the default value may result in additional charges <a href="https://dataforseo.com/help-center/how-many-results-scraped" rel="noopener noreferrer" target="_blank"></a>;<br>The cost can be calculated on the <a title="Pricing" href="https://dataforseo.com/pricing/serp/yahoo-serp-api" target="_blank" rel="noopener noreferrer">Pricing</a> page.'
          nullable: true
        max_crawl_pages:
          type: integer
          description: '<em>page crawl limit</em><br>optional field<br>number of search results pages to crawl<br>default value: <code>1</code><br>max value: <code>100</code><br><strong>Note:</strong> the <code>max_crawl_pages</code> and <code>depth</code> parameters complement each other;<br>learn more at <a href="https://dataforseo.com/help-center/what-is-max-crawl-pages-and-how-does-it-work" rel="noopener noreferrer" target="_blank">our help center</a>'
          nullable: true
        target:
          type: string
          description: '<em>target domain, subdomain, or webpage to get results for</em><br>optional field<br>a domain or a subdomain should be specified without <code>https://</code> and <code>www.</code><br>note that the results of <code>target</code>-specific tasks will only include SERP elements that contain a <code>url</code> string;<br>you can also use a wildcard (‘*’) character to specify the search pattern in SERP and narrow down the results;<br>examples:<br><strong><code class="long-string">example.com</code></strong>  - returns results for the website''s home page with URLs, such as <code class="long-string">https://example.com</code>, or <code class="long-string">https://www.example.com/</code>, or <code class="long-string">https://example.com/</code>;<br><strong><code class="long-string">example.com*</code></strong> - returns results for the domain, including all its pages;<br><strong><code class="long-string">*example.com*</code></strong> - returns results for the entire domain, including all its pages and subdomains;<br><strong><code class="long-string">*example.com</code></strong>  - returns results for the home page regardless of the subdomain, such as <code class="long-string">https://en.example.com</code>; <br><strong><code class="long-string">example.com/example-page</code></strong>  - returns results for the exact URL;<br><strong><code class="long-string">example.com/example-page*</code></strong>  - returns results for all domain''s URLs that start with the specified string'
          nullable: true
        search_param:
          type: string
          description: <em>additional parameters of the search query</em><br>optional field<br><a href="https://dataforseo.com/what-are-google-search-parameters-and-how-to-use-them-with-serp-api.html">get the list of available parameters and additional details here</a>
          nullable: true
        stop_crawl_on_match:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/SerpApiStopCrawlOnMatchInfo'
            nullable: true
          description: "array of targets to stop crawling\noptional field\nif specified, the response will contain SERP results up to and including the specified match_value;\nyou can specify up to 10 target values in this array\nexample:\n\"stop_crawl_on_match\":[{\"match_value\":\"dataforseo.com\",\"match_type\":\"with_subdomains\"}]\nlearn more about this parameter on our Help Center - https://dataforseo.com/help-center/using-the-stop_crawl_on_match-parameter-in-serp-api\nYour account will be billed per each SERP crawled through the specified targets"
          nullable: true
        tag:
          type: string
          description: <em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response
          nullable: true
      example:
        - language_code: en
          location_code: 2840
          keyword: albert einstein
    SerpYahooOrganicLiveRegularResultInfo:
      type: object
      properties:
        keyword:
          type: string
          description: <em>keyword received in a POST array</em><br><strong>keyword is returned with decoded %## (plus character '+' will be decoded to a space character)</strong>
          nullable: true
        type:
          type: string
          description: type of element
          nullable: true
        se_domain:
          type: string
          description: <em>search engine domain in a POST array</em>
          nullable: true
        location_code:
          type: integer
          description: <em>location code in a POST array</em>
          nullable: true
        language_code:
          type: string
          description: <em>language code in a POST array</em>
          nullable: true
        check_url:
          type: string
          description: <em>direct URL to search engine results<br></em>You can use it to make sure that we provided exact results
          nullable: true
        datetime:
          type: string
          description: '<em>date and time when the result was received</em><br>in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”<br>example:<br><code class="long-string">2019-11-15 12:57:46 +00:00</code>'
          nullable: true
        spell:
          type: object
          oneOf:
            - $ref: '#/components/schemas/SpellInfo'
          description: '<em>autocorrection of the search engine</em><br>if the search engine provided results for a keyword that was corrected, we will specify the keyword corrected by the search engine and the type of autocorrection'
          nullable: true
        refinement_chips:
          type: object
          oneOf:
            - $ref: '#/components/schemas/RefinementChipsInfo'
          description: <em>search refinement chips</em><br>equals <code>null</code>
          nullable: true
        item_types:
          type: array
          items:
            type: string
            nullable: true
          description: '<em>types of search results found in SERP</em><br>contains types of all search results (<code>items</code>) found in the returned SERP<br>possible item types:<br><code>featured_snippet</code>, <code>images</code>, <code>local_pack</code>, <code>hotels_pack</code>, <code>organic</code>, <code>paid</code>, <code>people_also_ask</code>, <code>related_searches</code>, <code>shopping</code>, <code>recipes</code>, <code>top_stories</code>, <code>video</code>, <code>ai_overview</code>;<br><strong>note</strong> that this array contains all types of search results found in the returned SERP;<br>however, this endpoint provides data for <code>organic</code>, <code>paid</code>, and <code>featured_snippet</code> types only;<br>to get all items (including SERP features and rich snippets) found in the returned SERP, please refer to the <a href="/v3/serp/yahoo/organic/task_get/advanced/?bash" rel="noopener noreferrer" target="_blank">Yahoo Organiс Advanced SERP endpoint</a>'
          nullable: true
        se_results_count:
          type: integer
          description: <em>total number of results in SERP</em>
          format: int64
          nullable: true
        pages_count:
          type: integer
          description: <em>total pages retrieved</em><br>total number of retrieved SERPs in the result
          format: int64
          nullable: true
        items_count:
          type: integer
          description: <em>the number of results returned in the <strong><code>items</code></strong> array</em>
          format: int64
          nullable: true
        items:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/BaseSerpApiElementItem'
            nullable: true
          description: <em>items in SERP</em>
          nullable: true
    SerpYahooOrganicLiveRegularTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpYahooOrganicLiveRegularResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    SerpYahooOrganicLiveRegularResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpYahooOrganicLiveRegularTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    SerpYahooOrganicLiveAdvancedRequestInfo:
      type: object
      properties:
        url:
          type: string
          description: '<em>direct URL of the search query</em><br>optional field<br>you can specify a direct URL and we will sort it out to the necessary fields. Note that this method is the most difficult for our API to process and also requires you to specify the exact language and location in the URL. In most cases, we wouldn’t recommend using this method.<br>example:<br><code class="long-string">https://search.yahoo.com/search?p=rank+checker&amp;n=100&amp;vl=lang_en&amp;vc=us&amp;ei=UTF-8</code>'
          nullable: true
        keyword:
          type: string
          description: '<em>keyword</em><br><strong>required field</strong><br>you can specify <strong>up to 700 characters</strong> in the <code>keyword</code> field<br><strong>all %## will be decoded (plus character ''+'' will be decoded to a space character)</strong><br>if you need to use the "%" character for your <code>keyword</code>, please specify it as "%25";<br>if you need to use the “+” character for your <code>keyword</code>, please specify it as “%2B”<p>learn more about rules and limitations of <code>keyword</code> and <code>keywords</code> fields in DataForSEO APIs in this <a href="https://dataforseo.com/help-center/rules-and-limitations-of-keyword-and-keywords-fields-in-dataforseo-apis" rel="noopener noreferrer" target="_blank">Help Center article</a>'
        location_name:
          type: string
          description: '<em>full name of search engine location</em><br><strong>required field if you don''t specify</strong> <code>location_code</code> or <code>location_coordinate</code><br><strong>if you use this field, you don''t need to specify <code>location_code</code> or <code>location_coordinate</code></strong><br>you can receive the list of available locations of the search engine with their <code>location_name</code> by making a separate request to the <code>https://api.dataforseo.com/v3/serp/{{low_se_name}}/locations</code><br>example:<br><code class="long-string">London,England,United Kingdom</code>'
        location_code:
          type: integer
          description: '<em>search engine location code</em><br><strong>required field if you don''t specify</strong> <code>location_name</code>_or <code>location_coordinate</code><br><strong>if you use this field, you don''t need to specify <code>location_name</code> or <code>location_coordinate</code></strong><br>you can receive the list of available locations of the search engines with their <code>location_code</code> by making a separate request to the <code>https://api.dataforseo.com/v3/serp/{{low_se_name}}/locations</code><br>example:<br><code class="long-string">2840</code>n'
        location_coordinate:
          type: string
          description: '<em>GPS coordinates of a location</em><br><strong>required field if you don''t specify</strong> <code>location_name</code>_or <code>location_code</code><br><strong>if you use this field, you don''t need to specify <code>location_name</code> or <code>location_code</code></strong><br><code>location_coordinate</code> parameter should be specified in the <em>"latitude,longitude,radius"</em> format<br>the maximum number of decimal digits for <em>"latitude"</em> and <em>"longitude"</em>: 7<br>the minimum value for <em>"radius"</em>: 199.9 (mm)<br>the maximum value for <em>"radius"</em>: 199999 (mm)<br>example:<br><code class="long-string">53.476225,-2.243572,200</code>n'
        language_name:
          type: string
          description: '<em>full name of search engine language</em><br><strong>required field if you don''t specify</strong> <code>language_code</code><br><strong>if you use this field, you don''t need to specify <code>language_code</code></strong><br>you can receive the list of available languages of the search engine with their <code>language_name</code> by making a separate request to the <code>https://api.dataforseo.com/v3/serp/{{low_se_name}}/languages</code><br>example:<br><code class="long-string">English</code>'
        language_code:
          type: string
          description: '<em>search engine language code</em><br><strong>required field if you don''t specify</strong> <code>language_name</code><br><strong>if you use this field, you don''t need to specify <code>language_name</code></strong><br>you can receive the list of available languages of the search engine with their <code>language_code</code>_by making a separate request to the <code>https://api.dataforseo.com/v3/serp/{{low_se_name}}/languages</code><em><br></em>example:<em><br></em><code class="long-string">en</code>n'
        device:
          type: string
          description: '<em>device type</em><br>optional field<br>return results for a specific device type<br>can take the values:<code>desktop</code>, <code>mobile</code><br>default value: <code>desktop</code>'
          nullable: true
        os:
          type: string
          description: '<em>device operating system</em><br>optional field<br>if you specify <code>desktop</code> in the <code>device</code> field, choose from the following values: <code>windows</code>, <code>macos</code><br>default value: <code>windows</code><br>if you specify <code>mobile</code> in the <code>device</code> field, choose from the following values: <code>android</code>, <code>ios</code><br>default value: <code>android</code>'
          nullable: true
        se_domain:
          type: string
          description: '<em>search engine domain</em><br>optional field<br>we choose the relevant search engine domain automatically according to the location and language you specify<br>however, you can set a custom search engine domain in this field<br>example:<br><code>au.search.yahoo.com</code>, <code>uk.search.yahoo.com</code>, <code>ca.search.yahoo.com</code>, etc.'
          nullable: true
        depth:
          type: integer
          description: '<em>parsing depth</em><br>optional field<br>number of results in SERP<br>default value: <code>6</code><br>max value: <code>200</code><br><strong>Your account will be billed per each SERP;</strong> <br>Each Yahoo SERP can contain fewer than 10 results, so setting depth above the default value may result in additional charges <a href="https://dataforseo.com/help-center/how-many-results-scraped" rel="noopener noreferrer" target="_blank"></a>;<br>The cost can be calculated on the <a title="Pricing" href="https://dataforseo.com/pricing/serp/yahoo-serp-api" target="_blank" rel="noopener noreferrer">Pricing</a> page.'
          nullable: true
        max_crawl_pages:
          type: integer
          description: '<em>page crawl limit</em><br>optional field<br>number of search results pages to crawl<br>default value: <code>1</code><br>max value: <code>100</code><br><strong>Note:</strong> the <code>max_crawl_pages</code> and <code>depth</code> parameters complement each other;<br>learn more at <a href="https://dataforseo.com/help-center/what-is-max-crawl-pages-and-how-does-it-work" rel="noopener noreferrer" target="_blank">our help center</a>'
          nullable: true
        target:
          type: string
          description: '<em>target domain, subdomain, or webpage to get results for</em><br>optional field<br>a domain or a subdomain should be specified without <code>https://</code> and <code>www.</code><br>note that the results of <code>target</code>-specific tasks will only include SERP elements that contain a <code>url</code> string;<br>you can also use a wildcard (‘*’) character to specify the search pattern in SERP and narrow down the results;<br>examples:<br><strong><code class="long-string">example.com</code></strong>  - returns results for the website''s home page with URLs, such as <code class="long-string">https://example.com</code>, or <code class="long-string">https://www.example.com/</code>, or <code class="long-string">https://example.com/</code>;<br><strong><code class="long-string">example.com*</code></strong> - returns results for the domain, including all its pages;<br><strong><code class="long-string">*example.com*</code></strong> - returns results for the entire domain, including all its pages and subdomains;<br><strong><code class="long-string">*example.com</code></strong>  - returns results for the home page regardless of the subdomain, such as <code class="long-string">https://en.example.com</code>; <br><strong><code class="long-string">example.com/example-page</code></strong>  - returns results for the exact URL;<br><strong><code class="long-string">example.com/example-page*</code></strong>  - returns results for all domain''s URLs that start with the specified string'
          nullable: true
        search_param:
          type: string
          description: <em>additional parameters of the search query</em><br>optional field<br><a href="https://dataforseo.com/help-center/yahoo-search-engine-parameters-and-how-to-use-them">get the list of available parameters and additional details here</a>
          nullable: true
        stop_crawl_on_match:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/SerpApiStopCrawlOnMatchInfo'
            nullable: true
          description: "array of targets to stop crawling\noptional field\nif specified, the response will contain SERP results up to and including the specified match_value;\nyou can specify up to 10 target values in this array\nexample:\n\"stop_crawl_on_match\":[{\"match_value\":\"dataforseo.com\",\"match_type\":\"with_subdomains\"}]\nlearn more about this parameter on our Help Center - https://dataforseo.com/help-center/using-the-stop_crawl_on_match-parameter-in-serp-api\nYour account will be billed per each SERP crawled through the specified targets"
          nullable: true
        tag:
          type: string
          description: <em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response
          nullable: true
      example:
        - language_code: en
          location_code: 2840
          keyword: albert einstein
    SerpYahooOrganicLiveAdvancedResultInfo:
      type: object
      properties:
        keyword:
          type: string
          description: <em>keyword received in a POST array<br></em><strong>the keyword is returned with decoded %## (plus character '+' will be decoded to a space character)</strong>
          nullable: true
        type:
          type: string
          description: type of element
          nullable: true
        se_domain:
          type: string
          description: <em>search engine domain in a POST array</em>
          nullable: true
        location_code:
          type: integer
          description: <em>location code in a POST array</em>
          nullable: true
        language_code:
          type: string
          description: <em>language code in a POST array</em>
          nullable: true
        check_url:
          type: string
          description: <em>direct URL to search engine results</em><br>you can use it to make sure that we provided accurate results
          nullable: true
        datetime:
          type: string
          description: '<em>date and time when the result was received</em><br>in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”<br>example:<br><code class="long-string">2019-11-15 12:57:46 +00:00</code>'
          nullable: true
        spell:
          type: object
          oneOf:
            - $ref: '#/components/schemas/SpellInfo'
          description: '<em>autocorrection of the search engine</em><br>if the search engine provided results for a keyword that was corrected, we will specify the keyword corrected by the search engine and the type of autocorrection'
          nullable: true
        refinement_chips:
          type: object
          oneOf:
            - $ref: '#/components/schemas/RefinementChipsInfo'
          description: <em>search refinement chips</em><br>equals <code>null</code>
          nullable: true
        item_types:
          type: array
          items:
            type: string
            nullable: true
          description: '<em>types of search results in SERP</em><br>contains types of search results (<code>items</code>) found in SERP.<br>possible item types:<br><span><a href="#featured_snippet"><code>featured_snippet</code></a>, <a href="#images"><code>images</code></a>, <a href="#local_pack"><code>local_pack</code></a>, <a href="#hotels_pack"><code>hotels_pack</code></a>, <a href="#organic"><code>organic</code></a>, <a href="#paid"><code>paid</code></a>, <a href="#people_also_ask"><code>people_also_ask</code></a>, <a href="#related_searches"><code>related_searches</code></a>, <a href="#shopping"><code>shopping</code></a>, <a href="#recipes"><code>recipes</code></a>, <a href="#top_stories"><code>top_stories</code></a>, <a href="#video"><code>video</code></a></span>, <a href="#ai_overview"><code>ai_overview</code></a></span>'
          nullable: true
        se_results_count:
          type: integer
          description: <em> total number of results in SERP</em>
          format: int64
          nullable: true
        pages_count:
          type: integer
          description: <em>total pages retrieved</em><br>total number of retrieved SERPs in the result
          format: int64
          nullable: true
        items_count:
          type: integer
          description: <em>the number of results returned in the <strong><code>items</code></strong> array</em>
          format: int64
          nullable: true
        items:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/BaseSerpApiElementItem'
            nullable: true
          description: <em>elements of search results found in SERP</em>
          nullable: true
    SerpYahooOrganicLiveAdvancedTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpYahooOrganicLiveAdvancedResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    SerpYahooOrganicLiveAdvancedResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpYahooOrganicLiveAdvancedTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    SerpYahooOrganicLiveHtmlRequestInfo:
      type: object
      properties:
        url:
          type: string
          description: '<em>direct URL of the search query</em><br>optional field<br>you can specify a direct URL and we will sort it out to the necessary fields. Note that this method is the most difficult for our API to process and also requires you to specify the exact language and location in the URL. In most cases, we wouldn’t recommend using this method.<br>example:<br><code class="long-string">https://search.yahoo.com/search?p=rank+checker&amp;n=100&amp;vl=lang_en&amp;vc=us&amp;ei=UTF-8</code>'
          nullable: true
        keyword:
          type: string
          description: '<em>keyword</em><br><strong>required field</strong><br>you can specify <strong>up to 700 characters</strong> in the <code>keyword</code> field<br><strong>all %## will be decoded (plus character ''+'' will be decoded to a space character)</strong><br>if you need to use the "%" character for your <code>keyword</code>, please specify it as "%25";<br>if you need to use the “+” character for your <code>keyword</code>, please specify it as “%2B”<p>learn more about rules and limitations of <code>keyword</code> and <code>keywords</code> fields in DataForSEO APIs in this <a href="https://dataforseo.com/help-center/rules-and-limitations-of-keyword-and-keywords-fields-in-dataforseo-apis" rel="noopener noreferrer" target="_blank">Help Center article</a>'
        location_name:
          type: string
          description: '<em>full name of search engine location</em><br><strong>required field if you don''t specify</strong> <code>location_code</code> or <code>location_coordinate</code><br><strong>if you use this field, you don''t need to specify <code>location_code</code> or <code>location_coordinate</code></strong><br>you can receive the list of available locations of the search engine with their <code>location_name</code> by making a separate request to the <code>https://api.dataforseo.com/v3/serp/{{low_se_name}}/locations</code><br>example:<br><code class="long-string">London,England,United Kingdom</code>'
        location_code:
          type: integer
          description: '<em>search engine location code</em><br><strong>required field if you don''t specify</strong> <code>location_name</code>_or <code>location_coordinate</code><br><strong>if you use this field, you don''t need to specify <code>location_name</code> or <code>location_coordinate</code></strong><br>you can receive the list of available locations of the search engines with their <code>location_code</code> by making a separate request to the <code>https://api.dataforseo.com/v3/serp/{{low_se_name}}/locations</code><br>example:<br><code class="long-string">2840</code>n'
        location_coordinate:
          type: string
          description: '<em>GPS coordinates of a location</em><br><strong>required field if you don''t specify</strong> <code>location_name</code>_or <code>location_code</code><br><strong>if you use this field, you don''t need to specify <code>location_name</code> or <code>location_code</code></strong><br><code>location_coordinate</code> parameter should be specified in the <em>"latitude,longitude,radius"</em> format<br>the maximum number of decimal digits for <em>"latitude"</em> and <em>"longitude"</em>: 7<br>the minimum value for <em>"radius"</em>: 199.9 (mm)<br>the maximum value for <em>"radius"</em>: 199999 (mm)<br>example:<br><code class="long-string">53.476225,-2.243572,200</code>n'
        language_name:
          type: string
          description: '<em>full name of search engine language</em><br><strong>required field if you don''t specify</strong> <code>language_code</code><br><strong>if you use this field, you don''t need to specify <code>language_code</code></strong><br>you can receive the list of available languages of the search engine with their <code>language_name</code> by making a separate request to the <code>https://api.dataforseo.com/v3/serp/{{low_se_name}}/languages</code><br>example:<br><code class="long-string">English</code>'
        language_code:
          type: string
          description: '<em>search engine language code</em><br><strong>required field if you don''t specify</strong> <code>language_name</code><br><strong>if you use this field, you don''t need to specify <code>language_name</code></strong><br>you can receive the list of available languages of the search engine with their <code>language_code</code>_by making a separate request to the <code>https://api.dataforseo.com/v3/serp/{{low_se_name}}/languages</code><em><br></em>example:<em><br></em><code class="long-string">en</code>n'
        device:
          type: string
          description: '<em>device type</em><br>optional field<br>return results for a specific device type<br>can take the values:<code>desktop</code>, <code>mobile</code><br>default value: <code>desktop</code>'
          nullable: true
        os:
          type: string
          description: '<em>device operating system</em><br>optional field<br>if you specify <code>desktop</code> in the <code>device</code> field, choose from the following values: <code>windows</code>, <code>macos</code><br>default value: <code>windows</code><br>if you specify <code>mobile</code> in the <code>device</code> field, choose from the following values: <code>android</code>, <code>ios</code><br>default value: <code>android</code>'
          nullable: true
        se_domain:
          type: string
          description: '<em>search engine domain</em><br>optional field<br>we choose the relevant search engine domain automatically according to the location and language you specify<br>however, you can set a custom search engine domain in this field<br>example:<br><code>au.search.yahoo.com</code>, <code>uk.search.yahoo.com</code>, <code>ca.search.yahoo.com</code>, etc.'
          nullable: true
        depth:
          type: integer
          description: '<em>parsing depth</em><br>optional field<br>number of results in SERP<br>default value: <code>10</code><br>max value: <code>200</code><br><strong>Your account will be billed per each SERP containing up to 10 results;</strong> <br>Setting depth above 10 may result in additional charges <a href="https://dataforseo.com/help-center/how-many-results-scraped" rel="noopener noreferrer" target="_blank">if the search engine returns more than 10 results</a>;<br>The cost can be calculated on the <a title="Pricing" href="https://dataforseo.com/pricing/serp/yahoo-serp-api" target="_blank" rel="noopener noreferrer">Pricing</a> page.'
          nullable: true
        max_crawl_pages:
          type: integer
          description: '<em>page crawl limit</em><br>optional field<br>number of search results pages to crawl<br>default value: <code>1</code><br>max value: <code>100</code><br><strong>Note:</strong> the <code>max_crawl_pages</code> and <code>depth</code> parameters complement each other;<br>learn more at <a href="https://dataforseo.com/help-center/what-is-max-crawl-pages-and-how-does-it-work" rel="noopener noreferrer" target="_blank">our help center</a>'
          nullable: true
        search_param:
          type: string
          description: <em>additional parameters of the search query</em><br>optional field<br><a href="https://dataforseo.com/what-are-google-search-parameters-and-how-to-use-them-with-serp-api.html">get the list of available parameters and additional details here</a>
          nullable: true
        stop_crawl_on_match:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/SerpApiStopCrawlOnMatchInfo'
            nullable: true
          description: "array of targets to stop crawling\noptional field\nif specified, the response will contain SERP results up to and including the specified match_value;\nyou can specify up to 10 target values in this array\nexample:\n\"stop_crawl_on_match\":[{\"match_value\":\"dataforseo.com\",\"match_type\":\"with_subdomains\"}]\nlearn more about this parameter on our Help Center - https://dataforseo.com/help-center/using-the-stop_crawl_on_match-parameter-in-serp-api\nYour account will be billed per each SERP crawled through the specified targets"
          nullable: true
      example:
        - language_code: en
          location_code: 2840
          keyword: albert einstein
    SerpYahooOrganicLiveHtmlResultInfo:
      type: object
      properties:
        keyword:
          type: string
          description: <em>keyword received in a POST array<br></em><strong>keyword is returned with decoded %## (plus character '+' will be decoded to a space character)</strong>
          nullable: true
        type:
          type: string
          description: type of element
          nullable: true
        se_domain:
          type: string
          description: <em>search engine domain in a POST array</em>
          nullable: true
        location_code:
          type: integer
          description: <em>location code in a POST array</em>
          nullable: true
        language_code:
          type: string
          description: <em>language code in a POST array</em>
          nullable: true
        datetime:
          type: string
          description: '<em>date and time when the result was received</em><br>in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”<br>example:<br><code class="long-string">2019-11-15 12:57:46 +00:00</code>'
          nullable: true
        items_count:
          type: integer
          description: <em>the number of results returned in the <strong><code>items</code></strong> array</em>
          format: int64
          nullable: true
        items:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/HtmlItemInfo'
            nullable: true
          description: <em>elements of search results found in SERP</em>
          nullable: true
    SerpYahooOrganicLiveHtmlTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpYahooOrganicLiveHtmlResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    SerpYahooOrganicLiveHtmlResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpYahooOrganicLiveHtmlTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    SerpBaiduLocationsResultInfo:
      type: object
      properties:
        location_code:
          type: integer
          description: <em>location code</em>
          nullable: true
        location_name:
          type: string
          description: <em>full name of the location</em>
          nullable: true
        location_code_parent:
          type: integer
          description: <em>the code of the superordinate location</em><br>only <code>City</code> <code>location_type</code> is supported for all countries except China (where <code>Country</code> is also supported);<br>don't match locations by <code>location_code_parent</code> because the results for <code>Region</code> and <code>Country</code>-level results for most countries are not supported by Baidu SERP API
          nullable: true
        country_iso_code:
          type: string
          description: <em>ISO country code of the location</em>
          nullable: true
        location_type:
          type: string
          description: <em>location type</em><br>only <code>City</code> is supported for all countries except China (where <code>Country</code> is also supported)
          nullable: true
    SerpBaiduLocationsTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpBaiduLocationsResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    SerpBaiduLocationsResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpBaiduLocationsTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    SerpBaiduLocationsCountryResultInfo:
      type: object
      properties:
        location_code:
          type: integer
          description: <em>location code</em>
          nullable: true
        location_name:
          type: string
          description: <em>full name of the location</em>
          nullable: true
        location_code_parent:
          type: integer
          description: <em>the code of the superordinate location</em><br>only <code>City</code> <code>location_type</code> is supported for all countries except China (where <code>Country</code> is also supported);<br>don't match locations by <code>location_code_parent</code> because the results for <code>Region</code> and <code>Country</code>-level results for most countries are not supported by Baidu SERP API
          nullable: true
        country_iso_code:
          type: string
          description: <em>ISO country code of the location</em>
          nullable: true
        location_type:
          type: string
          description: <em>location type</em><br>only <code>City</code> is supported for all countries except China (where <code>Country</code> is also supported)
          nullable: true
    SerpBaiduLocationsCountryTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpBaiduLocationsCountryResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    SerpBaiduLocationsCountryResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpBaiduLocationsCountryTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    SerpBaiduLanguagesResultInfo:
      type: object
      properties:
        language_name:
          type: string
          description: <em>language name</em>
          nullable: true
        language_code:
          type: string
          description: <em>language code according to <a href="https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes" target="_blank" rel="noopener noreferrer">ISO 639-1</a></em>
          nullable: true
    SerpBaiduLanguagesTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpBaiduLanguagesResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    SerpBaiduLanguagesResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpBaiduLanguagesTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    SerpBaiduOrganicTaskPostRequestInfo:
      type: object
      properties:
        keyword:
          type: string
          description: '<em>keyword</em><br><strong>required field</strong><br>you can specify <strong>up to 700 characters</strong> in the <code>keyword</code> field<br>all %## will be decoded (plus character ‘+’ will be decoded to a space character)<br>if you need to use the “%” character for your <code>keyword</code>, please specify it as “%25”;<br>if you need to use the “+” character for your <code>keyword</code>, please specify it as “%2B”<p>learn more about rules and limitations of <code>keyword</code> and <code>keywords</code> fields in DataForSEO APIs in this <a href="https://dataforseo.com/help-center/rules-and-limitations-of-keyword-and-keywords-fields-in-dataforseo-apis" rel="noopener noreferrer" target="_blank">Help Center article</a>'
        priority:
          type: integer
          description: <em>task priority</em><br>optional field<br>can take the following values:<br>1 – normal execution priority (set by default)<br>2 – high execution priority<br>You will be additionally charged for the tasks with high execution priority.<br>The cost can be calculated on the <a title="Pricing" href="https://dataforseo.com/pricing/serp/baidu-organic-serp-api" target="_blank" rel="noopener noreferrer">Pricing</a> page.
          nullable: true
        depth:
          type: integer
          description: '<em>parsing depth</em><br>optional field<br>number of results in SERP<br>default value: <code>10</code><br>max value: <code>700</code><br><strong>Your account will be billed per each SERP containing up to 10 results;</strong> <br>Setting depth above 10 may result in additional charges <a href="https://dataforseo.com/help-center/how-many-results-scraped" rel="noopener noreferrer" target="_blank">if the search engine returns more than 10 results</a>;<br>The cost can be calculated on the <a title="Pricing" href="https://dataforseo.com/pricing/serp/baidu-organic-serp-api" target="_blank" rel="noopener noreferrer">Pricing</a> page.'
          nullable: true
        max_crawl_pages:
          type: integer
          description: '<em>page crawl limit</em><br>optional field<br>number of search results pages to crawl<br>default value: <code>1</code><br>max value: <code>100</code><br><strong>Note:</strong> the <code>max_crawl_pages</code> and <code>depth</code> parameters complement each other;<br>learn more at <a href="https://dataforseo.com/help-center/what-is-max-crawl-pages-and-how-does-it-work" target="_blank" rel="noopener noreferrer">our help center</a>'
          nullable: true
        language_name:
          type: string
          description: '<em>full name of search engine language</em><br><strong>required field if you don''t specify</strong> <code>language_code</code><br>you can receive the list of available languages of the search engine with their <code>language_name</code> by making a separate request to the <code>https://api.dataforseo.com/v3/serp/{{low_se_name}}/languages</code><strong>note</strong> that the only language supported in Baidu search engine is <code>Chinese (Simplified)</code>. However, Baidu may as well return results for queries in other languages, so specifying <code>keyword</code> in Chinese is not mandatory<p>example:<br><code class="long-string">Chinese (Simplified)</code>'
        language_code:
          type: string
          description: '<em>search engine language code</em><br><strong>required field if you don''t specify</strong> <code>language_name</code><br>you can receive the list of available languages of the search engine with their <code>language_code</code> by making a separate request to the <code>https://api.dataforseo.com/v3/serp/{{low_se_name}}/languages</code><strong>note</strong> that the only language supported in Baidu search engine is <code>Chinese (Simplified)</code> with the <code>zh_CN</code> language code. However, Baidu may as well return results for queries in other languages, so specifying <code>keyword</code> in Chinese is not mandatory<p>example:<br><code class="long-string">zh_CN</code>'
        location_name:
          type: string
          description: '<em>full name of search engine location</em><br><strong>required field if you don''t specify</strong> <code>location_code</code> or <code>location_coordinate</code><br><strong>if you use this field, you don''t need to specify <code>location_code</code> or <code>location_coordinate</code></strong><br>you can receive the list of available locations of the search engine with their <code>location_name</code> by making a separate request to the <code>https://api.dataforseo.com/v3/serp/{{low_se_name}}/locations</code><br>example:<br><code class="long-string">New York,New York,United States</code>'
        location_code:
          type: integer
          description: '<em>search engine location code</em><br><strong>required field if you don''t specify</strong> <code>location_name</code> or <code>location_coordinate</code><br><strong>if you use this field, you don''t need to specify <code>location_name</code> or <code>location_coordinate</code></strong><br>you can receive the list of available locations of the search engines with their <code>location_code</code> by making a separate request to the <code>https://api.dataforseo.com/v3/serp/{{low_se_name}}/locations</code><br>example:<br><code class="long-string">2156</code>'
        location_coordinate:
          type: string
          description: '<em>GPS coordinates of a location</em><br><strong>required field if you don''t specify</strong> <code>location_name</code> or <code>location_code</code><br><strong>if you use this field, you don''t need to specify <code>location_name</code> or <code>location_code</code></strong><br><code>location_coordinate</code> parameter should be specified in the <em>"latitude,longitude,radius"</em> format<br>the maximum number of decimal digits for <em>"latitude"</em> and <em>"longitude"</em>: 7<br>the minimum value for <em>"radius"</em>: 199.9 (mm)<br>the maximum value for <em>"radius"</em>: 199999 (mm)if you use this field, the returned results will be based on the closest city found for your coordinates. Thus, <strong>we don''t recommend</strong> using this field as the results might not be relevant to the specified coordinates<br>example:<br><code class="long-string">53.476225,-2.243572,200</code>'
        device:
          type: string
          description: '<em>device type</em><br>optional field<br>return results for a specific device type<br>can take the values: <code>desktop</code>, <code>mobile</code>, <code>tablet</code><br>default value: <code>desktop</code>'
          nullable: true
        os:
          type: string
          description: '<em>device operating system</em><br>optional field<br>if you specify <code>desktop</code> in the <code>device</code> field, choose from the following values: <code>windows</code>, <code>macos</code><br>default value: <code>windows</code><br>if you specify <code>mobile</code> in the <code>device</code> field, choose from the following values: <code>android</code>, <code>ios</code><br>default value: <code>android</code><br>if you specify <code>tablet</code> in the <code>device</code> field, choose from the following values: <code>android</code>, <code>ios</code><br>default value: <code>android</code>'
          nullable: true
        get_website_url:
          type: boolean
          description: '<em>include direct URL for each ranked result</em><br>optional field<br>if set to <code>true</code>, the returned results will contain direct URLs of the ranked websites<br>by default, the URLs in Baidu results are encoded by the search engine,<br>for example:<br><code>http://www.baidu.com/link?url=KQt6LSwU5OHnPtB8210R8flBP40grY6lTPxH_0UO7S2kgiZMTmw3ztV0hCo5c1kL</code>default value: <code>false</code><br><strong>Note:</strong> if set to <code>true</code>, <strong>the charge per task will be multiplied by 10</strong> as our system runs a separate request for each ranked website to return its direct URL'
          nullable: true
        stop_crawl_on_match:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/SerpApiStopCrawlOnMatchInfo'
            nullable: true
          description: "array of targets to stop crawling\noptional field\nif specified, the response will contain SERP results up to and including the specified match_value;\nyou can specify up to 10 target values in this array\nexample:\n\"stop_crawl_on_match\":[{\"match_value\":\"dataforseo.com\",\"match_type\":\"with_subdomains\"}]\nlearn more about this parameter on our Help Center - https://dataforseo.com/help-center/using-the-stop_crawl_on_match-parameter-in-serp-api\nYour account will be billed per each SERP crawled through the specified targets"
          nullable: true
        tag:
          type: string
          description: <em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response
          nullable: true
        postback_url:
          type: string
          description: '<em>URL for sending task results</em><br>optional field<br>once the task is completed, we will send a POST request with its results compressed in the <code>gzip</code> format to the <code>postback_url</code> you specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/postbackscript?id=$id</code><br><code>http://your-server.com/postbackscript?id=$id&amp;tag=$tag</code><br><strong>Note:</strong> special characters in <code>postback_url</code> will be urlencoded;<br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href="https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api" target="_blank" rel="noopener noreferrer">Help Center</a>'
          nullable: true
        postback_data:
          type: string
          description: '<em>postback_url datatype</em><br><strong>required field if you specify <code>postback_url</code></strong><br>corresponds to the datatype that will be sent to your server<br>possible values:<br><code>regular</code>, <code>html</code>'
        pingback_url:
          type: string
          description: '<em>notification URL of a completed task</em><br>optional field<br>when a task is completed we will notify you by GET request sent to the URL you have specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/pingscript?id=$id</code><br><code>http://your-server.com/pingscript?id=$id&amp;tag=$tag</code><br><strong>Note:</strong> special characters in <code>pingback_url</code> will be urlencoded;<br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href="https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api" target="_blank" rel="noopener noreferrer">Help Center</a>'
          nullable: true
      example:
        - location_code: 2156
          keyword: best iphone ever
          tag: some_string_123
          priority: 2
    SerpBaiduOrganicTaskPostTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: object
              description: '<em>array of results</em><br>in this case, the value will be <code>null</code>'
              nullable: true
    SerpBaiduOrganicTaskPostResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpBaiduOrganicTaskPostTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    SerpBaiduOrganicTasksReadyResultInfo:
      type: object
      properties:
        id:
          type: string
          description: <em>task identifier of the completed task</em><br><strong>unique task identifier in our system in the <a href="https://en.wikipedia.org/wiki/Universally_unique_identifier">UUID</a> format</strong>
          nullable: true
        se:
          type: string
          description: <em>search engine specified when setting the task</em>
          nullable: true
        se_type:
          type: string
          description: '<em>type of search engine</em><br>example: <code>{{low_se_type_under}}</code>'
          nullable: true
        date_posted:
          type: string
          description: <em>date when the task was posted (in the UTC format)</em>
          nullable: true
        tag:
          type: string
          description: <em>user-defined task identifier</em>
          nullable: true
        endpoint_regular:
          type: string
          description: '<em>URL for collecting the results of the SERP Regular task</em><br>if SERP Regular is not supported in the specified endpoint, the value will be <code>null</code>'
          nullable: true
        endpoint_advanced:
          type: string
          description: '<em>URL for collecting the results of the SERP Advanced task</em><br>if SERP Advanced is not supported in the specified endpoint, the value will be <code>null</code>'
          nullable: true
        endpoint_html:
          type: string
          description: '<em>URL for collecting the results of the SERP HTML task</em><br>if SERP HTML is not supported in the specified endpoint, the value will be <code>null</code>'
          nullable: true
    SerpBaiduOrganicTasksReadyTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpBaiduOrganicTasksReadyResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    SerpBaiduOrganicTasksReadyResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpBaiduOrganicTasksReadyTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    SerpBaiduOrganicTasksFixedResultInfo:
      type: object
      properties:
        id:
          type: string
          description: <em>task identifier of the completed task</em><br><strong>unique task identifier in our system in the <a href="https://en.wikipedia.org/wiki/Universally_unique_identifier">UUID</a> format</strong>
          nullable: true
        se:
          type: string
          description: <em>search engine specified when setting the task</em>
          nullable: true
        se_type:
          type: string
          description: '<em>type of search engine</em><br>can take the following values: <code>{{low_se_type_under}}</code>'
          nullable: true
        date_posted:
          type: string
          nullable: true
        tag:
          type: string
          description: <em>user-defined task identifier</em>
          nullable: true
        endpoint_regular:
          type: string
          description: '<em>URL for collecting the results of the SERP Regular task</em><br>if SERP Regular is not supported in the specified endpoint, the value will be <code>null</code>'
          nullable: true
        endpoint_advanced:
          type: string
          description: '<em>URL for collecting the results of the SERP Advanced task</em><br>if SERP Advanced is not supported in the specified endpoint, the value will be <code>null</code>'
          nullable: true
        endpoint_html:
          type: string
          description: '<em>URL for collecting the results of the SERP HTML task</em><br>if SERP HTML is not supported in the specified endpoint, the value will be <code>null</code>'
          nullable: true
    SerpBaiduOrganicTasksFixedTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpBaiduOrganicTasksFixedResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    SerpBaiduOrganicTasksFixedResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpBaiduOrganicTasksFixedTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    SerpBaiduOrganicTaskGetRegularResultInfo:
      type: object
      properties:
        keyword:
          type: string
          description: <em>keyword received in a POST array</em><br><strong>keyword is returned with decoded %## (plus symbol '+' will be decoded to a space character)</strong>
          nullable: true
        type:
          type: string
          description: type of element
          nullable: true
        se_domain:
          type: string
          description: <em>search engine domain in a POST array</em>
          nullable: true
        location_code:
          type: integer
          description: <em>location code in a POST array</em>
          nullable: true
        language_code:
          type: string
          description: <em>language code in a POST array</em>
          nullable: true
        check_url:
          type: string
          description: <em>direct URL to search engine results</em><br>you can use it to make sure that we provided accurate results
          nullable: true
        datetime:
          type: string
          description: '<em>date and time when the result was received</em><br>in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”<br>example:<br><code class="long-string">2019-11-15 12:57:46 +00:00</code>'
          nullable: true
        spell:
          type: object
          oneOf:
            - $ref: '#/components/schemas/SpellInfo'
          description: '<em>autocorrection of the search engine</em><br>if the search engine provided results for a keyword that was corrected, we will specify the keyword corrected by the search engine and the type of autocorrection'
          nullable: true
        refinement_chips:
          type: object
          oneOf:
            - $ref: '#/components/schemas/RefinementChipsInfo'
          description: <em>search refinement chips</em><br>equals <code>null</code>
          nullable: true
        item_types:
          type: array
          items:
            type: string
            nullable: true
          description: '<em>types of search results found in SERP</em><br>contains types of all search results (<code>items</code>) found in the returned SERP<br>possible item types:<br><code>organic</code>, <code>paid</code>'
          nullable: true
        se_results_count:
          type: integer
          description: <em>total number of results in SERP</em>
          format: int64
          nullable: true
        pages_count:
          type: integer
          description: <em>total pages retrieved</em><br>total number of retrieved SERPs in the result
          format: int64
          nullable: true
        items_count:
          type: integer
          description: <em>the number of results returned in the <strong><code>items</code></strong> array</em>
          format: int64
          nullable: true
        items:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/BaseSerpApiElementItem'
            nullable: true
          description: <em>elements of search results found in SERP</em>
          nullable: true
    SerpBaiduOrganicTaskGetRegularTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpBaiduOrganicTaskGetRegularResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    SerpBaiduOrganicTaskGetRegularResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpBaiduOrganicTaskGetRegularTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    DictionarySerpElementItem:
      type: object
      allOf:
        - type: object
          oneOf:
            - $ref: '#/components/schemas/BaseSerpApiElementItem'
          nullable: true
        - type: object
          properties:
            rank_group:
              type: integer
              description: <em>group rank in SERP</em><br><br>            position within a group of elements with identical <code>type</code> values<br><br>            positions of elements with different <code>type</code> values are omitted from <code>rank_group</code>
              nullable: true
            rank_absolute:
              type: integer
              description: <em>absolute rank in SERP</em><br><br>            absolute position among all the elements in SERP
              nullable: true
            title:
              type: string
              description: <em>title of the result in SERP</em>
              nullable: true
            url:
              type: string
              description: <em> relevant URL of the Ad element in SERP</em>
              nullable: true
            domain:
              type: string
              description: <em>domain in SERP</em>
              nullable: true
            breadcrumb:
              type: string
              description: <em>breadcrumb of the Ad element in SERP</em>
              nullable: true
            keyword:
              type: string
              description: <em>keyword highlighted in the result</em>
              nullable: true
            snippet:
              type: string
              description: <em>snippet of the element</em>
              nullable: true
            text:
              type: string
              description: <em>description of the results element in SERP</em>
              nullable: true
            links:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/LinkElement'
                nullable: true
              description: '<em>sitelinks</em><br><br>            the links shown below some of search results<br><br>            if there are none, equals <code>null</code>'
              nullable: true
    SerpBaiduOrganicTaskGetAdvancedResultInfo:
      type: object
      properties:
        keyword:
          type: string
          description: <em>keyword received in a POST array<br><br>        </em><strong>the keyword is returned with decoded %## (plus symbol ‘+’ will be decoded to a space character)</strong>
          nullable: true
        type:
          type: string
          description: type of element
          nullable: true
        se_domain:
          type: string
          description: <em>search engine domain in a POST array</em>
          nullable: true
        location_code:
          type: integer
          description: <em>location code in a POST array</em>
          nullable: true
        language_code:
          type: string
          description: <em>language code in a POST array</em>
          nullable: true
        check_url:
          type: string
          description: <em>direct URL to search engine results</em><br><br>            you can use it to make sure that we provided accurate results
          nullable: true
        datetime:
          type: string
          description: '<em>date and time when the result was received</em><br><br>            in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”<br><br>            example:<br><br>            <code class="long-string">2019-11-15 12:57:46 +00:00</code>'
          nullable: true
        spell:
          type: object
          oneOf:
            - $ref: '#/components/schemas/SpellInfo'
          description: '<em>autocorrection of the search engine</em><br><br>            if the search engine provided results for a keyword that was corrected, we will specify the keyword corrected by the search engine and the type of autocorrection'
          nullable: true
        refinement_chips:
          type: object
          oneOf:
            - $ref: '#/components/schemas/RefinementChipsInfo'
          description: <em>search refinement chips</em><br><br>            equals <code>null</code>
          nullable: true
        item_types:
          type: array
          items:
            type: string
            nullable: true
          description: '<em>types of search results in SERP</em><br><br>            contains types of search results (<code>items</code>) found in SERP.<br><br>            possible item types:<br><br>            <code>images</code>, <code>local_pack</code>, <code>map</code>, <code>organic</code>, <code>paid</code>, <code>related_searches</code>, <code>video</code>, <code>stocks_box</code>, <code>dictionary</code>, <code>shopping</code>'
          nullable: true
        se_results_count:
          type: integer
          description: <em> total number of results in SERP</em>
          format: int64
          nullable: true
        pages_count:
          type: integer
          description: <em>total pages retrieved</em><br><br>            total number of retrieved SERPs in the result
          format: int64
          nullable: true
        items_count:
          type: integer
          description: <em>the number of results returned in the <strong><code>items</code></strong> array</em>
          format: int64
          nullable: true
        items:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/BaseSerpApiElementItem'
            nullable: true
          description: '<em>additional items present in the element</em><br><br>            if there are none, equals <code>null</code>'
          nullable: true
    SerpBaiduOrganicTaskGetAdvancedTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpBaiduOrganicTaskGetAdvancedResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    SerpBaiduOrganicTaskGetAdvancedResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpBaiduOrganicTaskGetAdvancedTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    SerpBaiduOrganicTaskGetHtmlResultInfo:
      type: object
      properties:
        keyword:
          type: string
          description: <em>keyword received in a POST array<br></em><strong>keyword is returned with decoded %## (plus symbol '+' will be decoded to a space character)</strong>
          nullable: true
        type:
          type: string
          description: type of element
          nullable: true
        se_domain:
          type: string
          description: <em>search engine domain in a POST array</em>
          nullable: true
        location_code:
          type: integer
          description: <em>location code in a POST array</em>
          nullable: true
        language_code:
          type: string
          description: <em>language code in a POST array</em>
          nullable: true
        datetime:
          type: string
          description: '<em>date and time when the result was received</em><br>in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”<br>example:<br><code class="long-string">2019-11-15 12:57:46 +00:00</code>'
          nullable: true
        items_count:
          type: integer
          description: <em>the number of results returned in the <strong><code>items</code></strong> array</em>
          format: int64
          nullable: true
        items:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/HtmlItemInfo'
            nullable: true
          description: <em>elements of search results found in SERP</em>
          nullable: true
    SerpBaiduOrganicTaskGetHtmlTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpBaiduOrganicTaskGetHtmlResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    SerpBaiduOrganicTaskGetHtmlResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpBaiduOrganicTaskGetHtmlTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    SerpNaverOrganicTaskPostRequestInfo:
      type: object
      properties:
        keyword:
          type: string
          description: '<em>keyword</em><br><strong>required field</strong><br>you can specify <strong>up to 700 characters</strong> in the <code>keyword</code> field<br>all %## will be decoded (plus character ‘+’ will be decoded to a space character)<br>if you need to use the “%” character for your <code>keyword</code>, please specify it as “%25”;<br>if you need to use the “+” character for your <code>keyword</code>, please specify it as “%2B”<p>learn more about rules and limitations of <code>keyword</code> and <code>keywords</code> fields in DataForSEO APIs in this <a href="https://dataforseo.com/help-center/rules-and-limitations-of-keyword-and-keywords-fields-in-dataforseo-apis" rel="noopener noreferrer" target="_blank">Help Center article</a>'
        url:
          type: string
          description: '<em>direct URL of the search query</em><br>optional field<br>you can specify a direct URL and we will sort it out to the necessary fields<br>in most cases, we wouldn’t recommend using this method;<br>example:<br><code class="long-string">https://search.naver.com/search.naver?where=nexearch&amp;sm=top_hty&amp;fbm=1&amp;ie=utf8&amp;query=iphone</code>'
          nullable: true
        priority:
          type: integer
          description: <em>task priority</em><br>optional field<br>can take the following values:<br>1 – normal execution priority (set by default)<br>2 – high execution priorityYou will be additionally charged for the tasks with high execution priority.<br>The cost can be calculated on the <a title="Pricing" href="https://dataforseo.com/pricing/serp/naver-organic-serp-api" target="_blank" rel="noopener noreferrer">Pricing</a> page.
          nullable: true
        depth:
          type: integer
          description: '<em>parsing depth</em><br>optional field<br>number of results in SERP<br>default value: <code>15</code><br>max value: <code>700</code><br><strong>Your account will be billed per each SERP containing up to 15 results;</strong> <br>Setting depth above 15 may result in additional charges <a href="https://dataforseo.com/help-center/how-many-results-scraped" rel="noopener noreferrer" target="_blank">if the search engine returns more than 15 results</a>;<br>The cost can be calculated on the <a title="Pricing" href="https://dataforseo.com/pricing/serp/naver-organic-serp-api" target="_blank" rel="noopener noreferrer">Pricing</a> page.'
          nullable: true
        max_crawl_pages:
          type: integer
          description: '<em>page crawl limit</em><br>optional field<br>number of search results pages to crawl<br>default value: <code>1</code><br>max value: <code>100</code><br><strong>Note:</strong> the <code>max_crawl_pages</code> and <code>depth</code> parameters complement each other;<br>learn more at <a href="https://dataforseo.com/help-center/what-is-max-crawl-pages-and-how-does-it-work" target="_blank" rel="noopener noreferrer">our help center</a>'
          nullable: true
        device:
          type: string
          description: '<em>device type</em><br>optional field<br>return results for a specific device type<br>can take the values:<code>desktop</code>, <code>mobile</code><br>default value: <code>desktop</code>'
          nullable: true
        os:
          type: string
          description: '<em>device operating system</em><br>optional field<br>if you specify <code>desktop</code> in the <code>device</code> field, choose from the following values: <code>windows</code>, <code>macos</code><br>default value: <code>windows</code><br>if you specify <code>mobile</code> in the <code>device</code> field, choose from the following values: <code>android</code>, <code>ios</code><br>default value: <code>android</code>'
          nullable: true
        se_domain:
          type: string
          description: '<em>search engine domain</em><br>optional field<br>we choose the relevant search engine domain automatically<br>however, you can set a custom search engine domain in this field<br>example:<br><code><code></code></code><em>search.naver.com</em>'
          nullable: true
        search_param:
          type: string
          description: <em>additional parameters of the search query</em><br>optional field<br><a href="https://dataforseo.com/what-are-google-search-parameters-and-how-to-use-them-with-serp-api.html">get the list of available parameters and additional details here</a>
          nullable: true
        stop_crawl_on_match:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/SerpApiStopCrawlOnMatchInfo'
            nullable: true
          description: "array of targets to stop crawling\noptional field\nif specified, the response will contain SERP results up to and including the specified match_value;\nyou can specify up to 10 target values in this array\nexample:\n\"stop_crawl_on_match\":[{\"match_value\":\"dataforseo.com\",\"match_type\":\"with_subdomains\"}]\nlearn more about this parameter on our Help Center - https://dataforseo.com/help-center/using-the-stop_crawl_on_match-parameter-in-serp-api\nYour account will be billed per each SERP crawled through the specified targets"
          nullable: true
        tag:
          type: string
          description: <em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response
          nullable: true
        postback_url:
          type: string
          description: '<em>URL for sending task results</em><br>optional field<br>once the task is completed, we will send a POST request with its results compressed in the <code>gzip</code> format to the <code>postback_url</code> you specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/postbackscript?id=$id</code><br><code>http://your-server.com/postbackscript?id=$id&amp;tag=$tag</code><br><strong>Note:</strong> special characters in <code>postback_url</code> will be urlencoded;<br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href="https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api" target="_blank" rel="noopener noreferrer">Help Center</a>'
          nullable: true
        postback_data:
          type: string
          description: '<em>postback_url datatype</em><br><strong>required field if you specify <code>postback_url</code></strong><br>corresponds to the function you used for setting a task<br>possible values:<br><code>regular</code>, <code>advanced</code>, <code>html</code>'
        pingback_url:
          type: string
          description: '<em>notification URL of a completed task</em><br>optional field<br>when a task is completed we will notify you by GET request sent to the URL you have specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/pingscript?id=$id</code><br><code>http://your-server.com/pingscript?id=$id&amp;tag=$tag</code><br><strong>Note:</strong> special characters in <code>pingback_url</code> will be urlencoded;<br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href="https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api" target="_blank" rel="noopener noreferrer">Help Center</a>'
          nullable: true
      example:
        - keyword: albert einstein
          device: desktop
          tag: some_string_123
          postback_url: https://your-server.com/postbackscript.php
          postback_data: regular
    SerpNaverOrganicTaskPostTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: object
              description: '<em>array of results</em><br>in this case, the value will be <code>null</code>'
              nullable: true
    SerpNaverOrganicTaskPostResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpNaverOrganicTaskPostTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    SerpNaverOrganicTasksReadyResultInfo:
      type: object
      properties:
        id:
          type: string
          description: <em>task identifier of the completed task</em><br><strong>unique task identifier in our system in the <a href="https://en.wikipedia.org/wiki/Universally_unique_identifier">UUID</a> format</strong>
          nullable: true
        se:
          type: string
          description: <em>search engine specified when setting the task</em>
          nullable: true
        se_type:
          type: string
          description: '<em>type of search engine</em><br>example: <code>{{low_se_type_under}}</code>'
          nullable: true
        date_posted:
          type: string
          description: <em>date when the task was posted (in the UTC format)</em>
          nullable: true
        tag:
          type: string
          description: <em>user-defined task identifier</em>
          nullable: true
        endpoint_regular:
          type: string
          description: '<em>URL for collecting the results of the SERP Regular task</em><br>if SERP Regular is not supported in the specified endpoint, the value will be <code>null</code>'
          nullable: true
        endpoint_advanced:
          type: string
          description: '<em>URL for collecting the results of the SERP Advanced task</em><br>if SERP Advanced is not supported in the specified endpoint, the value will be <code>null</code>'
          nullable: true
        endpoint_html:
          type: string
          description: '<em>URL for collecting the results of the SERP HTML task</em><br>if SERP HTML is not supported in the specified endpoint, the value will be <code>null</code>'
          nullable: true
    SerpNaverOrganicTasksReadyTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpNaverOrganicTasksReadyResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    SerpNaverOrganicTasksReadyResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpNaverOrganicTasksReadyTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    SerpNaverOrganicTasksFixedResultInfo:
      type: object
      properties:
        id:
          type: string
          description: <em>task identifier of the completed task</em><br><strong>unique task identifier in our system in the <a href="https://en.wikipedia.org/wiki/Universally_unique_identifier">UUID</a> format</strong>
          nullable: true
        se:
          type: string
          description: <em>search engine specified when setting the task</em>
          nullable: true
        se_type:
          type: string
          description: '<em>type of search engine</em><br>can take the following values: <code>{{low_se_type_under}}</code>'
          nullable: true
        date_posted:
          type: string
          nullable: true
        tag:
          type: string
          description: <em>user-defined task identifier</em>
          nullable: true
        endpoint_regular:
          type: string
          description: '<em>URL for collecting the results of the SERP Regular task</em><br>if SERP Regular is not supported in the specified endpoint, the value will be <code>null</code>'
          nullable: true
        endpoint_advanced:
          type: string
          description: '<em>URL for collecting the results of the SERP Advanced task</em><br>if SERP Advanced is not supported in the specified endpoint, the value will be <code>null</code>'
          nullable: true
        endpoint_html:
          type: string
          description: '<em>URL for collecting the results of the SERP HTML task</em><br>if SERP HTML is not supported in the specified endpoint, the value will be <code>null</code>'
          nullable: true
    SerpNaverOrganicTasksFixedTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpNaverOrganicTasksFixedResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    SerpNaverOrganicTasksFixedResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpNaverOrganicTasksFixedTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    SerpNaverOrganicTaskGetRegularResultInfo:
      type: object
      properties:
        keyword:
          type: string
          description: <em>keyword received in a POST array</em><br><strong>keyword is returned with decoded %## (plus symbol '+' will be decoded to a space character)</strong>
          nullable: true
        type:
          type: string
          description: type of element
          nullable: true
        se_domain:
          type: string
          description: <em>search engine domain in a POST array</em>
          nullable: true
        location_code:
          type: integer
          description: <em>location code in a POST array</em>
          nullable: true
        language_code:
          type: string
          description: <em>language code in a POST array</em>
          nullable: true
        check_url:
          type: string
          description: <em>direct URL to search engine results</em><br>you can use it to make sure that we provided accurate results
          nullable: true
        datetime:
          type: string
          description: '<em>date and time when the result was received</em><br>in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”<br>example:<br><code class="long-string">2019-11-15 12:57:46 +00:00</code>'
          nullable: true
        spell:
          type: object
          oneOf:
            - $ref: '#/components/schemas/SpellInfo'
          description: '<em>autocorrection of the search engine</em><br>if the search engine provided results for a keyword that was corrected, we will specify the keyword corrected by the search engine and the type of autocorrection'
          nullable: true
        refinement_chips:
          type: object
          oneOf:
            - $ref: '#/components/schemas/RefinementChipsInfo'
          description: <em>search refinement chips</em><br>equals <code>null</code>
          nullable: true
        item_types:
          type: array
          items:
            type: string
            nullable: true
          description: '<em>types of search results found in SERP</em><br>contains types of all search results (<code>items</code>) found in the returned SERP<br>possible item types:<br><code>images</code>, <code>local_pack</code>, <code>map</code>, <code>organic</code>, <code>paid</code>, <code>related_searches</code>, <code>video</code><p>note that this array contains all types of search results found in the returned SERP;<br>however, this endpoint provides data for <code>organic</code> and <code>paid</code> types only<p>to get all items (inlcuding SERP features and rich snippets) found in the returned SERP, please refer to the <a href="/v3/serp/naver/organic/task_get/advanced">Naver Organiс Advanced SERP endpoint</a>'
          nullable: true
        se_results_count:
          type: integer
          description: <em>total number of results in SERP</em>
          format: int64
          nullable: true
        pages_count:
          type: integer
          description: <em>total pages retrieved</em><br>total number of retrieved SERPs in the result
          format: int64
          nullable: true
        items_count:
          type: integer
          description: <em>the number of results returned in the <strong><code>items</code></strong> array</em>
          format: int64
          nullable: true
        items:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/BaseSerpApiElementItem'
            nullable: true
          description: <em>items in SERP</em>
          nullable: true
    SerpNaverOrganicTaskGetRegularTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpNaverOrganicTaskGetRegularResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    SerpNaverOrganicTaskGetRegularResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpNaverOrganicTaskGetRegularTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    SerpNaverOrganicTaskGetAdvancedResultInfo:
      type: object
      properties:
        keyword:
          type: string
          description: <em>keyword received in a POST array<br></em><strong>the keyword is returned with decoded %## (plus symbol '+' will be decoded to a space character)</strong>
          nullable: true
        type:
          type: string
          description: type of element
          nullable: true
        se_domain:
          type: string
          description: <em>search engine domain in a POST array</em>
          nullable: true
        location_code:
          type: integer
          description: <em>location code in a POST array</em>
          nullable: true
        language_code:
          type: string
          description: <em>language code in a POST array</em>
          nullable: true
        check_url:
          type: string
          description: <em>direct URL to search engine results</em><br>you can use it to make sure that we provided accurate results
          nullable: true
        datetime:
          type: string
          description: '<em>date and time when the result was received</em><br>in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”<br>example:<br><code class="long-string">2019-11-15 12:57:46 +00:00</code>'
          nullable: true
        spell:
          type: object
          oneOf:
            - $ref: '#/components/schemas/SpellInfo'
          description: '<em>autocorrection of the search engine</em><br>if the search engine provided results for a keyword that was corrected, we will specify the keyword corrected by the search engine and the type of autocorrection'
          nullable: true
        refinement_chips:
          type: object
          oneOf:
            - $ref: '#/components/schemas/RefinementChipsInfo'
          description: <em>search refinement chips</em><br>equals <code>null</code>
          nullable: true
        item_types:
          type: array
          items:
            type: string
            nullable: true
          description: '<em>types of search results in SERP</em><br>contains types of search results (<code>items</code>) found in SERP.<br>possible item types:<br><code>images</code>, <code>local_pack</code>, <code>map</code>, <code>organic</code>, <code>paid</code>, <code>related_searches</code>, <code>video</code>'
          nullable: true
        se_results_count:
          type: integer
          description: <em> total number of results in SERP</em>
          format: int64
          nullable: true
        pages_count:
          type: integer
          description: <em>total pages retrieved</em><br>total number of retrieved SERPs in the result
          format: int64
          nullable: true
        items_count:
          type: integer
          description: <em>the number of results returned in the <strong><code>items</code></strong> array</em>
          format: int64
          nullable: true
        items:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/BaseSerpApiElementItem'
            nullable: true
          description: '<em>additional items present in the element</em><br>if there are none, equals <code>null</code>'
          nullable: true
    SerpNaverOrganicTaskGetAdvancedTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpNaverOrganicTaskGetAdvancedResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    SerpNaverOrganicTaskGetAdvancedResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpNaverOrganicTaskGetAdvancedTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    SerpNaverOrganicTaskGetHtmlResultInfo:
      type: object
      properties:
        keyword:
          type: string
          description: <em>keyword received in a POST array<br></em><strong>keyword is returned with decoded %## (plus symbol '+' will be decoded to a space character)</strong>
          nullable: true
        type:
          type: string
          description: type of element
          nullable: true
        se_domain:
          type: string
          description: <em>search engine domain in a POST array</em>
          nullable: true
        location_code:
          type: integer
          description: <em>location code in a POST array</em>
          nullable: true
        language_code:
          type: string
          description: <em>language code in a POST array</em>
          nullable: true
        datetime:
          type: string
          description: '<em>date and time when the result was received</em><br>in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”<br>example:<br><code class="long-string">2019-11-15 12:57:46 +00:00</code>'
          nullable: true
        items_count:
          type: integer
          description: <em>the number of results returned in the <strong><code>items</code></strong> array</em>
          format: int64
          nullable: true
        items:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/HtmlItemInfo'
            nullable: true
          description: <em>elements of search results found in SERP</em>
          nullable: true
    SerpNaverOrganicTaskGetHtmlTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpNaverOrganicTaskGetHtmlResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    SerpNaverOrganicTaskGetHtmlResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpNaverOrganicTaskGetHtmlTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    SerpSeznamLocationsResultInfo:
      type: object
      properties:
        location_code:
          type: integer
          description: <em>location code</em>
          nullable: true
        location_name:
          type: string
          description: <em>full name of the location</em>
          nullable: true
        location_code_parent:
          type: integer
          description: <em>the code of the superordinate location</em><br>only <code>City</code> <code>location_type</code> is supported for all countries except China (where <code>Country</code> is also supported);<br>don't match locations by <code>location_code_parent</code> because the results for <code>Region</code> and <code>Country</code>-level results for most countries are not supported by Baidu SERP API
          nullable: true
        country_iso_code:
          type: string
          description: <em>ISO country code of the location</em>
          nullable: true
        location_type:
          type: string
          description: <em>location type</em>
          nullable: true
    SerpSeznamLocationsTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpSeznamLocationsResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    SerpSeznamLocationsResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpSeznamLocationsTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    SerpSeznamLocationsCountryResultInfo:
      type: object
      properties:
        location_code:
          type: integer
          description: <em>location code</em>
          nullable: true
        location_name:
          type: string
          description: <em>full name of the location</em>
          nullable: true
        location_code_parent:
          type: integer
          description: <em>the code of the superordinate location</em><br>only <code>City</code> <code>location_type</code> is supported for all countries except China (where <code>Country</code> is also supported);<br>don't match locations by <code>location_code_parent</code> because the results for <code>Region</code> and <code>Country</code>-level results for most countries are not supported by Baidu SERP API
          nullable: true
        country_iso_code:
          type: string
          description: <em>ISO country code of the location</em>
          nullable: true
        location_type:
          type: string
          description: <em>location type</em>
          nullable: true
    SerpSeznamLocationsCountryTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpSeznamLocationsCountryResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    SerpSeznamLocationsCountryResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpSeznamLocationsCountryTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    SerpSeznamLanguagesResultInfo:
      type: object
      properties:
        language_name:
          type: string
          description: <em>language name</em>
          nullable: true
        language_code:
          type: string
          description: <em>language code according to <a href="https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes" target="_blank" rel="noopener noreferrer">ISO 639-1</a></em>
          nullable: true
    SerpSeznamLanguagesTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpSeznamLanguagesResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    SerpSeznamLanguagesResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpSeznamLanguagesTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    SerpSeznamOrganicTaskPostRequestInfo:
      type: object
      properties:
        keyword:
          type: string
          description: '<em>keyword</em><br><strong>required field</strong><br>you can specify <strong>up to 700 characters</strong> in the <code>keyword</code> field<br>all %## will be decoded (plus character ‘+’ will be decoded to a space character)<br>if you need to use the “%” character for your <code>keyword</code>, please specify it as “%25”;<br>if you need to use the “+” character for your <code>keyword</code>, please specify it as “%2B”<p>learn more about rules and limitations of <code>keyword</code> and <code>keywords</code> fields in DataForSEO APIs in this <a href="https://dataforseo.com/help-center/rules-and-limitations-of-keyword-and-keywords-fields-in-dataforseo-apis" rel="noopener noreferrer" target="_blank">Help Center article</a>'
        location_name:
          type: string
          description: '<em>full name of search engine location</em><br><strong>required field if you don''t specify</strong> <code>location_code</code><br><strong>if you use this field, you don''t need to specify <code>location_code</code></strong><br>you can receive the list of available locations of the search engine with their <code>location_name</code> by making a separate request to the <code>https://api.dataforseo.com/v3/serp/{{low_se_name}}/locations</code><br>example:<br><code class="long-string">London,England,United Kingdom</code>'
        location_code:
          type: integer
          description: '<em>search engine location code</em><br><strong>required field if you don''t specify</strong> <code>location_name</code><br><strong>if you use this field, you don''t need to specify <code>location_name</code></strong><br>you can receive the list of available locations of the search engines with their <code>location_code</code> by making a separate request to the <code>https://api.dataforseo.com/v3/serp/{{low_se_name}}/locations</code><br>example:<br><code class="long-string">2840</code>'
        language_name:
          type: string
          description: '<em>full name of search engine language</em><br><strong>required field if you don''t specify</strong> <code>language_code</code><br><strong>if you use this field, you don''t need to specify <code>language_code</code></strong><br>you can receive the list of available languages of the search engine with their <code>language_name</code> by making a separate request to the <code>https://api.dataforseo.com/v3/serp/{{low_se_name}}/languages</code><br>example:<br><code class="long-string">Czech</code>'
        language_code:
          type: string
          description: '<em>search engine language code</em><br><strong>required field if you don''t specify</strong> <code>language_name</code><br><strong>if you use this field, you don''t need to specify <code>language_name</code></strong><br>you can receive the list of available languages of the search engine with their <code>language_code</code>_by making a separate request to the <code>https://api.dataforseo.com/v3/serp/{{low_se_name}}/languages</code><em><br></em>example:<em><br></em><code class="long-string">cs</code>n'
        url:
          type: string
          description: '<em>direct URL of the search query</em><br>optional field<br>you can specify a direct URL and we will sort it out to the necessary fields;<br>note that this method is the most difficult for our API to process and also requires you to specify the exact language and location in the URL;<br>in most cases, we wouldn’t recommend using this method.'
          nullable: true
        priority:
          type: integer
          description: <em>task priority</em><br>optional field<br>can take the following values:<br>1 – normal execution priority (set by default)<br>2 – high execution priority<br>You will be additionally charged for the tasks with high execution priority.<br>The cost can be calculated on the <a title="Pricing" href="https://dataforseo.com/pricing/serp/seznam-organic-serp-api" target="_blank" rel="noopener noreferrer">Pricing</a> page.
          nullable: true
        depth:
          type: integer
          description: '<em>parsing depth</em><br>optional field<br>number of results in SERP<br>default value: <code>10</code>;<br>maximum value: <code>500</code>;<br><strong>Your account will be billed per each SERP containing up to 10 results;</strong> <br>Setting depth above 10 may result in additional charges <a href="https://dataforseo.com/help-center/how-many-results-scraped" rel="noopener noreferrer" target="_blank">if the search engine returns more than 10 results</a>;<br>The cost can be calculated on the <a title="Pricing" href="https://dataforseo.com/pricing/serp/seznam-organic-serp-api" target="_blank" rel="noopener noreferrer">Pricing</a> page.'
          nullable: true
        max_crawl_pages:
          type: integer
          description: '<em>page crawl limit</em><br>optional field<br>number of search results pages to crawl<br>default value: <code>1</code><br>max value: <code>10</code><br><strong>Note:</strong> the <code>max_crawl_pages</code> and <code>depth</code> parameters complement each other;<br>learn more at <a href="https://dataforseo.com/help-center/what-is-max-crawl-pages-and-how-does-it-work" target="_blank" rel="noopener noreferrer">our help center</a>'
          nullable: true
        device:
          type: string
          description: '<em>device type</em><br>optional field<br>return results for a specific device type<br>can take the values:<code>desktop</code>, <code>mobile</code><br>default value: <code>desktop</code>'
          nullable: true
        os:
          type: string
          description: '<em>device operating system</em><br>optional field<br>if you specify <code>desktop</code> in the <code>device</code> field, choose from the following values: <code>windows</code>, <code>macos</code><br>default value: <code>windows</code><br>if you specify <code>mobile</code> in the <code>device</code> field, choose from the following values: <code>android</code>, <code>ios</code><br>default value: <code>android</code>'
          nullable: true
        se_domain:
          type: string
          description: '<em>search engine domain</em><br>optional field<br>we choose the relevant search engine domain automatically<br>however, you can set a custom search engine domain in this field<br>example:<br><code><code></code></code><em>search.seznam.cz</em>'
          nullable: true
        search_param:
          type: string
          description: <em>additional parameters of the search query</em><br>optional field
          nullable: true
        calculate_rectangles:
          type: boolean
          description: '<em>calculate pixel rankings for SERP elements in advanced results</em><br>optional field<br>pixel ranking refers to the distance between the result snippet and top left corner of the screen;<br><a href="https://dataforseo.com/help-center/pixel-ranking-in-serp-api">Visit Help Center to learn more&gt;&gt;</a><br>by default, the parameter is set to <code>false</code><br><strong>Note:</strong> if set to <code>true</code>, the charge per task will be multiplied by 2'
          nullable: true
        stop_crawl_on_match:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/SerpApiStopCrawlOnMatchInfo'
            nullable: true
          description: "array of targets to stop crawling\noptional field\nif specified, the response will contain SERP results up to and including the specified match_value;\nyou can specify up to 10 target values in this array\nexample:\n\"stop_crawl_on_match\":[{\"match_value\":\"dataforseo.com\",\"match_type\":\"with_subdomains\"}]\nlearn more about this parameter on our Help Center - https://dataforseo.com/help-center/using-the-stop_crawl_on_match-parameter-in-serp-api\nYour account will be billed per each SERP crawled through the specified targets"
          nullable: true
        tag:
          type: string
          description: <em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response
          nullable: true
        postback_url:
          type: string
          description: '<em>URL for sending task results</em><br>optional field<br>once the task is completed, we will send a POST request with its results compressed in the <code>gzip</code> format to the <code>postback_url</code> you specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/postbackscript?id=$id</code><br><code>http://your-server.com/postbackscript?id=$id&amp;tag=$tag</code><br><strong>Note:</strong> special characters in <code>postback_url</code> will be urlencoded;<br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href="https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api" target="_blank" rel="noopener noreferrer">Help Center</a>'
          nullable: true
        postback_data:
          type: string
          description: '<em>postback_url datatype</em><br><strong>required field if you specify <code>postback_url</code></strong><br>corresponds to the function you used for setting a task<br>possible values:<br><code>regular</code>, <code>advanced</code>, <code>html</code>'
        pingback_url:
          type: string
          description: '<em>notification URL of a completed task</em><br>optional field<br>when a task is completed we will notify you by GET request sent to the URL you have specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/pingscript?id=$id</code><br><code>http://your-server.com/pingscript?id=$id&amp;tag=$tag</code><br><strong>Note:</strong> special characters in <code>pingback_url</code> will be urlencoded;<br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href="https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api" target="_blank" rel="noopener noreferrer">Help Center</a>'
          nullable: true
      example:
        - language_code: cs
          location_code: 2203
          keyword: albert einstein
    SerpSeznamOrganicTaskPostTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: object
              description: '<em>array of results</em><br>in this case, the value will be <code>null</code>'
              nullable: true
    SerpSeznamOrganicTaskPostResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpSeznamOrganicTaskPostTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    SerpSeznamOrganicTasksReadyResultInfo:
      type: object
      properties:
        id:
          type: string
          description: <em>task identifier of the completed task</em><br><strong>unique task identifier in our system in the <a href="https://en.wikipedia.org/wiki/Universally_unique_identifier">UUID</a> format</strong>
          nullable: true
        se:
          type: string
          description: <em>search engine specified when setting the task</em>
          nullable: true
        se_type:
          type: string
          description: '<em>type of search engine</em><br>example: <code>{{low_se_type_under}}</code>'
          nullable: true
        date_posted:
          type: string
          description: <em>date when the task was posted (in the UTC format)</em>
          nullable: true
        tag:
          type: string
          description: <em>user-defined task identifier</em>
          nullable: true
        endpoint_regular:
          type: string
          description: '<em>URL for collecting the results of the SERP Regular task</em><br>if SERP Regular is not supported in the specified endpoint, the value will be <code>null</code>'
          nullable: true
        endpoint_advanced:
          type: string
          description: '<em>URL for collecting the results of the SERP Advanced task</em><br>if SERP Advanced is not supported in the specified endpoint, the value will be <code>null</code>'
          nullable: true
        endpoint_html:
          type: string
          description: '<em>URL for collecting the results of the SERP HTML task</em><br>if SERP HTML is not supported in the specified endpoint, the value will be <code>null</code>'
          nullable: true
    SerpSeznamOrganicTasksReadyTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpSeznamOrganicTasksReadyResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    SerpSeznamOrganicTasksReadyResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpSeznamOrganicTasksReadyTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    SerpSeznamOrganicTasksFixedResultInfo:
      type: object
      properties:
        id:
          type: string
          description: <em>task identifier of the completed task</em><br><strong>unique task identifier in our system in the <a href="https://en.wikipedia.org/wiki/Universally_unique_identifier">UUID</a> format</strong>
          nullable: true
        se:
          type: string
          description: <em>search engine specified when setting the task</em>
          nullable: true
        se_type:
          type: string
          description: '<em>type of search engine</em><br>can take the following values: <code>{{low_se_type_under}}</code>'
          nullable: true
        date_posted:
          type: string
          nullable: true
        tag:
          type: string
          description: <em>user-defined task identifier</em>
          nullable: true
        endpoint_regular:
          type: string
          description: '<em>URL for collecting the results of the SERP Regular task</em><br>if SERP Regular is not supported in the specified endpoint, the value will be <code>null</code>'
          nullable: true
        endpoint_advanced:
          type: string
          description: '<em>URL for collecting the results of the SERP Advanced task</em><br>if SERP Advanced is not supported in the specified endpoint, the value will be <code>null</code>'
          nullable: true
        endpoint_html:
          type: string
          description: '<em>URL for collecting the results of the SERP HTML task</em><br>if SERP HTML is not supported in the specified endpoint, the value will be <code>null</code>'
          nullable: true
    SerpSeznamOrganicTasksFixedTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpSeznamOrganicTasksFixedResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    SerpSeznamOrganicTasksFixedResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpSeznamOrganicTasksFixedTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    SerpSeznamOrganicTaskGetRegularResultInfo:
      type: object
      properties:
        keyword:
          type: string
          description: <em>keyword received in a POST array</em><br><strong>keyword is returned with decoded %## (plus symbol '+' will be decoded to a space character)</strong>
          nullable: true
        type:
          type: string
          description: type of element
          nullable: true
        se_domain:
          type: string
          description: <em>search engine domain in a POST array</em>
          nullable: true
        location_code:
          type: integer
          description: <em>location code in a POST array</em>
          nullable: true
        language_code:
          type: string
          description: <em>language code in a POST array</em>
          nullable: true
        check_url:
          type: string
          description: <em>direct URL to search engine results</em><br>you can use it to make sure that we provided accurate results
          nullable: true
        datetime:
          type: string
          description: '<em>date and time when the result was received</em><br>in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”<br>example:<br><code class="long-string">2019-11-15 12:57:46 +00:00</code>'
          nullable: true
        spell:
          type: object
          oneOf:
            - $ref: '#/components/schemas/SpellInfo'
          description: '<em>autocorrection of the search engine</em><br>if the search engine provided results for a keyword that was corrected, we will specify the keyword corrected by the search engine and the type of autocorrection'
          nullable: true
        refinement_chips:
          type: object
          oneOf:
            - $ref: '#/components/schemas/RefinementChipsInfo'
          description: <em>search refinement chips</em><br>equals <code>null</code>
          nullable: true
        item_types:
          type: array
          items:
            type: string
            nullable: true
          description: '<em>types of search results found in SERP</em><br>contains types of all search results (<code>items</code>) found in the returned SERP<br>possible item types:<br><code>images</code>, <code>local_pack</code>, <code>organic</code>, <code>related_searches</code>, <code>top_stories</code>, <code>featured_snippet</code>, <code>video</code><p>note that this array contains all types of search results found in the returned SERP;<br>however, <strong>this endpoint provides data for the <code>organic</code> type only</strong><p>to get all items (inlcuding SERP features and rich snippets) found in the returned SERP, please refer to the <a href="/v3/serp/seznam/organic/task_get/advanced">Seznam Organiс Advanced SERP endpoint</a>'
          nullable: true
        se_results_count:
          type: integer
          description: <em>total number of results in SERP</em>
          format: int64
          nullable: true
        pages_count:
          type: integer
          description: <em>total pages retrieved</em><br>total number of retrieved SERPs in the result
          format: int64
          nullable: true
        items_count:
          type: integer
          description: <em>the number of results returned in the <strong><code>items</code></strong> array</em>
          format: int64
          nullable: true
        items:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/BaseSerpApiElementItem'
            nullable: true
          description: <em>items in SERP</em>
          nullable: true
    SerpSeznamOrganicTaskGetRegularTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpSeznamOrganicTaskGetRegularResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    SerpSeznamOrganicTaskGetRegularResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpSeznamOrganicTaskGetRegularTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    SerpSeznamOrganicTaskGetAdvancedResultInfo:
      type: object
      properties:
        keyword:
          type: string
          description: <em>keyword received in a POST array<br></em><strong>the keyword is returned with decoded %## (plus symbol '+' will be decoded to a space character)</strong>
          nullable: true
        type:
          type: string
          description: type of element
          nullable: true
        se_domain:
          type: string
          description: <em>search engine domain in a POST array</em>
          nullable: true
        location_code:
          type: integer
          description: <em>location code in a POST array</em>
          nullable: true
        language_code:
          type: string
          description: <em>language code in a POST array</em>
          nullable: true
        check_url:
          type: string
          description: <em>direct URL to search engine results</em><br>you can use it to make sure that we provided accurate results
          nullable: true
        datetime:
          type: string
          description: '<em>date and time when the result was received</em><br>in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”<br>example:<br><code class="long-string">2019-11-15 12:57:46 +00:00</code>'
          nullable: true
        spell:
          type: object
          oneOf:
            - $ref: '#/components/schemas/SpellInfo'
          description: '<em>autocorrection of the search engine</em><br>if the search engine provided results for a keyword that was corrected, we will specify the keyword corrected by the search engine and the type of autocorrection'
          nullable: true
        refinement_chips:
          type: object
          oneOf:
            - $ref: '#/components/schemas/RefinementChipsInfo'
          description: <em>search refinement chips</em><br>equals <code>null</code>
          nullable: true
        item_types:
          type: array
          items:
            type: string
            nullable: true
          description: '<em>types of search results in SERP</em><br>contains types of search results (<code>items</code>) found in SERP.<br>possible item types:<br><a href="#images"><code>images</code></a>, <a href="#local_pack"><code>local_pack</code></a>, <a href="#organic"><code>organic</code></a>, <a href="#related_searches"><code>related_searches</code></a>, <a href="#top_stories"><code>top_stories</code></a>, <a href="#featured_snippet"><code>featured_snippet</code></a>, <a href="#video"><code>video</code></a>, <a href="#shopping"><code>shopping</code></a>'
          nullable: true
        se_results_count:
          type: integer
          description: <em> total number of results in SERP</em>
          format: int64
          nullable: true
        pages_count:
          type: integer
          description: <em>total pages retrieved</em><br>total number of retrieved SERPs in the result
          format: int64
          nullable: true
        items_count:
          type: integer
          description: <em>the number of results returned in the <strong><code>items</code></strong> array</em>
          format: int64
          nullable: true
        items:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/BaseSerpApiElementItem'
            nullable: true
          description: '<em>additional items present in the element</em><br>if there are none, equals <code>null</code>'
          nullable: true
    SerpSeznamOrganicTaskGetAdvancedTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpSeznamOrganicTaskGetAdvancedResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    SerpSeznamOrganicTaskGetAdvancedResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpSeznamOrganicTaskGetAdvancedTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    SerpSeznamOrganicTaskGetHtmlResultInfo:
      type: object
      properties:
        keyword:
          type: string
          description: <em>keyword received in a POST array<br></em><strong>keyword is returned with decoded %## (plus symbol '+' will be decoded to a space character)</strong>
          nullable: true
        type:
          type: string
          description: type of element
          nullable: true
        se_domain:
          type: string
          description: <em>search engine domain in a POST array</em>
          nullable: true
        location_code:
          type: integer
          description: <em>location code in a POST array</em>
          nullable: true
        language_code:
          type: string
          description: <em>language code in a POST array</em>
          nullable: true
        datetime:
          type: string
          description: '<em>date and time when the result was received</em><br>in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”<br>example:<br><code class="long-string">2019-11-15 12:57:46 +00:00</code>'
          nullable: true
        items_count:
          type: integer
          description: <em>the number of results returned in the <strong><code>items</code></strong> array</em>
          format: int64
          nullable: true
        items:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/HtmlItemInfo'
            nullable: true
          description: <em>elements of search results found in SERP</em>
          nullable: true
    SerpSeznamOrganicTaskGetHtmlTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpSeznamOrganicTaskGetHtmlResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    SerpSeznamOrganicTaskGetHtmlResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpSeznamOrganicTaskGetHtmlTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    SerpGoogleFinanceExploreTaskPostRequestInfo:
      type: object
      properties:
        location_code:
          type: integer
          description: '<p><em>search engine location code</em><p><strong>required field if you don''t specify <code>location_name</code></strong><p><strong>if you use this field, you don''t need to specify <code>location_name</code></strong><p>you can receive the list of available locations of the search engines with their <code>location_code</code> by making a separate request to <code>https://api.dataforseo.com/v3/serp/google/locations</code><p>example:<p><code class="long-string">2840</code></p>'
        language_code:
          type: string
          description: '<p><em>search engine language code</em><p><strong>required field if you don''t specify <code>language_name</code></strong><p><strong>if you use this field, you don''t need to specify <code>language_name</code></strong><p>you can receive the list of available languages of the search engine with their <code>language_code</code>&nbsp;by making a separate request to the <code>https://api.dataforseo.com/v3/serp/google/languages</code><em><p></em>example:<em><p></em><code class="long-string">en</code></p>'
        device:
          type: string
          description: '<p><em>device type</em><p>optional field<p>return results for a specific device type<p>possible value: <code>desktop</code></p>'
          nullable: true
        pingback_url:
          type: string
          description: '<p><em>notification URL of a completed task</em><p>optional field<p>when a task is completed we will notify you by GET request sent to the URL you have specified<p>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<p>example:<p><code>http://your-server.com/pingscript?id=$id</code><p><code>http://your-server.com/pingscript?id=$id&amp;tag=$tag</code><p><strong>Note:</strong> special characters in <code>pingback_url</code> will be urlencoded;<p>i.a., the <code>#</code> character will be encoded into <code>%23</code></p><br><p>learn more on our <a href="https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api" target="_blank" rel="noopener noreferrer">Help Center</a></p>'
          nullable: true
        postback_url:
          type: string
          description: '<p><em>URL for sending task results</em><p>optional field<p>once the task is completed, we will send a POST request with its results compressed in the <code>gzip</code> format to the <code>postback_url</code> you specified<p>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request<p>example:<p><code>http://your-server.com/postbackscript?id=$id</code><p><code>http://your-server.com/postbackscript?id=$id&amp;tag=$tag</code><p><strong>Note:</strong> special characters in <code>postback_url</code> will be urlencoded;<p>i.a., the <code>#</code> character will be encoded into <code>%23</code></p><br><p>learn more on our <a href="https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api" target="_blank" rel="noopener noreferrer">Help Center</a></p>'
          nullable: true
        postback_data:
          type: string
          description: '<p><em>postback_url datatype</em><p><strong>required field if you specify <code>postback_url</code></strong><p>corresponds to the datatype that will be sent to your server<p>possible values:: <code>advanced</code>, <code>html</code></p>'
        priority:
          type: integer
          description: <p><em>task priority</em><p>optional field<p>can take the following values:<p>1 – normal execution priority (set by default);<p>2 – high execution priority</p><br>You will be additionally charged for the tasks with high execution priority;<p>The cost can be calculated on the <a title="Pricing" href="https://dataforseo.com/pricing/serp/google-finance-serp-api" target="_blank" rel="noopener noreferrer">Pricing</a> page
          nullable: true
        location_name:
          type: string
          description: '<p><em>full name of search engine location</em><p><strong>required field if you don''t specify <code>location_code</code></strong><p><strong>if you use this field, you don''t need to specify <code>location_code</code></strong><p>you can receive the list of available locations of the search engine with their <code>location_name</code> by making a separate request to  <code>https://api.dataforseo.com/v3/serp/google/locations</code><p>example:<p><code class="long-string">London,England,United Kingdom</code></p>'
        language_name:
          type: string
          description: '<p><em>full name of search engine language</em><p><strong>required field if you don''t specify <code>language_code</code> </strong><p><strong>if you use this field, you don''t need to specify <code>language_code</code></strong><p>you can receive the list of available languages of the search engine with their <code>language_name</code> by making a separate request to the <code>https://api.dataforseo.com/v3/serp/google/languages</code><p>example:<p><code class="long-string">English</code></p>'
        os:
          type: string
          description: '<p><em>device operating system</em><p>optional field<p>possible values: <code>windows</code></p>'
          nullable: true
        tag:
          type: string
          description: <p><em>user-defined task identifier</em><p>optional field<p><em>the character limit is 255</em><p>you can use this parameter to identify the task and match it with the result<p>you will find the specified <code>tag</code> value in the <code>data</code> object of the response</p>
          nullable: true
        news_type:
          type: string
          description: '<p><em>financial news filters</em><p>optional field<p>possible values: <code>top_stories</code>, <code>local_market</code>, <code>world_markets</code><p>default value: <code>top_stories</code><p><strong>Note:</strong> if you specify <code>local_market</code> or <code>world_markets</code>, the charge per task will be multiplied by 2</p>'
          nullable: true
      example:
        - location_code: 2840
          language_name: English
    SerpGoogleFinanceExploreTaskPostTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: object
              description: '<em>array of results</em><br>in this case, the value will be <code>null</code>'
              nullable: true
    SerpGoogleFinanceExploreTaskPostResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleFinanceExploreTaskPostTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    SerpGoogleFinanceExploreTasksReadyResultInfo:
      type: object
      properties:
        id:
          type: string
          description: <em>task identifier of the completed task</em><br><strong>unique task identifier in our system in the <a href="https://en.wikipedia.org/wiki/Universally_unique_identifier">UUID</a> format</strong>
          nullable: true
        se:
          type: string
          description: <em>search engine specified when setting the task</em>
          nullable: true
        se_type:
          type: string
          description: '<em>type of search engine</em><br>example: <code>{{low_se_type_under}}</code>'
          nullable: true
        date_posted:
          type: string
          description: <em>date when the task was posted (in the UTC format)</em>
          nullable: true
        tag:
          type: string
          description: <em>user-defined task identifier</em>
          nullable: true
        endpoint_regular:
          type: string
          description: '<em>URL for collecting the results of the SERP Regular task</em><br>if SERP Regular is not supported in the specified endpoint, the value will be <code>null</code>'
          nullable: true
        endpoint_advanced:
          type: string
          description: '<em>URL for collecting the results of the SERP Advanced task</em><br>if SERP Advanced is not supported in the specified endpoint, the value will be <code>null</code>'
          nullable: true
        endpoint_html:
          type: string
          description: '<em>URL for collecting the results of the SERP HTML task</em><br>if SERP HTML is not supported in the specified endpoint, the value will be <code>null</code>'
          nullable: true
    SerpGoogleFinanceExploreTasksReadyTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleFinanceExploreTasksReadyResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    SerpGoogleFinanceExploreTasksReadyResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleFinanceExploreTasksReadyTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    SerpApiGoogleFinanceAssetPairElementElementItem:
      type: object
      allOf:
        - type: object
          oneOf:
            - $ref: '#/components/schemas/BaseSerpApiGoogleFinanceElementItem'
          nullable: true
        - type: object
          properties:
            base_symbol:
              type: string
              description: '<em>identifier of the base asset in a pair</em><br>example: <code>EUR</code>'
              nullable: true
            quote_symbol:
              type: string
              description: '<em>identifier of the quote asset in a pair</em><br>example: <code>USD</code>'
              nullable: true
            base_display_name:
              type: string
              description: '<em>full name of the base asset in a pair</em><br>example: <code>Euro</code>'
              nullable: true
            quote_display_name:
              type: string
              description: '<em>full name of the base asset in a pair</em><br>example: <code>Euro</code>'
              nullable: true
            price:
              type: number
              description: <em>value of the base asset compared to the quote asset</em>
              nullable: true
            price_delta:
              type: number
              description: <em>change in price</em><br>change in <code>price</code> at a given <code>timestamp</code>
              nullable: true
            identifier:
              type: string
              description: '<em>identifier of the element</em><br>full identifier of the element that consists from <code>ticker</code> and <code>market_identifier</code><br>example: <code>PX1:INDEXDB</code>'
              nullable: true
            displayed_name:
              type: string
              description: '<em>name of the market index as displayed on Google Finance</em><br>example: <code>CAC 40</code>'
              nullable: true
            url:
              type: string
              description: <em>URL to the page of the market index on Google Finance</em>
              nullable: true
            location:
              type: string
              description: '<em>location of the market index</em><br>example: <code>Europe/Paris</code>'
              nullable: true
            trend:
              type: string
              description: '<em>growth trend of the market index</em><br>possible values: <code>up</code>, <code>down</code>, <code>stable</code>'
              nullable: true
            timestamp:
              type: string
              description: '<em>date and time of the value readout</em><br>in the UTC format: "yyyy-mm-dd hh-mm-ss +00:00"<br>example:<br><code class="long-string">2025-02-10 09:40:00 +00:00</code>'
              nullable: true
            percentage_delta:
              type: number
              description: <em>percentage of change in value of the market index</em>
              nullable: true
    SerpApiGoogleFinanceMarketIndexElementElementItem:
      type: object
      allOf:
        - type: object
          oneOf:
            - $ref: '#/components/schemas/BaseSerpApiGoogleFinanceElementItem'
          nullable: true
        - type: object
          properties:
            ticker:
              type: string
              description: '<em>ticker of the market index</em><br>example: <code>DAX</code>'
              nullable: true
            market_identifier:
              type: string
              description: '<em>market identifier</em><br>example: <code>INDEXDB</code>'
              nullable: true
            index_value:
              type: number
              description: <em>value of the market index</em><br>numerical value of the index at a given <code>timestamp</code>
              nullable: true
            index_value_delta:
              type: number
              description: <em>change in value of the market index</em><br>change in the <code>index_value</code> at a given <code>timestamp</code>
              nullable: true
            identifier:
              type: string
              description: '<em>identifier of the element</em><br>full identifier of the element that consists from <code>ticker</code> and <code>market_identifier</code><br>example: <code>PX1:INDEXDB</code>'
              nullable: true
            displayed_name:
              type: string
              description: '<em>name of the market index as displayed on Google Finance</em><br>example: <code>CAC 40</code>'
              nullable: true
            url:
              type: string
              description: <em>URL to the page of the market index on Google Finance</em>
              nullable: true
            location:
              type: string
              description: '<em>location of the market index</em><br>example: <code>Europe/Paris</code>'
              nullable: true
            trend:
              type: string
              description: '<em>growth trend of the market index</em><br>possible values: <code>up</code>, <code>down</code>, <code>stable</code>'
              nullable: true
            timestamp:
              type: string
              description: '<em>date and time of the value readout</em><br>in the UTC format: "yyyy-mm-dd hh-mm-ss +00:00"<br>example:<br><code class="long-string">2025-02-10 09:40:00 +00:00</code>'
              nullable: true
            percentage_delta:
              type: number
              description: <em>percentage of change in value of the market index</em>
              nullable: true
    SerpApiGoogleFinanceMarketInstrumentElementElementItem:
      type: object
      allOf:
        - type: object
          oneOf:
            - $ref: '#/components/schemas/BaseSerpApiGoogleFinanceElementItem'
          nullable: true
        - type: object
          properties:
            ticker:
              type: string
              description: '<em>ticker of the market index</em><br>example: <code>DAX</code>'
              nullable: true
            price:
              type: number
              description: <em>value of the base asset compared to the quote asset</em>
              nullable: true
            price_delta:
              type: number
              description: <em>change in price</em><br>change in <code>price</code> at a given <code>timestamp</code>
              nullable: true
            price_currency:
              type: string
              description: '<em>price currency</em><br>example: <code>USD</code>'
              nullable: true
            identifier:
              type: string
              description: '<em>identifier of the element</em><br>full identifier of the element that consists from <code>ticker</code> and <code>market_identifier</code><br>example: <code>PX1:INDEXDB</code>'
              nullable: true
            displayed_name:
              type: string
              description: '<em>name of the market index as displayed on Google Finance</em><br>example: <code>CAC 40</code>'
              nullable: true
            url:
              type: string
              description: <em>URL to the page of the market index on Google Finance</em>
              nullable: true
            location:
              type: string
              description: '<em>location of the market index</em><br>example: <code>Europe/Paris</code>'
              nullable: true
            trend:
              type: string
              description: '<em>growth trend of the market index</em><br>possible values: <code>up</code>, <code>down</code>, <code>stable</code>'
              nullable: true
            timestamp:
              type: string
              description: '<em>date and time of the value readout</em><br>in the UTC format: "yyyy-mm-dd hh-mm-ss +00:00"<br>example:<br><code class="long-string">2025-02-10 09:40:00 +00:00</code>'
              nullable: true
            percentage_delta:
              type: number
              description: <em>percentage of change in value of the market index</em>
              nullable: true
    Markets:
      type: object
      properties:
        market:
          type: string
          description: '<em>financial market identifier</em><br>possible values: <code>US</code>, <code>Europe</code>, <code>Asia</code>, <code>Currencies</code>, <code>Crypto</code>, <code>Futures</code>'
          nullable: true
        items:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/BaseSerpApiGoogleFinanceElementItem'
            nullable: true
          description: <em>elements of search results found in SERP</em>
          nullable: true
    SerpApiGoogleFinanceHeroGroupsElementItem:
      type: object
      allOf:
        - type: object
          oneOf:
            - $ref: '#/components/schemas/BaseSerpApiGoogleFinanceElementItem'
          nullable: true
        - type: object
          properties:
            rank_group:
              type: integer
              description: <em>group rank in SERP</em><br>position within a group of elements with identical <code>type</code> values<br>positions of elements with different <code>type</code> values are omitted from <code>rank_group</code>
              nullable: true
            rank_absolute:
              type: integer
              description: <em>absolute rank in SERP</em><br>absolute position among all the elements in SERP
              nullable: true
            markets:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/Markets'
                nullable: true
              description: <em>financial markets data</em><br>array of items containing market indexes and other financial information related to these indexes
              nullable: true
    SerpApiGoogleFinanceInterestedElementItem:
      type: object
      allOf:
        - type: object
          oneOf:
            - $ref: '#/components/schemas/BaseSerpApiGoogleFinanceElementItem'
          nullable: true
        - type: object
          properties:
            rank_group:
              type: integer
              description: <em>group rank in SERP</em><br>position within a group of elements with identical <code>type</code> values<br>positions of elements with different <code>type</code> values are omitted from <code>rank_group</code>
              nullable: true
            rank_absolute:
              type: integer
              description: <em>absolute rank in SERP</em><br>absolute position among all the elements in SERP
              nullable: true
            items:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/BaseSerpApiGoogleFinanceElementItem'
                nullable: true
              description: '<em>market indexes data</em><br>array of items containing market indexes data;<br>possible <code>type</code> of items: <code>google_finance_asset_pair_element</code>, <code>google_finance_market_instrument_element</code>, <code>google_finance_market_index_element</code>'
              nullable: true
    GoogleFinanceNewsElement:
      type: object
      properties:
        type:
          type: string
          description: type of element
          nullable: true
        title:
          type: string
          description: <em>title of the news article</em>
          nullable: true
        url:
          type: string
          description: <em>URL to the page of the market index on Google Finance</em>
          nullable: true
        source:
          type: string
          description: <em>name of the news source</em><br>name of the website where the news article is published
          nullable: true
        image_url:
          type: string
          description: <em>featured image URL</em><br>URL of the news article's featured image
          nullable: true
        timestamp:
          type: string
          description: '<em>date and time of the value readout</em><br>in the UTC format: "yyyy-mm-dd hh-mm-ss +00:00"<br>example:<br><code class="long-string">2025-02-10 09:40:00 +00:00</code>'
          nullable: true
        quotes:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/BaseSerpApiGoogleFinanceElementItem'
            nullable: true
          description: <em>market indexes quoted in the news article</em><br>information about market indexes quoted in the <code>google_finance_news_element</code>
          nullable: true
    SerpApiGoogleFinanceNewsElementItem:
      type: object
      allOf:
        - type: object
          oneOf:
            - $ref: '#/components/schemas/BaseSerpApiGoogleFinanceElementItem'
          nullable: true
        - type: object
          properties:
            rank_group:
              type: integer
              description: <em>group rank in SERP</em><br>position within a group of elements with identical <code>type</code> values<br>positions of elements with different <code>type</code> values are omitted from <code>rank_group</code>
              nullable: true
            rank_absolute:
              type: integer
              description: <em>absolute rank in SERP</em><br>absolute position among all the elements in SERP
              nullable: true
            title:
              type: string
              description: '<em>title of the news element</em><br>example: <code>In the news</code>'
              nullable: true
            sub_title:
              type: string
              description: '<em>sub-title of the news element</em><br>example: <code>Based on Europe, Middle East, and Africa</code>'
              nullable: true
            items:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/GoogleFinanceNewsElement'
                nullable: true
              description: '<em>market indexes data</em><br>array of items containing market indexes data;<br>possible <code>type</code> of items: <code>google_finance_asset_pair_element</code>, <code>google_finance_market_instrument_element</code>, <code>google_finance_market_index_element</code>'
              nullable: true
    GoogleFinanceEarningsCalendarElement:
      type: object
      properties:
        type:
          type: string
          description: type of element
          nullable: true
        title:
          type: string
          description: <em>title of the news article</em>
          nullable: true
        url:
          type: string
          description: <em>URL to the page of the market index on Google Finance</em>
          nullable: true
        timestamp:
          type: string
          description: '<em>date and time of the value readout</em><br>in the UTC format: "yyyy-mm-dd hh-mm-ss +00:00"<br>example:<br><code class="long-string">2025-02-10 09:40:00 +00:00</code>'
          nullable: true
    SerpApiGoogleFinanceEarningsCalendarElementItem:
      type: object
      allOf:
        - type: object
          oneOf:
            - $ref: '#/components/schemas/BaseSerpApiGoogleFinanceElementItem'
          nullable: true
        - type: object
          properties:
            rank_group:
              type: integer
              description: <em>group rank in SERP</em><br>position within a group of elements with identical <code>type</code> values<br>positions of elements with different <code>type</code> values are omitted from <code>rank_group</code>
              nullable: true
            rank_absolute:
              type: integer
              description: <em>absolute rank in SERP</em><br>absolute position among all the elements in SERP
              nullable: true
            items:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/GoogleFinanceEarningsCalendarElement'
                nullable: true
              description: '<em>market indexes data</em><br>array of items containing market indexes data;<br>possible <code>type</code> of items: <code>google_finance_asset_pair_element</code>, <code>google_finance_market_instrument_element</code>, <code>google_finance_market_index_element</code>'
              nullable: true
    SerpApiGoogleFinanceMostFollowedElementItem:
      type: object
      allOf:
        - type: object
          oneOf:
            - $ref: '#/components/schemas/BaseSerpApiGoogleFinanceElementItem'
          nullable: true
        - type: object
          properties:
            rank_group:
              type: integer
              description: <em>group rank in SERP</em><br>position within a group of elements with identical <code>type</code> values<br>positions of elements with different <code>type</code> values are omitted from <code>rank_group</code>
              nullable: true
            rank_absolute:
              type: integer
              description: <em>absolute rank in SERP</em><br>absolute position among all the elements in SERP
              nullable: true
            items:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/BaseSerpApiGoogleFinanceElementItem'
                nullable: true
              description: '<em>market indexes data</em><br>array of items containing market indexes data;<br>possible <code>type</code> of items: <code>google_finance_asset_pair_element</code>, <code>google_finance_market_instrument_element</code>, <code>google_finance_market_index_element</code>'
              nullable: true
    GoogleFinanceMarketTrendsElement:
      type: object
      properties:
        type:
          type: string
          description: type of element
          nullable: true
        quote:
          type: object
          oneOf:
            - $ref: '#/components/schemas/BaseSerpApiGoogleFinanceElementItem'
          description: '<em>object of items</em><br>array contains the following <code>type</code> of items: <code>google_finance_asset_pair_element</code>, <code>google_finance_market_instrument_element</code>, <code>google_finance_market_index_element</code>'
          nullable: true
        news:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/GoogleFinanceNewsElement'
            nullable: true
          description: '<em>array of items</em><br>array contains the following <code>type</code> of items: <code>google_finance_news_element</code>'
          nullable: true
    SerpGoogleFinanceExploreAdvancedItem:
      type: object
      properties:
        most_active:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/GoogleFinanceMarketTrendsElement'
            nullable: true
          description: '<em>array of items</em><br>this array can take the following names: <code>most_active</code>, <code>gainers</code>, <code>losers</code>'
          nullable: true
        gainers:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/GoogleFinanceMarketTrendsElement'
            nullable: true
          nullable: true
        losers:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/GoogleFinanceMarketTrendsElement'
            nullable: true
          nullable: true
    SerpApiGoogleFinanceMarketTrendsElementItem:
      type: object
      allOf:
        - type: object
          oneOf:
            - $ref: '#/components/schemas/BaseSerpApiGoogleFinanceElementItem'
          nullable: true
        - type: object
          properties:
            rank_group:
              type: integer
              description: <em>group rank in SERP</em><br>position within a group of elements with identical <code>type</code> values<br>positions of elements with different <code>type</code> values are omitted from <code>rank_group</code>
              nullable: true
            rank_absolute:
              type: integer
              description: <em>absolute rank in SERP</em><br>absolute position among all the elements in SERP
              nullable: true
            items:
              type: object
              oneOf:
                - $ref: '#/components/schemas/SerpGoogleFinanceExploreAdvancedItem'
              description: '<em>market indexes data</em><br>array of items containing market indexes data;<br>possible <code>type</code> of items: <code>google_finance_asset_pair_element</code>, <code>google_finance_market_instrument_element</code>, <code>google_finance_market_index_element</code>'
              nullable: true
    SerpApiGoogleFinancePeopleAlsoSearchElementItem:
      type: object
      allOf:
        - type: object
          oneOf:
            - $ref: '#/components/schemas/BaseSerpApiGoogleFinanceElementItem'
          nullable: true
        - type: object
          properties:
            rank_group:
              type: integer
              description: <em>group rank in SERP</em><br>position within a group of elements with identical <code>type</code> values<br>positions of elements with different <code>type</code> values are omitted from <code>rank_group</code>
              nullable: true
            rank_absolute:
              type: integer
              description: <em>absolute rank in SERP</em><br>absolute position among all the elements in SERP
              nullable: true
            items:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/BaseSerpApiGoogleFinanceElementItem'
                nullable: true
              description: '<em>market indexes data</em><br>array of items containing market indexes data;<br>possible <code>type</code> of items: <code>google_finance_asset_pair_element</code>, <code>google_finance_market_instrument_element</code>, <code>google_finance_market_index_element</code>'
              nullable: true
    SerpGoogleFinanceExploreTaskGetAdvancedResultInfo:
      type: object
      properties:
        keyword:
          type: string
          description: <em>keyword received in a POST array</em><br><strong>the keyword is returned with decoded %## (plus character '+' will be decoded to a space character)</strong>
          nullable: true
        type:
          type: string
          description: type of element
          nullable: true
        se_domain:
          type: string
          description: <em>search engine domain in a POST array</em>
          nullable: true
        location_code:
          type: integer
          description: <em>location code in a POST array</em>
          nullable: true
        language_code:
          type: string
          description: <em>language code in a POST array</em>
          nullable: true
        check_url:
          type: string
          description: <em>direct URL to search engine results</em><br>you can use it to make sure that we provided accurate results
          nullable: true
        datetime:
          type: string
          description: '<em>date and time when the result was received</em><br>in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”<br>example:<br><code class="long-string">2019-11-15 12:57:46 +00:00</code>'
          nullable: true
        spell:
          type: object
          oneOf:
            - $ref: '#/components/schemas/SpellInfo'
          description: '<em>autocorrection of the search engine</em><br>if the search engine provided results for a keyword that was corrected, we will specify the keyword corrected by the search engine and the type of autocorrection'
          nullable: true
        refinement_chips:
          type: object
          oneOf:
            - $ref: '#/components/schemas/RefinementChipsInfo'
          description: '<em>search refinement chips</em><br>in this case, the value will be <code>null</code>'
          nullable: true
        item_types:
          type: array
          items:
            type: string
            nullable: true
          description: '<em>types of search results in SERP</em><br>contains types of search results (<code>items</code>) found in SERP;<br>possible item types: <a href="#google_finance_hero_groups"><code>google_finance_hero_groups</code></a>, <a href="#google_finance_interested"><code>google_finance_interested</code></a>, <a href="#google_finance_interested"><code>google_finance_news</code></a>, <a href="#google_finance_earnings_calendar"><code>google_finance_earnings_calendar</code></a>, <a href="#google_finance_most_followed"><code>google_finance_most_followed</code></a>, <a href="#google_finance_market_trends"><code>google_finance_market_trends</code></a>, <a href="#google_finance_people_also_search"><code>google_finance_people_also_search</code></a>'
          nullable: true
        se_results_count:
          type: integer
          description: <em>total number of results in SERP</em>
          format: int64
          nullable: true
        items_count:
          type: integer
          description: <em>the number of results returned in the <strong><code>items</code></strong> array</em>
          format: int64
          nullable: true
        items:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/BaseSerpApiGoogleFinanceElementItem'
            nullable: true
          description: '<em>market indexes related to the market trends element</em><br>possible <code>type</code> of items: <code>google_finance_asset_pair_element</code>, <code>google_finance_market_instrument_element</code>, <code>google_finance_market_index_element</code>'
          nullable: true
    SerpGoogleFinanceExploreTaskGetAdvancedTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleFinanceExploreTaskGetAdvancedResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    SerpGoogleFinanceExploreTaskGetAdvancedResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleFinanceExploreTaskGetAdvancedTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    SerpGoogleFinanceExploreTaskGetHtmlResultInfo:
      type: object
      properties:
        keyword:
          type: string
          description: <em>keyword received in a POST array<br></em><strong>keyword is returned with decoded %## (plus symbol '+' will be decoded to a space character)</strong>
          nullable: true
        type:
          type: string
          description: type of element
          nullable: true
        se_domain:
          type: string
          description: <em>search engine domain in a POST array</em>
          nullable: true
        location_code:
          type: integer
          description: <em>location code in a POST array</em>
          nullable: true
        language_code:
          type: string
          description: <em>language code in a POST array</em>
          nullable: true
        datetime:
          type: string
          description: '<em>date and time when the result was received</em><br>in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”<br>example:<br><code class="long-string">2019-11-15 12:57:46 +00:00</code>'
          nullable: true
        items_count:
          type: integer
          description: <em>the number of results returned in the <strong><code>items</code></strong> array</em>
          format: int64
          nullable: true
        items:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/HtmlItemInfo'
            nullable: true
          description: <em>elements of search results found in SERP</em>
          nullable: true
    SerpGoogleFinanceExploreTaskGetHtmlTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleFinanceExploreTaskGetHtmlResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    SerpGoogleFinanceExploreTaskGetHtmlResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleFinanceExploreTaskGetHtmlTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    SerpGoogleFinanceExploreLiveAdvancedRequestInfo:
      type: object
      properties:
        location_code:
          type: integer
          description: '<p><em>search engine location code</em><p><strong>required field if you don''t specify <code>location_name</code></strong><p><strong>if you use this field, you don''t need to specify <code>location_name</code></strong><p>you can receive the list of available locations of the search engines with their <code>location_code</code> by making a separate request to <code>https://api.dataforseo.com/v3/serp/google/locations</code><p>example:<p><code class="long-string">2840</code></p>'
        language_code:
          type: string
          description: '<p><em>search engine language code</em><p><strong>required field if you don''t specify <code>language_name</code></strong><p><strong>if you use this field, you don''t need to specify <code>language_name</code></strong><p>you can receive the list of available languages of the search engine with their <code>language_code</code>&nbsp;by making a separate request to the <code>https://api.dataforseo.com/v3/serp/google/languages</code><em><p></em>example:<em><p></em><code class="long-string">en</code></p>'
        device:
          type: string
          description: '<p><em>device type</em><p>optional field<p>return results for a specific device type<p>possible value: <code>desktop</code></p>'
          nullable: true
        location_name:
          type: string
          description: '<p><em>full name of search engine location</em><p><strong>required field if you don''t specify <code>location_code</code></strong><p><strong>if you use this field, you don''t need to specify <code>location_code</code></strong><p>you can receive the list of available locations of the search engine with their <code>location_name</code> by making a separate request to <code>https://api.dataforseo.com/v3/serp/google/locations</code><p>example:<p><code class="long-string">London,England,United Kingdom</code></p>'
        language_name:
          type: string
          description: '<p><em>full name of search engine language</em><p><strong>required field if you don''t specify <code>language_code</code></strong><p><strong>if you use this field, you don''t need to specify <code>language_code</code></strong><p>you can receive the list of available languages of the search engine with their <code>language_name</code> by making a separate request to the <code>https://api.dataforseo.com/v3/serp/google/languages</code><p>example:<p><code class="long-string">English</code></p>'
        os:
          type: string
          description: '<p><em>device operating system</em><p>optional field<p>possible values: <code>windows</code></p>'
          nullable: true
        tag:
          type: string
          description: <p><em>user-defined task identifier</em><p>optional field<p><em>the character limit is 255</em><p>you can use this parameter to identify the task and match it with the result<p>you will find the specified <code>tag</code> value in the <code>data</code> object of the response</p>
          nullable: true
        news_type:
          type: string
          description: '<p><em>financial news filters</em><p>optional field<p>possible values: <code>top_stories</code>, <code>local_market</code>, <code>world_markets</code><p>default value: <code>top_stories</code><p><strong>Note:</strong> if you specify <code>local_market</code> or <code>world_markets</code>, the charge per task will be multiplied by 2</p>'
          nullable: true
      example:
        - location_code: 2840
          language_name: English
    SerpGoogleFinanceExploreLiveAdvancedResultInfo:
      type: object
      properties:
        keyword:
          type: string
          description: <em>keyword received in a POST array</em><br><strong>the keyword is returned with decoded %## (plus character '+' will be decoded to a space character)</strong>
          nullable: true
        type:
          type: string
          description: type of element
          nullable: true
        se_domain:
          type: string
          description: <em>search engine domain in a POST array</em>
          nullable: true
        location_code:
          type: integer
          description: <em>location code in a POST array</em>
          nullable: true
        language_code:
          type: string
          description: <em>language code in a POST array</em>
          nullable: true
        check_url:
          type: string
          description: <em>direct URL to search engine results</em><br>you can use it to make sure that we provided accurate results
          nullable: true
        datetime:
          type: string
          description: '<em>date and time when the result was received</em><br>in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”<br>example:<br><code class="long-string">2019-11-15 12:57:46 +00:00</code>'
          nullable: true
        spell:
          type: object
          oneOf:
            - $ref: '#/components/schemas/SpellInfo'
          description: '<em>autocorrection of the search engine</em><br>if the search engine provided results for a keyword that was corrected, we will specify the keyword corrected by the search engine and the type of autocorrection'
          nullable: true
        refinement_chips:
          type: object
          oneOf:
            - $ref: '#/components/schemas/RefinementChipsInfo'
          description: '<em>search refinement chips</em><br>in this case, the value will be <code>null</code>'
          nullable: true
        item_types:
          type: array
          items:
            type: string
            nullable: true
          description: '<em>types of search results in SERP</em><br>contains types of search results (<code>items</code>) found in SERP;<br>possible item types: <a href="#google_finance_hero_groups"><code>google_finance_hero_groups</code></a>, <a href="#google_finance_interested"><code>google_finance_interested</code></a>, <a href="#google_finance_interested"><code>google_finance_news</code></a>, <a href="#google_finance_earnings_calendar"><code>google_finance_earnings_calendar</code></a>, <a href="#google_finance_most_followed"><code>google_finance_most_followed</code></a>, <a href="#google_finance_market_trends"><code>google_finance_market_trends</code></a>, <a href="#google_finance_people_also_search"><code>google_finance_people_also_search</code></a>'
          nullable: true
        se_results_count:
          type: integer
          description: <em>total number of results in SERP</em>
          format: int64
          nullable: true
        items_count:
          type: integer
          description: <em>the number of results returned in the <strong><code>items</code></strong> array</em>
          format: int64
          nullable: true
        items:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/BaseSerpApiGoogleFinanceElementItem'
            nullable: true
          description: <em>elements of search results found in SERP</em>
          nullable: true
    SerpGoogleFinanceExploreLiveAdvancedTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleFinanceExploreLiveAdvancedResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    SerpGoogleFinanceExploreLiveAdvancedResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleFinanceExploreLiveAdvancedTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    SerpGoogleFinanceExploreLiveHtmlRequestInfo:
      type: object
      properties:
        location_code:
          type: integer
          description: '<p><em>search engine location code</em><p><strong>required field if you don''t specify <code>location_name</code></strong><p><strong>if you use this field, you don''t need to specify <code>location_name</code></strong><p>you can receive the list of available locations of the search engines with their <code>location_code</code> by making a separate request to <code>https://api.dataforseo.com/v3/serp/google/locations</code><p>example:<p><code class="long-string">2840</code></p>'
        language_code:
          type: string
          description: '<p><em>search engine language code</em><p><strong>required field if you don''t specify <code>language_name</code></strong><p><strong>if you use this field, you don''t need to specify <code>language_name</code></strong><p>you can receive the list of available languages of the search engine with their <code>language_code</code>&nbsp;by making a separate request to the <code>https://api.dataforseo.com/v3/serp/google/languages</code><em><p></em>example:<em><p></em><code class="long-string">en</code></p>'
        device:
          type: string
          description: '<p><em>device type</em><p>optional field<p>possible value: <code>desktop</code></p>'
          nullable: true
        location_name:
          type: string
          description: '<p><em>full name of search engine location</em><p><strong>required field if you don''t specify <code>location_code</code></strong><p><strong>if you use this field, you don''t need to specify <code>location_code</code></strong><p>you can receive the list of available locations of the search engine with their <code>location_name</code> by making a separate request to  <code>https://api.dataforseo.com/v3/serp/google/locations</code><p>example:<p><code class="long-string">London,England,United Kingdom</code></p>'
        language_name:
          type: string
          description: '<p><em>full name of search engine language</em><p><strong>required field if you don''t specify <code>language_code</code> </strong><p><strong>if you use this field, you don''t need to specify <code>language_code</code></strong><p>you can receive the list of available languages of the search engine with their <code>language_name</code> by making a separate request to the <code>https://api.dataforseo.com/v3/serp/google/languages</code><p>example:<p><code class="long-string">English</code></p>'
        os:
          type: string
          description: '<p><em>device operating system</em><p>optional field<p>possible values: <code>windows</code></p>'
          nullable: true
        tag:
          type: string
          description: <p><em>user-defined task identifier</em><p>optional field<p><em>the character limit is 255</em><p>you can use this parameter to identify the task and match it with the result<p>you will find the specified <code>tag</code> value in the <code>data</code> object of the response</p>
          nullable: true
        news_type:
          type: string
          description: '<p><em>financial news filters</em><p>optional field<p>possible values: <code>top_stories</code>, <code>local_market</code>, <code>world_markets</code><p>default value: <code>top_stories</code></p>'
          nullable: true
      example:
        - language_code: en
          location_code: 2840
    SerpGoogleFinanceExploreLiveHtmlResultInfo:
      type: object
      properties:
        keyword:
          type: string
          description: <em>keyword received in a POST array<br></em><strong>keyword is returned with decoded %## (plus character '+' will be decoded to a space character)</strong>
          nullable: true
        type:
          type: string
          description: type of element
          nullable: true
        se_domain:
          type: string
          description: <em>search engine domain in a POST array</em>
          nullable: true
        location_code:
          type: integer
          description: <em>location code in a POST array</em>
          nullable: true
        language_code:
          type: string
          description: <em>language code in a POST array</em>
          nullable: true
        datetime:
          type: string
          description: '<em>date and time when the result was received</em><br>in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”<br>example:<br><code class="long-string">2019-11-15 12:57:46 +00:00</code>'
          nullable: true
        items_count:
          type: integer
          description: <em>the number of results returned in the <strong><code>items</code></strong> array</em>
          format: int64
          nullable: true
        items:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/HtmlItemInfo'
            nullable: true
          description: <em>elements of search results found in SERP</em>
          nullable: true
    SerpGoogleFinanceExploreLiveHtmlTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleFinanceExploreLiveHtmlResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    SerpGoogleFinanceExploreLiveHtmlResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleFinanceExploreLiveHtmlTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    SerpGoogleFinanceMarketsTaskPostRequestInfo:
      type: object
      properties:
        location_code:
          type: integer
          description: '<p><em>search engine location code</em><p><strong>required field if you don''t specify <code>location_name</code></strong><p><strong>if you use this field, you don''t need to specify <code>location_name</code></strong><p>you can receive the list of available locations of the search engines with their <code>location_code</code> by making a separate request to <code>https://api.dataforseo.com/v3/serp/google/locations</code><p>example:<p><code class="long-string">2840</code></p>'
        language_code:
          type: string
          description: '<p><em>search engine language code</em><p><strong>required field if you don''t specify <code>language_name</code></strong><p><strong>if you use this field, you don''t need to specify <code>language_name</code></strong><p>you can receive the list of available languages of the search engine with their <code>language_code</code>&nbsp;by making a separate request to the <code>https://api.dataforseo.com/v3/serp/google/languages</code><em><p></em>example:<em><p></em><code class="long-string">en</code></p>'
        device:
          type: string
          description: '<p><em>device type</em><p>optional field<p>return results for a specific device type<p>possible value: <code>desktop</code></p>'
          nullable: true
        pingback_url:
          type: string
          description: '<p><em>notification URL of a completed task</em><p>optional field<p>when a task is completed we will notify you by GET request sent to the URL you have specified<p>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<p>example:<p><code>http://your-server.com/pingscript?id=$id</code><p><code>http://your-server.com/pingscript?id=$id&amp;tag=$tag</code><p><strong>Note:</strong> special characters in <code>pingback_url</code> will be urlencoded;<p>i.a., the <code>#</code> character will be encoded into <code>%23</code></p><br><p>learn more on our <a href="https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api" target="_blank" rel="noopener noreferrer">Help Center</a></p>'
          nullable: true
        postback_url:
          type: string
          description: '<p><em>URL for sending task results</em><p>optional field<p>once the task is completed, we will send a POST request with its results compressed in the <code>gzip</code> format to the <code>postback_url</code> you specified<p>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request<p>example:<p><code>http://your-server.com/postbackscript?id=$id</code><p><code>http://your-server.com/postbackscript?id=$id&amp;tag=$tag</code><p><strong>Note:</strong> special characters in <code>postback_url</code> will be urlencoded;<p>i.a., the <code>#</code> character will be encoded into <code>%23</code></p><br><p>learn more on our <a href="https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api" target="_blank" rel="noopener noreferrer">Help Center</a></p>'
          nullable: true
        postback_data:
          type: string
          description: '<p><em>postback_url datatype</em><p><strong>required field if you specify <code>postback_url</code></strong><p>corresponds to the datatype that will be sent to your server<p>possible values:: <code>advanced</code>, <code>html</code></p>'
        priority:
          type: integer
          description: <p><em>task priority</em><p>optional field<p>can take the following values:<p>1 – normal execution priority (set by default);<p>2 – high execution priority</p><br>You will be additionally charged for the tasks with high execution priority;<p>The cost can be calculated on the <a title="Pricing" href="https://dataforseo.com/pricing/serp/google-finance-serp-api" target="_blank" rel="noopener noreferrer">Pricing</a> page
          nullable: true
        location_name:
          type: string
          description: '<p><em>full name of search engine location</em><p><strong>required field if you don''t specify <code>location_code</code></strong><p><strong>if you use this field, you don''t need to specify <code>location_code</code></strong><p>you can receive the list of available locations of the search engine with their <code>location_name</code> by making a separate request to  <code>https://api.dataforseo.com/v3/serp/google/locations</code><p>example:<p><code class="long-string">London,England,United Kingdom</code></p>'
        language_name:
          type: string
          description: '<p><em>full name of search engine language</em><p><strong>required field if you don''t specify <code>language_code</code> </strong><p><strong>if you use this field, you don''t need to specify <code>language_code</code></strong><p>you can receive the list of available languages of the search engine with their <code>language_name</code> by making a separate request to the <code>https://api.dataforseo.com/v3/serp/google/languages</code><p>example:<p><code class="long-string">English</code></p>'
        os:
          type: string
          description: '<p><em>device operating system</em><p>optional field<p>possible values: <code>windows</code></p>'
          nullable: true
        tag:
          type: string
          description: <p><em>user-defined task identifier</em><p>optional field<p><em>the character limit is 255</em><p>you can use this parameter to identify the task and match it with the result<p>you will find the specified <code>tag</code> value in the <code>data</code> object of the response</p>
          nullable: true
        market_type:
          type: string
          description: '<p><em>type of google finance market</em><p>optional field<p>possible values: <code>most-active</code>, <code>indexes</code>, <code>indexes/americas</code>, <code>indexes/europe-middle-east-africa</code>, <code>indexes/asia-pacific</code>, <code>gainers</code>, <code>losers</code>, <code>climate-leaders</code>, <code>cryptocurrencies</code>, <code>currencies</code><p>default value: <code>most-active</code></p>'
          nullable: true
      example:
        - location_code: 2840
          language_name: English
    SerpGoogleFinanceMarketsTaskPostTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: object
              description: '<em>array of results</em><br>in this case, the value will be <code>null</code>'
              nullable: true
    SerpGoogleFinanceMarketsTaskPostResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleFinanceMarketsTaskPostTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    SerpGoogleFinanceMarketsTasksReadyResultInfo:
      type: object
      properties:
        id:
          type: string
          description: <em>task identifier of the completed task</em><br><strong>unique task identifier in our system in the <a href="https://en.wikipedia.org/wiki/Universally_unique_identifier">UUID</a> format</strong>
          nullable: true
        se:
          type: string
          description: <em>search engine specified when setting the task</em>
          nullable: true
        se_type:
          type: string
          description: '<em>type of search engine</em><br>example: <code>{{low_se_type_under}}</code>'
          nullable: true
        date_posted:
          type: string
          description: <em>date when the task was posted (in the UTC format)</em>
          nullable: true
        tag:
          type: string
          description: <em>user-defined task identifier</em>
          nullable: true
        endpoint_regular:
          type: string
          description: '<em>URL for collecting the results of the SERP Regular task</em><br>if SERP Regular is not supported in the specified endpoint, the value will be <code>null</code>'
          nullable: true
        endpoint_advanced:
          type: string
          description: '<em>URL for collecting the results of the SERP Advanced task</em><br>if SERP Advanced is not supported in the specified endpoint, the value will be <code>null</code>'
          nullable: true
        endpoint_html:
          type: string
          description: '<em>URL for collecting the results of the SERP HTML task</em><br>if SERP HTML is not supported in the specified endpoint, the value will be <code>null</code>'
          nullable: true
    SerpGoogleFinanceMarketsTasksReadyTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleFinanceMarketsTasksReadyResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    SerpGoogleFinanceMarketsTasksReadyResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleFinanceMarketsTasksReadyTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    SerpApiGoogleFinanceExploreMarketTrendsElementItem:
      type: object
      allOf:
        - type: object
          oneOf:
            - $ref: '#/components/schemas/BaseSerpApiGoogleFinanceElementItem'
          nullable: true
        - type: object
          properties:
            rank_group:
              type: integer
              description: <em>group rank in SERP</em><br>position within a group of elements with identical <code>type</code> values<br>positions of elements with different <code>type</code> values are omitted from <code>rank_group</code>
              nullable: true
            rank_absolute:
              type: integer
              description: <em>absolute rank in SERP</em><br>absolute position among all the elements in SERP
              nullable: true
            title:
              type: string
              description: '<em>title of the market trends element</em><br>example: <code>Europe, Middle East, and Africa</code>'
              nullable: true
            sub_title:
              type: string
              description: <em>sub-title of the market trends element</em>
              nullable: true
            url:
              type: string
              description: <em>URL to finance pair on Google Finance</em>
              nullable: true
            items:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/BaseSerpApiGoogleFinanceElementItem'
                nullable: true
              description: '<em>market indexes data</em><br>array of items containing market indexes data;<br>possible <code>type</code> of items: <code>google_finance_asset_pair_element</code>, <code>google_finance_market_instrument_element</code>, <code>google_finance_market_index_element</code>'
              nullable: true
    SerpGoogleFinanceMarketsTaskGetAdvancedResultInfo:
      type: object
      properties:
        keyword:
          type: string
          description: <em>keyword received in a POST array</em><br><strong>the keyword is returned with decoded %## (plus character '+' will be decoded to a space character)</strong>
          nullable: true
        type:
          type: string
          description: type of element
          nullable: true
        se_domain:
          type: string
          description: <em>search engine domain in a POST array</em>
          nullable: true
        location_code:
          type: integer
          description: <em>location code in a POST array</em>
          nullable: true
        language_code:
          type: string
          description: <em>language code in a POST array</em>
          nullable: true
        check_url:
          type: string
          description: <em>direct URL to search engine results</em><br>you can use it to make sure that we provided accurate results
          nullable: true
        datetime:
          type: string
          description: '<em>date and time when the result was received</em><br>in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”<br>example:<br><code class="long-string">2019-11-15 12:57:46 +00:00</code>'
          nullable: true
        spell:
          type: object
          oneOf:
            - $ref: '#/components/schemas/SpellInfo'
          description: '<em>autocorrection of the search engine</em><br>if the search engine provided results for a keyword that was corrected, we will specify the keyword corrected by the search engine and the type of autocorrection'
          nullable: true
        refinement_chips:
          type: object
          oneOf:
            - $ref: '#/components/schemas/RefinementChipsInfo'
          description: '<em>search refinement chips</em><br>in this case, the value will be <code>null</code>'
          nullable: true
        item_types:
          type: array
          items:
            type: string
            nullable: true
          description: '<em>types of search results in SERP</em><br>contains types of search results (<code>items</code>) found in SERP;<br>possible item types: <span><a href="#google_finance_hero_groups"><code>google_finance_hero_groups</code></a>, <a href="#google_finance_explore_market_trends"><code>google_finance_explore_market_trends</code></a>, <a href="#google_finance_news"><code>google_finance_news</code></a>, <a href="#google_finance_interested"><code>google_finance_interested</code></a>, <a href="#google_finance_people_also_search"><code>google_finance_people_also_search</code></a>'
          nullable: true
        se_results_count:
          type: integer
          description: <em> total number of results in SERP</em>
          format: int64
          nullable: true
        items_count:
          type: integer
          description: <em>the number of results returned in the <strong><code>items</code></strong> array</em>
          format: int64
          nullable: true
        items:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/BaseSerpApiGoogleFinanceElementItem'
            nullable: true
          description: '<em>market indexes related to the market trends element</em><br>possible <code>type</code> of items: <code>google_finance_asset_pair_element</code>, <code>google_finance_market_instrument_element</code>, <code>google_finance_market_index_element</code>'
          nullable: true
    SerpGoogleFinanceMarketsTaskGetAdvancedTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleFinanceMarketsTaskGetAdvancedResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    SerpGoogleFinanceMarketsTaskGetAdvancedResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleFinanceMarketsTaskGetAdvancedTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    SerpGoogleFinanceMarketsTaskGetHtmlResultInfo:
      type: object
      properties:
        keyword:
          type: string
          description: <em>keyword received in a POST array<br></em><strong>keyword is returned with decoded %## (plus symbol '+' will be decoded to a space character)</strong>
          nullable: true
        type:
          type: string
          description: type of element
          nullable: true
        se_domain:
          type: string
          description: <em>search engine domain in a POST array</em>
          nullable: true
        location_code:
          type: integer
          description: <em>location code in a POST array</em>
          nullable: true
        language_code:
          type: string
          description: <em>language code in a POST array</em>
          nullable: true
        datetime:
          type: string
          description: '<em>date and time when the result was received</em><br>in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”<br>example:<br><code class="long-string">2019-11-15 12:57:46 +00:00</code>'
          nullable: true
        items_count:
          type: integer
          description: <em>the number of results returned in the <strong><code>items</code></strong> array</em>
          format: int64
          nullable: true
        items:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/HtmlItemInfo'
            nullable: true
          description: <em>elements of search results found in SERP</em>
          nullable: true
    SerpGoogleFinanceMarketsTaskGetHtmlTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleFinanceMarketsTaskGetHtmlResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    SerpGoogleFinanceMarketsTaskGetHtmlResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleFinanceMarketsTaskGetHtmlTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    SerpGoogleFinanceMarketsLiveAdvancedRequestInfo:
      type: object
      properties:
        location_code:
          type: integer
          description: '<p><em>search engine location code</em><p><strong>required field if you don''t specify <code>location_name</code></strong><p><strong>if you use this field, you don''t need to specify <code>location_name</code></strong><p>you can receive the list of available locations of the search engines with their <code>location_code</code> by making a separate request to <code>https://api.dataforseo.com/v3/serp/google/locations</code><p>example:<p><code class="long-string">2840</code></p>'
        language_code:
          type: string
          description: '<p><em>search engine language code</em><p><strong>required field if you don''t specify <code>language_name</code></strong><p><strong>if you use this field, you don''t need to specify <code>language_name</code></strong><p>you can receive the list of available languages of the search engine with their <code>language_code</code>&nbsp;by making a separate request to the <code>https://api.dataforseo.com/v3/serp/google/languages</code><em><p></em>example:<em><p></em><code class="long-string">en</code></p>'
        device:
          type: string
          description: '<p><em>device type</em><p>optional field<p>return results for a specific device type<p>possible value: <code>desktop</code></p>'
          nullable: true
        location_name:
          type: string
          description: '<p><em>full name of search engine location</em><p><strong>required field if you don''t specify <code>location_code</code></strong><p><strong>if you use this field, you don''t need to specify <code>location_code</code></strong><p>you can receive the list of available locations of the search engine with their <code>location_name</code> by making a separate request to  <code>https://api.dataforseo.com/v3/serp/google/locations</code><p>example:<p><code class="long-string">London,England,United Kingdom</code></p>'
        language_name:
          type: string
          description: '<p><em>full name of search engine language</em><p><strong>required field if you don''t specify <code>language_code</code> </strong><p><strong>if you use this field, you don''t need to specify <code>language_code</code></strong><p>you can receive the list of available languages of the search engine with their <code>language_name</code> by making a separate request to the <code>https://api.dataforseo.com/v3/serp/google/languages</code><p>example:<p><code class="long-string">English</code></p>'
        os:
          type: string
          description: '<p><em>device operating system</em><p>optional field<p>possible values: <code>windows</code></p>'
          nullable: true
        tag:
          type: string
          description: <p><em>user-defined task identifier</em><p>optional field<p><em>the character limit is 255</em><p>you can use this parameter to identify the task and match it with the result<p>you will find the specified <code>tag</code> value in the <code>data</code> object of the response</p>
          nullable: true
        market_type:
          type: string
          description: '<p><em>type of google finance market</em><p>optional field<p>possible values: <code>most-active</code>, <code>indexes</code>, <code>indexes/americas</code>, <code>indexes/europe-middle-east-africa</code>, <code>indexes/asia-pacific</code>, <code>gainers</code>, <code>losers</code>, <code>climate-leaders</code>, <code>cryptocurrencies</code>, <code>currencies</code><p>default value: <code>most-active</code></p>'
          nullable: true
      example:
        - location_code: 2840
          language_name: English
    SerpGoogleFinanceMarketsLiveAdvancedResultInfo:
      type: object
      properties:
        keyword:
          type: string
          description: <em>keyword received in a POST array</em><br><strong>the keyword is returned with decoded %## (plus character '+' will be decoded to a space character)</strong>
          nullable: true
        type:
          type: string
          description: type of element
          nullable: true
        se_domain:
          type: string
          description: <em>search engine domain in a POST array</em>
          nullable: true
        location_code:
          type: integer
          description: <em>location code in a POST array</em>
          nullable: true
        language_code:
          type: string
          description: <em>language code in a POST array</em>
          nullable: true
        check_url:
          type: string
          description: <em>direct URL to search engine results</em><br>you can use it to make sure that we provided accurate results
          nullable: true
        datetime:
          type: string
          description: '<em>date and time when the result was received</em><br>in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”<br>example:<br><code class="long-string">2019-11-15 12:57:46 +00:00</code>'
          nullable: true
        spell:
          type: object
          oneOf:
            - $ref: '#/components/schemas/SpellInfo'
          description: '<em>autocorrection of the search engine</em><br>if the search engine provided results for a keyword that was corrected, we will specify the keyword corrected by the search engine and the type of autocorrection;<br>in this case, the value will be <code>null</code>'
          nullable: true
        refinement_chips:
          type: object
          oneOf:
            - $ref: '#/components/schemas/RefinementChipsInfo'
          description: '<em>search refinement chips</em><br>in this case, the value will be <code>null</code>'
          nullable: true
        item_types:
          type: array
          items:
            type: string
            nullable: true
          description: '<em>types of search results in SERP</em><br>contains types of search results (<code>items</code>) found in SERP;<br>possible item types: <span><a href="#google_finance_hero_groups"><code>google_finance_hero_groups</code></a>, <a href="#google_finance_explore_market_trends"><code>google_finance_explore_market_trends</code></a>, <a href="#google_finance_news"><code>google_finance_news</code></a>, <a href="#google_finance_interested"><code>google_finance_interested</code></a>, <a href="#google_finance_people_also_search"><code>google_finance_people_also_search</code></a>'
          nullable: true
        se_results_count:
          type: integer
          description: <em> total number of results in SERP</em>
          format: int64
          nullable: true
        items_count:
          type: integer
          description: <em>the number of results returned in the <strong><code>items</code></strong> array</em>
          format: int64
          nullable: true
        items:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/BaseSerpApiGoogleFinanceElementItem'
            nullable: true
          description: <em>elements of search results found in SERP</em>
          nullable: true
    SerpGoogleFinanceMarketsLiveAdvancedTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleFinanceMarketsLiveAdvancedResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    SerpGoogleFinanceMarketsLiveAdvancedResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleFinanceMarketsLiveAdvancedTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    SerpGoogleFinanceMarketsLiveHtmlRequestInfo:
      type: object
      properties:
        location_code:
          type: integer
          description: '<p><em>search engine location code</em><p><strong>required field if you don''t specify <code>location_name</code></strong><p><strong>if you use this field, you don''t need to specify <code>location_name</code></strong><p>you can receive the list of available locations of the search engines with their <code>location_code</code> by making a separate request to <code>https://api.dataforseo.com/v3/serp/google/locations</code><p>example:<p><code class="long-string">2840</code></p>'
        language_code:
          type: string
          description: '<p><em>search engine language code</em><p><strong>required field if you don''t specify <code>language_name</code></strong><p><strong>if you use this field, you don''t need to specify <code>language_name</code></strong><p>you can receive the list of available languages of the search engine with their <code>language_code</code>&nbsp;by making a separate request to the <code>https://api.dataforseo.com/v3/serp/google/languages</code><em><p></em>example:<em><p></em><code class="long-string">en</code></p>'
        device:
          type: string
          description: '<p><em>device type</em><p>optional field<p>possible value: <code>desktop</code></p>'
          nullable: true
        location_name:
          type: string
          description: '<p><em>full name of search engine location</em><p><strong>required field if you don''t specify <code>location_code</code></strong><p><strong>if you use this field, you don''t need to specify <code>location_code</code></strong><p>you can receive the list of available locations of the search engine with their <code>location_name</code> by making a separate request to  <code>https://api.dataforseo.com/v3/serp/google/locations</code><p>example:<p><code class="long-string">London,England,United Kingdom</code></p>'
        language_name:
          type: string
          description: '<p><em>full name of search engine language</em><p><strong>required field if you don''t specify <code>language_code</code> </strong><p><strong>if you use this field, you don''t need to specify <code>language_code</code></strong><p>you can receive the list of available languages of the search engine with their <code>language_name</code> by making a separate request to the <code>https://api.dataforseo.com/v3/serp/google/languages</code><p>example:<p><code class="long-string">English</code></p>'
        os:
          type: string
          description: '<p><em>device operating system</em><p>optional field<p>possible values: <code>windows</code></p>'
          nullable: true
        tag:
          type: string
          description: <p><em>user-defined task identifier</em><p>optional field<p><em>the character limit is 255</em><p>you can use this parameter to identify the task and match it with the result<p>you will find the specified <code>tag</code> value in the <code>data</code> object of the response</p>
          nullable: true
        market_type:
          type: string
          description: '<p><em>type of google finance market</em><p>optional field<p>possible values: <code>most-active</code>, <code>indexes</code>, <code>indexes/americas</code>, <code>indexes/europe-middle-east-africa</code>, <code>indexes/asia-pacific</code>, <code>gainers</code>, <code>losers</code>, <code>climate-leaders</code>, <code>cryptocurrencies</code>, <code>currencies</code><p>default value: <code>most-active</code></p>'
          nullable: true
      example:
        - language_code: en
          location_code: 2840
    SerpGoogleFinanceMarketsLiveHtmlResultInfo:
      type: object
      properties:
        keyword:
          type: string
          description: <em>keyword received in a POST array<br></em><strong>keyword is returned with decoded %## (plus character '+' will be decoded to a space character)</strong>
          nullable: true
        type:
          type: string
          description: type of element
          nullable: true
        se_domain:
          type: string
          description: <em>search engine domain in a POST array</em>
          nullable: true
        location_code:
          type: integer
          description: <em>location code in a POST array</em>
          nullable: true
        language_code:
          type: string
          description: <em>language code in a POST array</em>
          nullable: true
        datetime:
          type: string
          description: '<em>date and time when the result was received</em><br>in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”<br>example:<br><code class="long-string">2019-11-15 12:57:46 +00:00</code>'
          nullable: true
        items_count:
          type: integer
          description: <em>the number of results returned in the <strong><code>items</code></strong> array</em>
          format: int64
          nullable: true
        items:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/HtmlItemInfo'
            nullable: true
          description: <em>elements of search results found in SERP</em>
          nullable: true
    SerpGoogleFinanceMarketsLiveHtmlTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleFinanceMarketsLiveHtmlResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    SerpGoogleFinanceMarketsLiveHtmlResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleFinanceMarketsLiveHtmlTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    SerpGoogleFinanceQuoteTaskPostRequestInfo:
      type: object
      properties:
        keyword:
          type: string
          description: '<p><em>ticker or stock symbol</em><p><strong>required field</strong><p>in this field you can pass the ticker symbol of publicly traded shares of a particular stock or security on a particular stock exchange;<p>you can specify <strong>up to 700 characters</strong> in the <code>keyword</code> field;<p>all %## will be decoded (plus character ‘+’ will be decoded to a space character)<p>if you need to use the “%” character for your <code>keyword</code>, please specify it as “%25”;<p>if you need to use the “+” character for your <code>keyword</code>, please specify it as “%2B”;</p><br><p>learn more about rules and limitations of <code>keyword</code> and <code>keywords</code> fields in DataForSEO APIs in this <a href="https://dataforseo.com/help-center/rules-and-limitations-of-keyword-and-keywords-fields-in-dataforseo-apis" rel="noopener noreferrer" target="_blank">Help Center article</a></p>'
        location_code:
          type: integer
          description: '<p><em>search engine location code</em><p><strong>required field if you don''t specify <code>location_name</code></strong><p><strong>if you use this field, you don''t need to specify <code>location_name</code></strong><p>you can receive the list of available locations of the search engines with their <code>location_code</code> by making a separate request to <code>https://api.dataforseo.com/v3/serp/google/locations</code><p>example:<p><code class="long-string">2840</code></p>'
        language_code:
          type: string
          description: '<p><em>search engine language code</em><p><strong>required field if you don''t specify <code>language_name</code></strong><p><strong>if you use this field, you don''t need to specify <code>language_name</code></strong><p>you can receive the list of available languages of the search engine with their <code>language_code</code>&nbsp;by making a separate request to the <code>https://api.dataforseo.com/v3/serp/google/languages</code><em><p></em>example:<em><p></em><code class="long-string">en</code></p>'
        device:
          type: string
          description: '<p><em>device type</em><p>optional field<p>return results for a specific device type<p>possible value: <code>desktop</code></p>'
          nullable: true
        pingback_url:
          type: string
          description: '<p><em>notification URL of a completed task</em><p>optional field<p>when a task is completed we will notify you by GET request sent to the URL you have specified<p>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<p>example:<p><code>http://your-server.com/pingscript?id=$id</code><p><code>http://your-server.com/pingscript?id=$id&amp;tag=$tag</code><p><strong>Note:</strong> special characters in <code>pingback_url</code> will be urlencoded;<p>i.a., the <code>#</code> character will be encoded into <code>%23</code></p><br><p>learn more on our <a href="https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api" target="_blank" rel="noopener noreferrer">Help Center</a></p>'
          nullable: true
        postback_url:
          type: string
          description: '<p><em>URL for sending task results</em><p>optional field<p>once the task is completed, we will send a POST request with its results compressed in the <code>gzip</code> format to the <code>postback_url</code> you specified<p>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request<p>example:<p><code>http://your-server.com/postbackscript?id=$id</code><p><code>http://your-server.com/postbackscript?id=$id&amp;tag=$tag</code><p><strong>Note:</strong> special characters in <code>postback_url</code> will be urlencoded;<p>i.a., the <code>#</code> character will be encoded into <code>%23</code></p><br><p>learn more on our <a href="https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api" target="_blank" rel="noopener noreferrer">Help Center</a></p>'
          nullable: true
        postback_data:
          type: string
          description: '<p><em>postback_url datatype</em><p><strong>required field if you specify <code>postback_url</code></strong><p>corresponds to the datatype that will be sent to your server<p>possible values:: <code>advanced</code>, <code>html</code></p>'
        priority:
          type: integer
          description: <p><em>task priority</em><p>optional field<p>can take the following values:<p>1 – normal execution priority (set by default);<p>2 – high execution priority</p><br>You will be additionally charged for the tasks with high execution priority;<p>The cost can be calculated on the <a title="Pricing" href="https://dataforseo.com/pricing/serp/google-finance-serp-api" target="_blank" rel="noopener noreferrer">Pricing</a> page
          nullable: true
        location_name:
          type: string
          description: '<p><em>full name of search engine location</em><p><strong>required field if you don''t specify <code>location_code</code></strong><p><strong>if you use this field, you don''t need to specify <code>location_code</code></strong><p>you can receive the list of available locations of the search engine with their <code>location_name</code> by making a separate request to  <code>https://api.dataforseo.com/v3/serp/google/locations</code><p>example:<p><code class="long-string">London,England,United Kingdom</code></p>'
        language_name:
          type: string
          description: '<p><em>full name of search engine language</em><p><strong>required field if you don''t specify <code>language_code</code> </strong><p><strong>if you use this field, you don''t need to specify <code>language_code</code></strong><p>you can receive the list of available languages of the search engine with their <code>language_name</code> by making a separate request to the <code>https://api.dataforseo.com/v3/serp/google/languages</code><p>example:<p><code class="long-string">English</code></p>'
        os:
          type: string
          description: '<p><em>device operating system</em><p>optional field<p>possible values: <code>windows</code></p>'
          nullable: true
        tag:
          type: string
          description: <p><em>user-defined task identifier</em><p>optional field<p><em>the character limit is 255</em><p>you can use this parameter to identify the task and match it with the result<p>you will find the specified <code>tag</code> value in the <code>data</code> object of the response</p>
          nullable: true
        window:
          type: string
          description: '<p><em>time window for <code>google_finance_quote</code> graph</em><p>optional field<p>possible values: <code>1D</code>, <code>5D</code>, <code>1M</code>, <code>6M</code>, <code>YTD</code>, <code>1Y</code>, <code>5Y</code>, <code>MAX</code><p>default value: <code>1D</code><p><strong>Note:</strong> if you specify a value that is different from <code>1D</code>, the charge per task will be multiplied by 2</p>'
          nullable: true
      example:
        - keyword: .DJI:INDEXDJX
          location_code: 2840
          language_name: English
    SerpGoogleFinanceQuoteTaskPostTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: object
              description: '<em>array of results</em><br>in this case, the value will be <code>null</code>'
              nullable: true
    SerpGoogleFinanceQuoteTaskPostResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleFinanceQuoteTaskPostTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    SerpGoogleFinanceQuoteTasksReadyResultInfo:
      type: object
      properties:
        id:
          type: string
          description: <em>task identifier of the completed task</em><br><strong>unique task identifier in our system in the <a href="https://en.wikipedia.org/wiki/Universally_unique_identifier">UUID</a> format</strong>
          nullable: true
        se:
          type: string
          description: <em>search engine specified when setting the task</em>
          nullable: true
        se_type:
          type: string
          description: '<em>type of search engine</em><br>example: <code>{{low_se_type_under}}</code>'
          nullable: true
        date_posted:
          type: string
          description: <em>date when the task was posted (in the UTC format)</em>
          nullable: true
        tag:
          type: string
          description: <em>user-defined task identifier</em>
          nullable: true
        endpoint_regular:
          type: string
          description: '<em>URL for collecting the results of the SERP Regular task</em><br>if SERP Regular is not supported in the specified endpoint, the value will be <code>null</code>'
          nullable: true
        endpoint_advanced:
          type: string
          description: '<em>URL for collecting the results of the SERP Advanced task</em><br>if SERP Advanced is not supported in the specified endpoint, the value will be <code>null</code>'
          nullable: true
        endpoint_html:
          type: string
          description: '<em>URL for collecting the results of the SERP HTML task</em><br>if SERP HTML is not supported in the specified endpoint, the value will be <code>null</code>'
          nullable: true
    SerpGoogleFinanceQuoteTasksReadyTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleFinanceQuoteTasksReadyResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    SerpGoogleFinanceQuoteTasksReadyResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleFinanceQuoteTasksReadyTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    GraphItems:
      type: object
      properties:
        timestamp:
          type: string
          description: '<em>date and time of the value readout</em><br>in the UTC format: "yyyy-mm-dd hh-mm-ss +00:00"<br>example:<br><code class="long-string">2025-02-10 09:40:00 +00:00</code>'
          nullable: true
        value:
          type: number
          description: <em>point value on graph</em>
          nullable: true
        volume:
          type: number
          description: <em>volume value on graph</em>
          nullable: true
    SerpApiGoogleFinanceQuoteElementItem:
      type: object
      allOf:
        - type: object
          oneOf:
            - $ref: '#/components/schemas/BaseSerpApiGoogleFinanceElementItem'
          nullable: true
        - type: object
          properties:
            rank_group:
              type: integer
              description: <em>group rank in SERP</em><br>position within a group of elements with identical <code>type</code> values<br>positions of elements with different <code>type</code> values are omitted from <code>rank_group</code>
              nullable: true
            rank_absolute:
              type: integer
              description: <em>absolute rank in SERP</em><br>absolute position among all the elements in SERP
              nullable: true
            quote:
              type: object
              oneOf:
                - $ref: '#/components/schemas/BaseSerpApiGoogleFinanceElementItem'
              description: <em>quoted market indexes</em>
              nullable: true
            graph_items:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/GraphItems'
                nullable: true
              description: <em>values on graph</em>
              nullable: true
    SerpApiGoogleFinanceCompareToElementItem:
      type: object
      allOf:
        - type: object
          oneOf:
            - $ref: '#/components/schemas/BaseSerpApiGoogleFinanceElementItem'
          nullable: true
        - type: object
          properties:
            rank_group:
              type: integer
              description: <em>group rank in SERP</em><br>position within a group of elements with identical <code>type</code> values<br>positions of elements with different <code>type</code> values are omitted from <code>rank_group</code>
              nullable: true
            rank_absolute:
              type: integer
              description: <em>absolute rank in SERP</em><br>absolute position among all the elements in SERP
              nullable: true
            items:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/BaseSerpApiGoogleFinanceElementItem'
                nullable: true
              description: '<em>market indexes data</em><br>array of items containing market indexes data;<br>possible <code>type</code> of items: <code>google_finance_asset_pair_element</code>, <code>google_finance_market_instrument_element</code>, <code>google_finance_market_index_element</code>'
              nullable: true
    GoogleFinanceMetricsBundleInfo:
      type: object
      properties:
        type:
          type: string
          description: type of element
          nullable: true
        timestamp:
          type: string
          description: '<em>date and time of the value readout</em><br>in the UTC format: "yyyy-mm-dd hh-mm-ss +00:00"<br>example:<br><code class="long-string">2025-02-10 09:40:00 +00:00</code>'
          nullable: true
        revenue:
          type: number
          description: <em>revenue value</em>
          nullable: true
        revenue_delta:
          type: number
          description: <em>change in revenue</em>
          nullable: true
        operating_expense:
          type: number
          description: <em>operating expense value</em>
          nullable: true
        operating_expense_delta:
          type: number
          description: <em>change in operating expense</em>
          nullable: true
        net_income:
          type: number
          description: <em>net income value</em>
          nullable: true
        net_income_delta:
          type: number
          description: <em>change in net income</em>
          nullable: true
        net_profit_margin:
          type: number
          description: <em>net profit margin value</em>
          nullable: true
        net_profit_margin_delta:
          type: number
          description: <em>change in net profit margin</em>
          nullable: true
        earnings_per_share:
          type: number
          description: <em>earnings per share value</em>
          nullable: true
        earnings_per_share_delta:
          type: number
          description: <em>change in earnings per share</em>
          nullable: true
        ebitda:
          type: number
          description: '<em>earnings before interest, taxes, deprecation, amortisation</em>'
          nullable: true
        ebitda_delta:
          type: number
          description: <em>change in ebitda</em>
          nullable: true
        effective_tax_rate:
          type: number
          description: <em>effective tax rate value</em>
          nullable: true
        cash_and_short_term_investments:
          type: number
          description: <em>cash and short-term investments value</em>
          nullable: true
        cash_and_short_term_investments_delta:
          type: number
          description: <em>change in cash and short-term investments</em>
          nullable: true
        total_assets:
          type: number
          description: <em>total assets value</em>
          nullable: true
        total_assets_delta:
          type: number
          description: <em>change in total assets</em>
          nullable: true
        total_liabilities:
          type: number
          description: <em>total liabilities value</em>
          nullable: true
        total_liabilities_delta:
          type: number
          description: <em>change in total liabilities</em>
          nullable: true
        total_equity:
          type: number
          description: <em>total equity value</em>
          nullable: true
        shares_outstanding:
          type: number
          description: <em>outstanding shares value</em>
          nullable: true
        price_to_book:
          type: number
          description: <em>price to book</em>
          nullable: true
        return_on_assets:
          type: number
          description: <em>return on assets</em>
          nullable: true
        return_on_capital:
          type: number
          description: <em>return on capital</em>
          nullable: true
        cash_from_operations:
          type: number
          description: <em>cash from operations</em>
          nullable: true
        cash_from_operations_delta:
          type: number
          description: <em>change in cash from operations</em>
          nullable: true
        cash_from_investing:
          type: number
          description: <em>cash from investing</em>
          nullable: true
        cash_from_investing_delta:
          type: number
          description: <em>change in cash from investing</em>
          nullable: true
        cash_from_financing:
          type: number
          description: <em>cash from financing/em>
          nullable: true
        cash_from_financing_delta:
          type: number
          description: <em>change in cash from financing</em>
          nullable: true
        net_change_in_cash:
          type: number
          description: <em>net change in cash</em>
          nullable: true
        net_change_in_cash_delta:
          type: number
          description: <em>change in net change in cash</em>
          nullable: true
        free_cash_flow:
          type: number
          description: <em>free cash flow value</em>
          nullable: true
        free_cash_flow_delta:
          type: number
          description: <em>change in free cash flow</em>
          nullable: true
    SerpApiGoogleFinanceFinancialElementItem:
      type: object
      allOf:
        - type: object
          oneOf:
            - $ref: '#/components/schemas/BaseSerpApiGoogleFinanceElementItem'
          nullable: true
        - type: object
          properties:
            rank_group:
              type: integer
              description: <em>group rank in SERP</em><br>position within a group of elements with identical <code>type</code> values<br>positions of elements with different <code>type</code> values are omitted from <code>rank_group</code>
              nullable: true
            rank_absolute:
              type: integer
              description: <em>absolute rank in SERP</em><br>absolute position among all the elements in SERP
              nullable: true
            quarterly_metrics:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/GoogleFinanceMetricsBundleInfo'
                nullable: true
              description: <em>quarterly google finance metrics</em>
              nullable: true
            annual_metrics:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/GoogleFinanceMetricsBundleInfo'
                nullable: true
              description: <em>annual google finance metrics</em>
              nullable: true
    GoogleFinanceFuturesChainElement:
      type: object
      properties:
        type:
          type: string
          description: type of element
          nullable: true
        expiration_timestamp:
          type: string
          description: '<em>futures'' date and time of expiration</em><br>in the UTC format: "yyyy-mm-dd hh-mm-ss +00:00"<br>example:<br><code class="long-string">2025-02-10 09:40:00 +00:00</code>'
          nullable: true
        symbol:
          type: string
          description: <em>futures' symbol</em>
          nullable: true
        price:
          type: number
          description: <em>price of the market instrument</em><br>price of the market instrument at a given <code>timestamp</code>
          nullable: true
        price_currency:
          type: string
          description: <em>currency of the price value</em>
          nullable: true
        price_delta:
          type: number
          description: <em>change in price of the market instrument</em><br>change in <code>price</code> at a given <code>timestamp</code>
          nullable: true
        percentage_delta:
          type: number
          description: <em>percentage of change in value of the market index</em>
          nullable: true
        trend:
          type: string
          description: '<em>growth trend of the market index</em><br>possible values: <code>up</code>, <code>down</code>, <code>stable</code>'
          nullable: true
    SerpApiGoogleFinanceFuturesChainElementItem:
      type: object
      allOf:
        - type: object
          oneOf:
            - $ref: '#/components/schemas/BaseSerpApiGoogleFinanceElementItem'
          nullable: true
        - type: object
          properties:
            rank_group:
              type: integer
              description: <em>group rank in SERP</em><br>position within a group of elements with identical <code>type</code> values<br>positions of elements with different <code>type</code> values are omitted from <code>rank_group</code>
              nullable: true
            rank_absolute:
              type: integer
              description: <em>absolute rank in SERP</em><br>absolute position among all the elements in SERP
              nullable: true
            markets:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/GoogleFinanceFuturesChainElement'
                nullable: true
              description: <em>financial markets data</em><br>array of items containing market indexes and other financial information related to these indexes
              nullable: true
    SerpApiGoogleFinanceDetailsElementItem:
      type: object
      allOf:
        - type: object
          oneOf:
            - $ref: '#/components/schemas/BaseSerpApiGoogleFinanceElementItem'
          nullable: true
        - type: object
          properties:
            rank_group:
              type: integer
              description: <em>group rank in SERP</em><br>position within a group of elements with identical <code>type</code> values<br>positions of elements with different <code>type</code> values are omitted from <code>rank_group</code>
              nullable: true
            rank_absolute:
              type: integer
              description: <em>absolute rank in SERP</em><br>absolute position among all the elements in SERP
              nullable: true
            badges:
              type: array
              items:
                type: string
                nullable: true
              description: '<em>google finance badges relevant to the element</em><br>example: <code>Futures Contract</code>'
              nullable: true
            previous_close:
              type: number
              description: <em>value of the previous close</em>
              nullable: true
            start_day_range:
              type: number
              description: <em>value of the start day range</em>
              nullable: true
            end_day_range:
              type: number
              description: <em>value of the end day range</em>
              nullable: true
            start_year_range:
              type: number
              description: <em>value of the start year range</em>
              nullable: true
            end_year_range:
              type: number
              description: <em>value of the end year range</em>
              nullable: true
            market_cap:
              type: number
              description: <em>market cap value</em>
              nullable: true
            volume:
              type: number
              description: <em>total volume value</em>
              nullable: true
            avg_volume:
              type: number
              description: <em>average volume value</em>
              nullable: true
            pe_ratio:
              type: number
              description: <em>price-earnings ratio</em>
              nullable: true
            dividend_yield:
              type: number
              description: <em>dividend yield value</em>
              nullable: true
            primary_exchange:
              type: string
              description: <em>primary exchange value</em>
              nullable: true
            ytd_return:
              type: number
              description: <em>year-to-date return value</em>
              nullable: true
            expense_ratio:
              type: number
              description: <em>expense ratio value</em>
              nullable: true
            category:
              type: string
              description: <em>category name</em>
              nullable: true
            net_assets:
              type: number
              nullable: true
            yield:
              type: number
              description: <em>yield value</em>
              nullable: true
            front_load:
              type: number
              description: <em>front load value</em>
              nullable: true
            market_segment:
              type: string
              description: <em>name of the relevant market segment</em>
              nullable: true
            open_interest:
              type: number
              description: <em>open interest value</em>
              nullable: true
            settlement_price:
              type: number
              description: <em>settlement price value</em>
              nullable: true
            cdp_climate_change_score:
              type: string
              description: <em>climate change score by carbon disclosure project methodology</em>
              nullable: true
            metrics_currency:
              type: string
              description: <em>currency of the metrics</em>
              nullable: true
    SerpApiGoogleFinanceAboutElementItem:
      type: object
      allOf:
        - type: object
          oneOf:
            - $ref: '#/components/schemas/BaseSerpApiGoogleFinanceElementItem'
          nullable: true
        - type: object
          properties:
            rank_group:
              type: integer
              description: <em>group rank in SERP</em><br>position within a group of elements with identical <code>type</code> values<br>positions of elements with different <code>type</code> values are omitted from <code>rank_group</code>
              nullable: true
            rank_absolute:
              type: integer
              description: <em>absolute rank in SERP</em><br>absolute position among all the elements in SERP
              nullable: true
            displayed_name:
              type: string
              description: '<em>displayed name of the market index</em><br>example: <code>E-mini Dow ($5)</code>'
              nullable: true
            description:
              type: string
              description: <em>company description</em>
              nullable: true
            description_source_url:
              type: string
              description: <em>source of information provided in description</em>
              nullable: true
            ceo:
              type: string
              description: <em>Chief Executive Officer of the company</em>
              nullable: true
            founded:
              type: string
              description: '<em>date when the company was founded</em><br>in the format: "yyyy-mm-ddThh-mm-ssZ"<br>example:<br><code class="long-string">1993-04-05T00:00:00Z</code>'
              nullable: true
            headquarters:
              type: string
              description: <em>company headquarters</em>
              nullable: true
            website:
              type: string
              description: <em>company website</em>
              nullable: true
            employees:
              type: integer
              description: <em>number of company employees</em>
              nullable: true
    SerpGoogleFinanceQuoteTaskGetAdvancedResultInfo:
      type: object
      properties:
        keyword:
          type: string
          description: <em>keyword received in a POST array</em><br><strong>the keyword is returned with decoded %## (plus character '+' will be decoded to a space character)</strong>
          nullable: true
        type:
          type: string
          description: type of element
          nullable: true
        se_domain:
          type: string
          description: <em>search engine domain in a POST array</em>
          nullable: true
        location_code:
          type: integer
          description: <em>location code in a POST array</em>
          nullable: true
        language_code:
          type: string
          description: <em>language code in a POST array</em>
          nullable: true
        check_url:
          type: string
          description: <em>direct URL to search engine results</em><br>you can use it to make sure that we provided accurate results
          nullable: true
        datetime:
          type: string
          description: '<em>date and time when the result was received</em><br>in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”<br>example:<br><code class="long-string">2019-11-15 12:57:46 +00:00</code>'
          nullable: true
        spell:
          type: object
          oneOf:
            - $ref: '#/components/schemas/SpellInfo'
          description: '<em>autocorrection of the search engine</em><br>if the search engine provided results for a keyword that was corrected, we will specify the keyword corrected by the search engine and the type of autocorrection'
          nullable: true
        refinement_chips:
          type: object
          oneOf:
            - $ref: '#/components/schemas/RefinementChipsInfo'
          description: '<em>search refinement chips</em><br>in this case, the value will be <code>null</code>'
          nullable: true
        item_types:
          type: array
          items:
            type: string
            nullable: true
          description: '<em>types of search results in SERP</em><br>contains types of search results (<code>items</code>) found in SERP;<br>possible item types: <a href="#google_finance_hero_groups"><code>google_finance_hero_groups</code></a>, <a href="#google_finance_quote"><code>google_finance_quote</code></a>, <a href="#google_finance_compare_to"><code>google_finance_compare_to</code></a>, <a href="#google_finance_news"><code>google_finance_news</code></a>, <a href="#google_finance_financial"><code>google_finance_financial</code></a>, <a href="#google_finance_futures_chain"><code>google_finance_futures_chain</code></a>, <a href="#google_finance_details"><code>google_finance_details</code></a>, <a href="#google_finance_about"><code>google_finance_about</code></a>, <a href="#google_finance_interested"><code>google_finance_interested</code></a>, <a href="#google_finance_people_also_search"><code>google_finance_people_also_search</code>'
          nullable: true
        se_results_count:
          type: integer
          description: <em> total number of results in SERP</em>
          format: int64
          nullable: true
        items_count:
          type: integer
          description: <em>the number of results returned in the <strong><code>items</code></strong> array</em>
          format: int64
          nullable: true
        items:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/BaseSerpApiGoogleFinanceElementItem'
            nullable: true
          description: <em>market indexes related to the market trends element</em>
          nullable: true
    SerpGoogleFinanceQuoteTaskGetAdvancedTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleFinanceQuoteTaskGetAdvancedResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    SerpGoogleFinanceQuoteTaskGetAdvancedResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleFinanceQuoteTaskGetAdvancedTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    SerpGoogleFinanceQuoteTaskGetHtmlResultInfo:
      type: object
      properties:
        keyword:
          type: string
          description: <em>keyword received in a POST array<br></em><strong>keyword is returned with decoded %## (plus symbol '+' will be decoded to a space character)</strong>
          nullable: true
        type:
          type: string
          description: type of element
          nullable: true
        se_domain:
          type: string
          description: <em>search engine domain in a POST array</em>
          nullable: true
        location_code:
          type: integer
          description: <em>location code in a POST array</em>
          nullable: true
        language_code:
          type: string
          description: <em>language code in a POST array</em>
          nullable: true
        datetime:
          type: string
          description: '<em>date and time when the result was received</em><br>in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”<br>example:<br><code class="long-string">2019-11-15 12:57:46 +00:00</code>'
          nullable: true
        items_count:
          type: integer
          description: <em>the number of results returned in the <strong><code>items</code></strong> array</em>
          format: int64
          nullable: true
        items:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/HtmlItemInfo'
            nullable: true
          description: <em>elements of search results found in SERP</em>
          nullable: true
    SerpGoogleFinanceQuoteTaskGetHtmlTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleFinanceQuoteTaskGetHtmlResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    SerpGoogleFinanceQuoteTaskGetHtmlResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleFinanceQuoteTaskGetHtmlTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    SerpGoogleFinanceQuoteLiveAdvancedRequestInfo:
      type: object
      properties:
        keyword:
          type: string
          description: '<p><em>ticker or stock symbol</em><p><strong>required field</strong><p>in this field you can pass the ticker symbol of publicly traded shares of a particular stock or security on a particular stock exchange;<p>you can specify <strong>up to 700 characters</strong> in the <code>keyword</code> field;<p>all %## will be decoded (plus character ‘+’ will be decoded to a space character)<p>if you need to use the “%” character for your <code>keyword</code>, please specify it as “%25”;<p>if you need to use the “+” character for your <code>keyword</code>, please specify it as “%2B”;</p><br><p>learn more about rules and limitations of <code>keyword</code> and <code>keywords</code> fields in DataForSEO APIs in this <a href="https://dataforseo.com/help-center/rules-and-limitations-of-keyword-and-keywords-fields-in-dataforseo-apis" rel="noopener noreferrer" target="_blank">Help Center article</a></p>'
        location_code:
          type: integer
          description: '<p><em>search engine location code</em><p><strong>required field if you don''t specify <code>location_name</code></strong><p><strong>if you use this field, you don''t need to specify <code>location_name</code></strong><p>you can receive the list of available locations of the search engines with their <code>location_code</code> by making a separate request to <code>https://api.dataforseo.com/v3/serp/google/locations</code><p>example:<p><code class="long-string">2840</code></p>'
        language_code:
          type: string
          description: '<p><em>search engine language code</em><p><strong>required field if you don''t specify <code>language_name</code></strong><p><strong>if you use this field, you don''t need to specify <code>language_name</code></strong><p>you can receive the list of available languages of the search engine with their <code>language_code</code>&nbsp;by making a separate request to the <code>https://api.dataforseo.com/v3/serp/google/languages</code><em><p></em>example:<em><p></em><code class="long-string">en</code></p>'
        device:
          type: string
          description: '<p><em>device type</em><p>optional field<p>return results for a specific device type<p>possible value: <code>desktop</code></p>'
          nullable: true
        location_name:
          type: string
          description: '<p><em>full name of search engine location</em><p><strong>required field if you don''t specify <code>location_code</code></strong><p><strong>if you use this field, you don''t need to specify <code>location_code</code></strong><p>you can receive the list of available locations of the search engine with their <code>location_name</code> by making a separate request to  <code>https://api.dataforseo.com/v3/serp/google/locations</code><p>example:<p><code class="long-string">London,England,United Kingdom</code></p>'
        language_name:
          type: string
          description: '<p><em>full name of search engine language</em><p><strong>required field if you don''t specify <code>language_code</code> </strong><p><strong>if you use this field, you don''t need to specify <code>language_code</code></strong><p>you can receive the list of available languages of the search engine with their <code>language_name</code> by making a separate request to the <code>https://api.dataforseo.com/v3/serp/google/languages</code><p>example:<p><code class="long-string">English</code></p>'
        os:
          type: string
          description: '<p><em>device operating system</em><p>optional field<p>possible values: <code>windows</code></p>'
          nullable: true
        tag:
          type: string
          description: <p><em>user-defined task identifier</em><p>optional field<p><em>the character limit is 255</em><p>you can use this parameter to identify the task and match it with the result<p>you will find the specified <code>tag</code> value in the <code>data</code> object of the response</p>
          nullable: true
        window:
          type: string
          description: '<p><em>time window for <code>google_finance_quote</code> graph</em><p>optional field<p>possible values: <code>1D</code>, <code>5D</code>, <code>1M</code>, <code>6M</code>, <code>YTD</code>, <code>1Y</code>, <code>5Y</code>, <code>MAX</code><p>default value: <code>1D</code><p><strong>Note:</strong> if you specify a value that is different from <code>1D</code>, the charge per task will be multiplied by 2</p>'
          nullable: true
      example:
        - keyword: CLW00:NYMEX
          location_code: 2840
          language_name: English
    SerpGoogleFinanceQuoteLiveAdvancedResultInfo:
      type: object
      properties:
        keyword:
          type: string
          description: <em>keyword received in a POST array</em><br><strong>the keyword is returned with decoded %## (plus character '+' will be decoded to a space character)</strong>
          nullable: true
        type:
          type: string
          description: type of element
          nullable: true
        se_domain:
          type: string
          description: <em>search engine domain in a POST array</em>
          nullable: true
        location_code:
          type: integer
          description: <em>location code in a POST array</em>
          nullable: true
        language_code:
          type: string
          description: <em>language code in a POST array</em>
          nullable: true
        check_url:
          type: string
          description: <em>direct URL to search engine results</em><br>you can use it to make sure that we provided accurate results
          nullable: true
        datetime:
          type: string
          description: '<em>date and time when the result was received</em><br>in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”<br>example:<br><code class="long-string">2019-11-15 12:57:46 +00:00</code>'
          nullable: true
        spell:
          type: object
          oneOf:
            - $ref: '#/components/schemas/SpellInfo'
          description: '<em>autocorrection of the search engine</em><br>if the search engine provided results for a keyword that was corrected, we will specify the keyword corrected by the search engine and the type of autocorrection'
          nullable: true
        refinement_chips:
          type: object
          oneOf:
            - $ref: '#/components/schemas/RefinementChipsInfo'
          description: '<em>search refinement chips</em><br>in this case, the value will be <code>null</code>'
          nullable: true
        item_types:
          type: array
          items:
            type: string
            nullable: true
          description: '<em>types of search results in SERP</em><br>contains types of search results (<code>items</code>) found in SERP;<br>possible item types: <a href="#google_finance_hero_groups"><code>google_finance_hero_groups</code></a>, <a href="#google_finance_quote"><code>google_finance_quote</code></a>, <a href="#google_finance_compare_to"><code>google_finance_compare_to</code></a>, <a href="#google_finance_news"><code>google_finance_news</code></a>, <a href="#google_finance_financial"><code>google_finance_financial</code></a>, <a href="#google_finance_futures_chain"><code>google_finance_futures_chain</code></a>, <a href="#google_finance_details"><code>google_finance_details</code></a>, <a href="#google_finance_about"><code>google_finance_about</code></a>, <a href="#google_finance_interested"><code>google_finance_interested</code></a>, <a href="#google_finance_people_also_search"><code>google_finance_people_also_search</code>'
          nullable: true
        se_results_count:
          type: integer
          description: <em> total number of results in SERP</em>
          format: int64
          nullable: true
        items_count:
          type: integer
          description: <em>the number of results returned in the <strong><code>items</code></strong> array</em>
          format: int64
          nullable: true
        items:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/BaseSerpApiGoogleFinanceElementItem'
            nullable: true
          description: <em>elements of search results found in SERP</em>
          nullable: true
    SerpGoogleFinanceQuoteLiveAdvancedTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleFinanceQuoteLiveAdvancedResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    SerpGoogleFinanceQuoteLiveAdvancedResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleFinanceQuoteLiveAdvancedTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    SerpGoogleFinanceQuoteLiveHtmlRequestInfo:
      type: object
      properties:
        keyword:
          type: string
          description: '<p><em>ticker or stock symbol</em><p><strong>required field</strong><p>in this field you can pass the ticker symbol of publicly traded shares of a particular stock or security on a particular stock exchange;<p>you can specify <strong>up to 700 characters</strong> in the <code>keyword</code> field;<p>all %## will be decoded (plus character ‘+’ will be decoded to a space character)<p>if you need to use the “%” character for your <code>keyword</code>, please specify it as “%25”;<p>if you need to use the “+” character for your <code>keyword</code>, please specify it as “%2B”;</p><br><p>learn more about rules and limitations of <code>keyword</code> and <code>keywords</code> fields in DataForSEO APIs in this <a href="https://dataforseo.com/help-center/rules-and-limitations-of-keyword-and-keywords-fields-in-dataforseo-apis" rel="noopener noreferrer" target="_blank">Help Center article</a></p>'
        location_code:
          type: integer
          description: '<p><em>search engine location code</em><p><strong>required field if you don''t specify <code>location_name</code></strong><p><strong>if you use this field, you don''t need to specify <code>location_name</code></strong><p>you can receive the list of available locations of the search engines with their <code>location_code</code> by making a separate request to <code>https://api.dataforseo.com/v3/serp/google/locations</code><p>example:<p><code class="long-string">2840</code></p>'
        language_code:
          type: string
          description: '<p><em>search engine language code</em><p><strong>required field if you don''t specify <code>language_name</code></strong><p><strong>if you use this field, you don''t need to specify <code>language_name</code></strong><p>you can receive the list of available languages of the search engine with their <code>language_code</code>&nbsp;by making a separate request to the <code>https://api.dataforseo.com/v3/serp/google/languages</code><em><p></em>example:<em><p></em><code class="long-string">en</code></p>'
        device:
          type: string
          description: '<p><em>device type</em><p>optional field<p>return results for a specific device type<p>possible value: <code>desktop</code></p>'
          nullable: true
        location_name:
          type: string
          description: '<p><em>full name of search engine location</em><p><strong>required field if you don''t specify <code>location_code</code></strong><p><strong>if you use this field, you don''t need to specify <code>location_code</code></strong><p>you can receive the list of available locations of the search engine with their <code>location_name</code> by making a separate request to  <code>https://api.dataforseo.com/v3/serp/google/locations</code><p>example:<p><code class="long-string">London,England,United Kingdom</code></p>'
        language_name:
          type: string
          description: '<p><em>full name of search engine language</em><p><strong>required field if you don''t specify <code>language_code</code> </strong><p><strong>if you use this field, you don''t need to specify <code>language_code</code></strong><p>you can receive the list of available languages of the search engine with their <code>language_name</code> by making a separate request to the <code>https://api.dataforseo.com/v3/serp/google/languages</code><p>example:<p><code class="long-string">English</code></p>'
        os:
          type: string
          description: '<p><em>device operating system</em><p>optional field<p>possible values: <code>windows</code></p>'
          nullable: true
        tag:
          type: string
          description: <p><em>user-defined task identifier</em><p>optional field<p><em>the character limit is 255</em><p>you can use this parameter to identify the task and match it with the result<p>you will find the specified <code>tag</code> value in the <code>data</code> object of the response</p>
          nullable: true
        window:
          type: string
          description: '<p><em>time window for <code>google_finance_quote</code> graph</em><p>optional field<p>possible values: <code>1D</code>, <code>5D</code>, <code>1M</code>, <code>6M</code>, <code>YTD</code>, <code>1Y</code>, <code>5Y</code>, <code>MAX</code><p>default value: <code>1D</code></p>'
          nullable: true
      example:
        - language_code: en
          location_code: 2840
          keyword: NASDAQ-100
    SerpGoogleFinanceQuoteLiveHtmlResultInfo:
      type: object
      properties:
        keyword:
          type: string
          description: <em>keyword received in a POST array<br></em><strong>keyword is returned with decoded %## (plus character '+' will be decoded to a space character)</strong>
          nullable: true
        type:
          type: string
          description: type of element
          nullable: true
        se_domain:
          type: string
          description: <em>search engine domain in a POST array</em>
          nullable: true
        location_code:
          type: integer
          description: <em>location code in a POST array</em>
          nullable: true
        language_code:
          type: string
          description: <em>language code in a POST array</em>
          nullable: true
        datetime:
          type: string
          description: '<em>date and time when the result was received</em><br>in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”<br>example:<br><code class="long-string">2019-11-15 12:57:46 +00:00</code>'
          nullable: true
        items_count:
          type: integer
          description: <em>the number of results returned in the <strong><code>items</code></strong> array</em>
          format: int64
          nullable: true
        items:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/HtmlItemInfo'
            nullable: true
          description: <em>elements of search results found in SERP</em>
          nullable: true
    SerpGoogleFinanceQuoteLiveHtmlTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleFinanceQuoteLiveHtmlResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    SerpGoogleFinanceQuoteLiveHtmlResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleFinanceQuoteLiveHtmlTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    SerpGoogleFinanceTickerSearchTaskPostRequestInfo:
      type: object
      properties:
        keyword:
          type: string
          description: '<p><em>company or financial instrument name</em><p><strong>required field</strong><p>in this field, you can enter the name of a company or financial instrument to search for relevant tickers;<p>you can specify <strong>up to 700 characters</strong> in the <code>keyword</code> field;<p>all %## will be decoded (plus character ‘+’ will be decoded to a space character)<p>if you need to use the “%” character for your <code>keyword</code>, please specify it as “%25”;<p>if you need to use the “+” character for your <code>keyword</code>, please specify it as “%2B”;</p><br><p>learn more about rules and limitations of <code>keyword</code> and <code>keywords</code> fields in DataForSEO APIs in this <a href="https://dataforseo.com/help-center/rules-and-limitations-of-keyword-and-keywords-fields-in-dataforseo-apis" rel="noopener noreferrer" target="_blank">Help Center article</a></p>'
        location_code:
          type: integer
          description: '<p><em>search engine location code</em><p><strong>required field if you don''t specify <code>location_name</code></strong><p><strong>if you use this field, you don''t need to specify <code>location_name</code></strong><p>you can receive the list of available locations of the search engines with their <code>location_code</code> by making a separate request to <code>https://api.dataforseo.com/v3/serp/google/locations</code><p>example:<p><code class="long-string">2840</code></p>'
        language_code:
          type: string
          description: '<p><em>search engine language code</em><p><strong>required field if you don''t specify <code>language_name</code></strong><p><strong>if you use this field, you don''t need to specify <code>language_name</code></strong><p>you can receive the list of available languages of the search engine with their <code>language_code</code>&nbsp;by making a separate request to the <code>https://api.dataforseo.com/v3/serp/google/languages</code><em><p></em>example:<em><p></em><code class="long-string">en</code></p>'
        pingback_url:
          type: string
          description: '<p><em>notification URL of a completed task</em><p>optional field<p>when a task is completed we will notify you by GET request sent to the URL you have specified<p>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<p>example:<p><code>http://your-server.com/pingscript?id=$id</code><p><code>http://your-server.com/pingscript?id=$id&amp;tag=$tag</code><p><strong>Note:</strong> special characters in <code>pingback_url</code> will be urlencoded;<p>i.a., the <code>#</code> character will be encoded into <code>%23</code></p><br><p>learn more on our <a href="https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api" target="_blank" rel="noopener noreferrer">Help Center</a></p>'
          nullable: true
        postback_url:
          type: string
          description: '<p><em>URL for sending task results</em><p>optional field<p>once the task is completed, we will send a POST request with its results compressed in the <code>gzip</code> format to the <code>postback_url</code> you specified<p>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request<p>example:<p><code>http://your-server.com/postbackscript?id=$id</code><p><code>http://your-server.com/postbackscript?id=$id&amp;tag=$tag</code><p><strong>Note:</strong> special characters in <code>postback_url</code> will be urlencoded;<p>i.a., the <code>#</code> character will be encoded into <code>%23</code></p><br><p>learn more on our <a href="https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api" target="_blank" rel="noopener noreferrer">Help Center</a></p>'
          nullable: true
        postback_data:
          type: string
          description: '<p><em>postback_url datatype</em><p><strong>required field if you specify <code>postback_url</code></strong><p>corresponds to the datatype that will be sent to your server<p>possible values:: <code>advanced</code>, <code>html</code></p>'
        priority:
          type: integer
          description: <p><em>task priority</em><p>optional field<p>can take the following values:<p>1 – normal execution priority (set by default);<p>2 – high execution priority</p><br>You will be additionally charged for the tasks with high execution priority;<p>The cost can be calculated on the <a title="Pricing" href="https://dataforseo.com/pricing/serp/google-finance-serp-api" target="_blank" rel="noopener noreferrer">Pricing</a> page
          nullable: true
        location_name:
          type: string
          description: '<p><em>full name of search engine location</em><p><strong>required field if you don''t specify <code>location_code</code></strong><p><strong>if you use this field, you don''t need to specify <code>location_code</code></strong><p>you can receive the list of available locations of the search engine with their <code>location_name</code> by making a separate request to  <code>https://api.dataforseo.com/v3/serp/google/locations</code><p>example:<p><code class="long-string">London,England,United Kingdom</code></p>'
        language_name:
          type: string
          description: '<p><em>full name of search engine language</em><p><strong>required field if you don''t specify <code>language_code</code> </strong><p><strong>if you use this field, you don''t need to specify <code>language_code</code></strong><p>you can receive the list of available languages of the search engine with their <code>language_name</code> by making a separate request to the <code>https://api.dataforseo.com/v3/serp/google/languages</code><p>example:<p><code class="long-string">English</code></p>'
        tag:
          type: string
          description: <p><em>user-defined task identifier</em><p>optional field<p><em>the character limit is 255</em><p>you can use this parameter to identify the task and match it with the result<p>you will find the specified <code>tag</code> value in the <code>data</code> object of the response</p>
          nullable: true
        category:
          type: string
          description: '<p><em>category of financial instruments to search for</em><p>optional field<p>possible values: <code>all</code>, <code>stock</code>, <code>index</code>, <code>mutual_fund</code>, <code>currency</code>, <code>futures</code><p>default value: <code>all</code></p>'
          nullable: true
      example:
        - language_name: English
          location_code: 2840
          category: all
          keyword: DJ
          priority: 2
    SerpGoogleFinanceTickerSearchTaskPostTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: object
              description: '<em>array of results</em><br>in this case, the value will be <code>null</code>'
              nullable: true
    SerpGoogleFinanceTickerSearchTaskPostResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleFinanceTickerSearchTaskPostTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    SerpGoogleFinanceTickerSearchTasksReadyResultInfo:
      type: object
      properties:
        id:
          type: string
          description: <em>task identifier of the completed task</em><br><strong>unique task identifier in our system in the <a href="https://en.wikipedia.org/wiki/Universally_unique_identifier">UUID</a> format</strong>
          nullable: true
        se:
          type: string
          description: <em>search engine specified when setting the task</em>
          nullable: true
        se_type:
          type: string
          description: '<em>type of search engine</em><br>example: <code>{{low_se_type_under}}</code>'
          nullable: true
        date_posted:
          type: string
          description: <em>date when the task was posted (in the UTC format)</em>
          nullable: true
        tag:
          type: string
          description: <em>user-defined task identifier</em>
          nullable: true
        endpoint_regular:
          type: string
          description: '<em>URL for collecting the results of the SERP Regular task</em><br>if SERP Regular is not supported in the specified endpoint, the value will be <code>null</code>'
          nullable: true
        endpoint_advanced:
          type: string
          description: '<em>URL for collecting the results of the SERP Advanced task</em><br>if SERP Advanced is not supported in the specified endpoint, the value will be <code>null</code>'
          nullable: true
        endpoint_html:
          type: string
          description: '<em>URL for collecting the results of the SERP HTML task</em><br>if SERP HTML is not supported in the specified endpoint, the value will be <code>null</code>'
          nullable: true
    SerpGoogleFinanceTickerSearchTasksReadyTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleFinanceTickerSearchTasksReadyResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    SerpGoogleFinanceTickerSearchTasksReadyResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleFinanceTickerSearchTasksReadyTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    SerpApiGoogleFinanceAssetPairElementItem:
      type: object
      allOf:
        - type: object
          oneOf:
            - $ref: '#/components/schemas/BaseSerpApiGoogleFinanceTickerSearchElementItem'
          nullable: true
        - type: object
          properties:
            base_symbol:
              type: string
              description: '<em>identifier of the base asset in a pair</em><br>example: <code>EUR</code>'
              nullable: true
            quote_symbol:
              type: string
              description: '<em>identifier of the quote asset in a pair</em><br>example: <code>USD</code>'
              nullable: true
            base_display_name:
              type: string
              description: '<em>full name of the base asset in a pair</em><br>example: <code>Euro</code>'
              nullable: true
            quote_display_name:
              type: string
              description: '<em>full name of the base asset in a pair</em><br>example: <code>Euro</code>'
              nullable: true
            price:
              type: number
              description: <em>value of the base asset compared to the quote asset</em>
              nullable: true
            price_delta:
              type: number
              description: <em>change in price</em><br>change in <code>price</code> at a given <code>timestamp</code>
              nullable: true
    SerpApiGoogleFinanceMarketInstrumentElementItem:
      type: object
      allOf:
        - type: object
          oneOf:
            - $ref: '#/components/schemas/BaseSerpApiGoogleFinanceTickerSearchElementItem'
          nullable: true
        - type: object
          properties:
            ticker:
              type: string
              description: '<em>ticker of the market index</em><br>example: <code>DAX</code>'
              nullable: true
            price:
              type: number
              description: <em>value of the base asset compared to the quote asset</em>
              nullable: true
            price_delta:
              type: number
              description: <em>change in price</em><br>change in <code>price</code> at a given <code>timestamp</code>
              nullable: true
            price_currency:
              type: string
              description: '<em>price currency</em><br>example: <code>USD</code>'
              nullable: true
    SerpApiGoogleFinanceMarketIndexElementItem:
      type: object
      allOf:
        - type: object
          oneOf:
            - $ref: '#/components/schemas/BaseSerpApiGoogleFinanceTickerSearchElementItem'
          nullable: true
        - type: object
          properties:
            ticker:
              type: string
              description: '<em>ticker of the market index</em><br>example: <code>DAX</code>'
              nullable: true
            market_identifier:
              type: string
              description: '<em>market identifier</em><br>example: <code>INDEXDB</code>'
              nullable: true
            index_value:
              type: number
              description: <em>value of the market index</em><br>numerical value of the index at a given <code>timestamp</code>
              nullable: true
            index_value_delta:
              type: number
              description: <em>change in value of the market index</em><br>change in the <code>index_value</code> at a given <code>timestamp</code>
              nullable: true
    SerpGoogleFinanceTickerSearchTaskGetAdvancedResultInfo:
      type: object
      properties:
        keyword:
          type: string
          description: <em>keyword received in a POST array</em><br><strong>the keyword is returned with decoded %## (plus character '+' will be decoded to a space character)</strong>
          nullable: true
        type:
          type: string
          description: type of element
          nullable: true
        se_domain:
          type: string
          description: <em>search engine domain in a POST array</em>
          nullable: true
        location_code:
          type: integer
          description: <em>location code in a POST array</em>
          nullable: true
        language_code:
          type: string
          description: <em>language code in a POST array</em>
          nullable: true
        check_url:
          type: string
          description: <em>direct URL to search engine results</em><br>you can use it to make sure that we provided accurate results
          nullable: true
        datetime:
          type: string
          description: '<em>date and time when the result was received</em><br>in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”<br>example:<br><code class="long-string">2019-11-15 12:57:46 +00:00</code>'
          nullable: true
        spell:
          type: object
          oneOf:
            - $ref: '#/components/schemas/SpellInfo'
          description: '<em>autocorrection of the search engine</em><br>if the search engine provided results for a keyword that was corrected, we will specify the keyword corrected by the search engine and the type of autocorrection'
          nullable: true
        refinement_chips:
          type: object
          oneOf:
            - $ref: '#/components/schemas/RefinementChipsInfo'
          description: '<em>search refinement chips</em><br>in this case, the value will be <code>null</code>'
          nullable: true
        item_types:
          type: array
          items:
            type: string
            nullable: true
          description: '<em>types of search results in SERP</em><br>contains types of search results (<code>items</code>) found in SERP;<br>possible item types: <a href="#google_finance_market_index"><code>google_finance_market_index</code></a>, <a href="#google_finance_asset_pair"><code>google_finance_asset_pair</code></a>, <a href="#google_finance_market_instrument"><code>google_finance_market_instrument</code></a>'
          nullable: true
        se_results_count:
          type: integer
          description: <em> total number of results in SERP</em>
          format: int64
          nullable: true
        items_count:
          type: integer
          description: <em>the number of results returned in the <strong><code>items</code></strong> array</em>
          format: int64
          nullable: true
        items:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/BaseSerpApiGoogleFinanceTickerSearchElementItem'
            nullable: true
          description: '<em>items of search results found in SERP</em><br>array of items containing market indexes data;<br>possible <code>type</code> of items: <code>google_finance_market_index</code>, <code>google_finance_asset_pair</code>, <code>google_finance_market_instrument</code>'
          nullable: true
    SerpGoogleFinanceTickerSearchTaskGetAdvancedTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleFinanceTickerSearchTaskGetAdvancedResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    SerpGoogleFinanceTickerSearchTaskGetAdvancedResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleFinanceTickerSearchTaskGetAdvancedTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    SerpGoogleFinanceTickerSearchLiveAdvancedRequestInfo:
      type: object
      properties:
        keyword:
          type: string
          description: '<p><em>company or financial instrument name</em><p><strong>required field</strong><p>in this field, you can enter the name of a company or financial instrument to search for relevant tickers;<p>you can specify <strong>up to 700 characters</strong> in the <code>keyword</code> field;<p>all %## will be decoded (plus character ‘+’ will be decoded to a space character)<p>if you need to use the “%” character for your <code>keyword</code>, please specify it as “%25”;<p>if you need to use the “+” character for your <code>keyword</code>, please specify it as “%2B”;</p><br><p>learn more about rules and limitations of <code>keyword</code> and <code>keywords</code> fields in DataForSEO APIs in this <a href="https://dataforseo.com/help-center/rules-and-limitations-of-keyword-and-keywords-fields-in-dataforseo-apis" rel="noopener noreferrer" target="_blank">Help Center article</a></p>'
        location_code:
          type: integer
          description: '<p><em>search engine location code</em><p><strong>required field if you don''t specify <code>location_name</code></strong><p><strong>if you use this field, you don''t need to specify <code>location_name</code></strong><p>you can receive the list of available locations of the search engines with their <code>location_code</code> by making a separate request to <code>https://api.dataforseo.com/v3/serp/google/locations</code><p>example:<p><code class="long-string">2840</code></p>'
        language_code:
          type: string
          description: '<p><em>search engine language code</em><p><strong>required field if you don''t specify <code>language_name</code></strong><p><strong>if you use this field, you don''t need to specify <code>language_name</code></strong><p>you can receive the list of available languages of the search engine with their <code>language_code</code>&nbsp;by making a separate request to the <code>https://api.dataforseo.com/v3/serp/google/languages</code><em><p></em>example:<em><p></em><code class="long-string">en</code></p>'
        location_name:
          type: string
          description: '<p><em>full name of search engine location</em><p><strong>required field if you don''t specify <code>location_code</code></strong><p><strong>if you use this field, you don''t need to specify <code>location_code</code></strong><p>you can receive the list of available locations of the search engine with their <code>location_name</code> by making a separate request to  <code>https://api.dataforseo.com/v3/serp/google/locations</code><p>example:<p><code class="long-string">London,England,United Kingdom</code></p>'
        language_name:
          type: string
          description: '<p><em>full name of search engine language</em><p><strong>required field if you don''t specify <code>language_code</code> </strong><p><strong>if you use this field, you don''t need to specify <code>language_code</code></strong><p>you can receive the list of available languages of the search engine with their <code>language_name</code> by making a separate request to the <code>https://api.dataforseo.com/v3/serp/google/languages</code><p>example:<p><code class="long-string">English</code></p>'
        tag:
          type: string
          description: <p><em>user-defined task identifier</em><p>optional field<p><em>the character limit is 255</em><p>you can use this parameter to identify the task and match it with the result<p>you will find the specified <code>tag</code> value in the <code>data</code> object of the response</p>
          nullable: true
        category:
          type: string
          description: '<p><em>category of financial instruments to search for</em><p>optional field<p>possible values: <code>all</code>, <code>stock</code>, <code>index</code>, <code>mutual_fund</code>, <code>currency</code>, <code>futures</code><p>default value: <code>all</code></p>'
          nullable: true
      example:
        - language_name: English
          location_code: 2840
          category: all
          keyword: DJ
    SerpGoogleFinanceTickerSearchLiveAdvancedResultInfo:
      type: object
      properties:
        keyword:
          type: string
          description: <em>keyword received in a POST array</em><br><strong>the keyword is returned with decoded %## (plus character '+' will be decoded to a space character)</strong>
          nullable: true
        type:
          type: string
          description: type of element
          nullable: true
        se_domain:
          type: string
          description: <em>search engine domain in a POST array</em>
          nullable: true
        location_code:
          type: integer
          description: <em>location code in a POST array</em>
          nullable: true
        language_code:
          type: string
          description: <em>language code in a POST array</em>
          nullable: true
        check_url:
          type: string
          description: <em>direct URL to search engine results</em><br>you can use it to make sure that we provided accurate results
          nullable: true
        datetime:
          type: string
          description: '<em>date and time when the result was received</em><br>in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”<br>example:<br><code class="long-string">2019-11-15 12:57:46 +00:00</code>'
          nullable: true
        spell:
          type: object
          oneOf:
            - $ref: '#/components/schemas/SpellInfo'
          description: '<em>autocorrection of the search engine</em><br>if the search engine provided results for a keyword that was corrected, we will specify the keyword corrected by the search engine and the type of autocorrection'
          nullable: true
        refinement_chips:
          type: object
          oneOf:
            - $ref: '#/components/schemas/RefinementChipsInfo'
          description: '<em>search refinement chips</em><br>in this case, the value will be <code>null</code>'
          nullable: true
        item_types:
          type: array
          items:
            type: string
            nullable: true
          description: '<em>types of search results in SERP</em><br>contains types of search results (<code>items</code>) found in SERP;<br>possible item types: <a href="#google_finance_market_index"><code>google_finance_market_index</code></a>, <a href="#google_finance_asset_pair"><code>google_finance_asset_pair</code></a>, <a href="#google_finance_market_instrument"><code>google_finance_market_instrument</code></a>'
          nullable: true
        se_results_count:
          type: integer
          description: <em> total number of results in SERP</em>
          format: int64
          nullable: true
        items_count:
          type: integer
          description: <em>the number of results returned in the <strong><code>items</code></strong> array</em>
          format: int64
          nullable: true
        items:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/BaseSerpApiGoogleFinanceTickerSearchElementItem'
            nullable: true
          description: '<em>items of search results found in SERP</em><br>array of items containing market indexes data;<br>possible <code>type</code> of items: <code>google_finance_market_index</code>, <code>google_finance_asset_pair</code>, <code>google_finance_market_instrument</code>'
          nullable: true
    SerpGoogleFinanceTickerSearchLiveAdvancedTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleFinanceTickerSearchLiveAdvancedResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    SerpGoogleFinanceTickerSearchLiveAdvancedResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SerpGoogleFinanceTickerSearchLiveAdvancedTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    DataforseoLabsIdListRequestInfo:
      type: object
      properties:
        datetime_from:
          type: string
          description: '<em>start time for filtering results</em><br><strong>required field</strong><br>if <code>include_metadata</code> is set to <code>true</code>, maximum value: a month from current datetime;<br>if <code>include_metadata</code> is set to <code>false</code>, maximum value: six months from current datetime;<br>must be specified in the UTC format: "yyyy-mm-dd hh-mm-ss +00:00"<br>example:<br><code>2023-01-15 12:57:46 +00:00</code>'
        datetime_to:
          type: string
          description: '<em>finish time for filtering results</em><br><strong>required field</strong><br>maximum value: current datetime;<br>must be specified in the UTC format: "yyyy-mm-dd hh-mm-ss +00:00"<br>example:<br><code>2023-01-31 13:57:46 +00:00</code>'
        limit:
          type: integer
          description: '<em>the maximum number of returned task IDs</em><br>optional field<br>default value: <code>1000</code><br>maximum value: <code>1000</code>'
          nullable: true
        offset:
          type: integer
          description: '<em>offset in the results array of returned task IDs</em><br>optional field<br>default value: <code>0</code><br>if you specify the <code>10</code> value, the first ten tasks in the results array will be omitted'
          nullable: true
        sort:
          type: string
          description: '<em>sorting by task execution time</em><br>optional field<br>possible values: <code>"asc"</code>, <code>"desc"</code><br>default value: <code>"asc"</code>'
          nullable: true
        include_metadata:
          type: boolean
          description: '<em>include task metadata in the respond</em><br>optional field<br>default value: <code>false</code>'
          nullable: true
      example:
        - datetime_from: '2026-09-10 11:12:35'
          datetime_to: '2026-09-20 11:12:35'
          limit: 10
          include_metadata: true
    DataforseoLabsIdListResultInfo:
      type: object
      properties:
        id:
          type: string
          description: <em>task identifier</em><br><strong>unique task identifier in our system in the <a href="https://en.wikipedia.org/wiki/Universally_unique_identifier">UUID</a> format</strong>
          nullable: true
        url:
          type: string
          description: <em>URL of the task</em><br>URL you used for making an API call
          nullable: true
        datetime_posted:
          type: string
          description: '<em>date and time when the task was made</em><br>in the UTC format: "yyyy-mm-dd hh-mm-ss +00:00"<br>example:<br><code>2023-01-15 12:57:46 +00:00</code>'
          nullable: true
        datetime_done:
          type: string
          description: '<em>date and time when the task was completed</em><br>in the UTC format: "yyyy-mm-dd hh-mm-ss +00:00"<br>example:<br><code>2023-01-15 12:57:46 +00:00</code>'
          nullable: true
        status:
          type: string
          description: <em>informational message of the task</em><br>you can find the full list of general informational messages <a href="/v3/appendix-errors/">here</a>
          nullable: true
        cost:
          type: number
          description: '<em>total tasks cost, USD</em>'
          nullable: true
        metadata:
          type: object
          additionalProperties:
            type: object
            nullable: true
          description: <em>contains parameters you specified in the POST request</em>
          nullable: true
    DataforseoLabsIdListTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/DataforseoLabsIdListResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    DataforseoLabsIdListResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/DataforseoLabsIdListTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    DataforseoLabsStatusInfo:
      type: object
      properties:
        date_update:
          type: string
          description: <em>update date of the Google endpoints</em><br>indicates the last date when the Google endpoints of DataForSEO Labs API were updated;<br>example:<br><code>2022-05-16</code>
          nullable: true
    DataforseoLabsStatusResultInfo:
      type: object
      properties:
        google:
          type: object
          oneOf:
            - $ref: '#/components/schemas/DataforseoLabsStatusInfo'
          description: <em>update information for the Google endpoints</em>
          nullable: true
        bing:
          type: object
          oneOf:
            - $ref: '#/components/schemas/DataforseoLabsStatusInfo'
          description: <em>update information for the Bing endpoints</em>
          nullable: true
        amazon:
          type: object
          oneOf:
            - $ref: '#/components/schemas/DataforseoLabsStatusInfo'
          description: <em>update information for the Amazon endpoints</em>
          nullable: true
    DataforseoLabsStatusTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/DataforseoLabsStatusResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    DataforseoLabsStatusResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/DataforseoLabsStatusTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    DataforseoLabsErrorsRequestInfo:
      type: object
      properties:
        limit:
          type: integer
          description: '<em>the maximum number of returned tasks that responded with an error</em><br>optional field<br>default value: <code>1000</code><br>maximum value: <code>1000</code>'
          nullable: true
        offset:
          type: integer
          description: '<em>offset in the results array of returned tasks</em><br>optional field<br>default value: <code>0</code><br>if you specify the <code>10</code> value, the first ten tasks in the results array will be omitted and the data will be provided for the successive tasks'
          nullable: true
        filtered_function:
          type: string
          description: '<em>return tasks with a certain function</em><br>use this field to obtain a list of tasks that returned an error filtered by a certain function<br>you can filter the results by the values you receive in the <code>function</code> fields of the API response<br>i.e., once you receive unfiltered results, you can call this API again to filter them by <code>function</code> <br>example: <code>dataforseo_labs/related_keywords/live</code>'
          nullable: true
        datetime_from:
          type: string
          description: '<em>start time for filtering results</em><br>optional field<br>allows filtering results by the <code>datetime</code> parameter within the range of the last 7 days;<br>must be specified in the UTC format: "yyyy-mm-dd hh-mm-ss +00:00"<br>example:<br><code>2021-11-15 12:57:46 +00:00</code>'
          nullable: true
        datetime_to:
          type: string
          description: '<em>finish time for filtering results</em><br>optional field<br>allows filtering results by the <code>datetime</code> parameter within the range of the last 7 days;<br>must be specified in the UTC format: "yyyy-mm-dd hh-mm-ss +00:00"<br>example:<br><code>2021-11-15 13:57:46 +00:00</code>'
          nullable: true
      example:
        - limit: 10
    DataforseoLabsErrorsResultInfo:
      type: object
      properties:
        id:
          type: string
          description: <em>task identifier</em><br><strong>unique task identifier in our system in the <a href="https://en.wikipedia.org/wiki/Universally_unique_identifier">UUID</a> format</strong>
          nullable: true
        datetime:
          type: string
          description: '<em>date and time when an error occurred</em><br>in the UTC format: "yyyy-mm-dd hh-mm-ss +00:00"<br>example:<br><code>2019-11-15 12:57:46 +00:00</code>'
          nullable: true
        function:
          type: string
          description: <em>corresponding API function</em>
          nullable: true
        error_code:
          type: integer
          description: <em>error code</em>
          nullable: true
        error_message:
          type: string
          description: <em>error message or error URL</em><br>error message <a href="https://docs.dataforseo.com/v3/appendix/errors/" rel="noopener noreferrer" target="_blank">(see full list)</a> or URL that caused an error
          nullable: true
        http_url:
          type: string
          description: <em>URL that caused an error</em><br>URL you used for making an API call
          nullable: true
        http_method:
          type: string
          description: <em>HTTP method</em>
          nullable: true
        http_code:
          type: integer
          description: <em>HTTP status code</em>
          nullable: true
        http_time:
          type: number
          description: <em>time taken by HTTP request</em>
          nullable: true
        http_response:
          type: string
          description: <em>HTTP response</em><br>server response
          nullable: true
    DataforseoLabsErrorsTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/DataforseoLabsErrorsResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    DataforseoLabsErrorsResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/DataforseoLabsErrorsTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    DataforseoLabsAvailableFiltersResultInfo:
      type: object
      properties:
        related_keywords:
          type: object
          additionalProperties:
            type: object
            additionalProperties:
              type: string
              nullable: true
            nullable: true
          nullable: true
        keyword_suggestions:
          type: object
          additionalProperties:
            type: object
            additionalProperties:
              type: string
              nullable: true
            nullable: true
          nullable: true
        ranked_keywords:
          type: object
          additionalProperties:
            type: object
            additionalProperties:
              type: string
              nullable: true
            nullable: true
          nullable: true
        keyword_ideas:
          type: object
          additionalProperties:
            type: object
            additionalProperties:
              type: string
              nullable: true
            nullable: true
          nullable: true
        serp_competitors:
          type: object
          additionalProperties:
            type: object
            additionalProperties:
              type: string
              nullable: true
            nullable: true
          nullable: true
        relevant_pages:
          type: object
          additionalProperties:
            type: object
            additionalProperties:
              type: string
              nullable: true
            nullable: true
          nullable: true
        subdomains:
          type: object
          additionalProperties:
            type: object
            additionalProperties:
              type: string
              nullable: true
            nullable: true
          nullable: true
        competitors_domain:
          type: object
          additionalProperties:
            type: object
            additionalProperties:
              type: string
              nullable: true
            nullable: true
          nullable: true
        categories_for_domain:
          type: object
          additionalProperties:
            type: object
            additionalProperties:
              type: string
              nullable: true
            nullable: true
          nullable: true
        keywords_for_categories:
          type: object
          additionalProperties:
            type: object
            additionalProperties:
              type: string
              nullable: true
            nullable: true
          nullable: true
        domain_intersection:
          type: object
          additionalProperties:
            type: object
            additionalProperties:
              type: string
              nullable: true
            nullable: true
          nullable: true
        page_intersection:
          type: object
          additionalProperties:
            type: object
            additionalProperties:
              type: string
              nullable: true
            nullable: true
          nullable: true
        top_searches:
          type: object
          additionalProperties:
            type: object
            additionalProperties:
              type: string
              nullable: true
            nullable: true
          nullable: true
        domain_metrics_by_categories:
          type: object
          additionalProperties:
            type: object
            additionalProperties:
              type: string
              nullable: true
            nullable: true
          nullable: true
        keywords_for_site:
          type: object
          additionalProperties:
            type: object
            additionalProperties:
              type: string
              nullable: true
            nullable: true
          nullable: true
        product_competitors:
          type: object
          additionalProperties:
            type: object
            additionalProperties:
              type: string
              nullable: true
            nullable: true
          nullable: true
        product_keyword_intersections:
          type: object
          additionalProperties:
            type: object
            additionalProperties:
              type: string
              nullable: true
            nullable: true
          nullable: true
        app_intersection:
          type: object
          additionalProperties:
            type: object
            additionalProperties:
              type: string
              nullable: true
            nullable: true
          nullable: true
        app_competitors:
          type: object
          additionalProperties:
            type: object
            additionalProperties:
              type: string
              nullable: true
            nullable: true
          nullable: true
        keywords_for_app:
          type: object
          additionalProperties:
            type: object
            additionalProperties:
              type: string
              nullable: true
            nullable: true
          nullable: true
        database_rows_count:
          type: object
          additionalProperties:
            type: string
            nullable: true
          nullable: true
    DataforseoLabsAvailableFiltersTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/DataforseoLabsAvailableFiltersResultInfo'
                nullable: true
              description: <em>array of results</em><br>contains the full list of available parameters that can be used for data filtration<br>the parameters are grouped by the endpoint they can be used with
              nullable: true
    DataforseoLabsAvailableFiltersResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/DataforseoLabsAvailableFiltersTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    AvailableLanguages:
      type: object
      properties:
        available_sources:
          type: array
          items:
            type: string
            nullable: true
          description: <em>supported sources</em><br>contains the sources of data supported for a specific location and language combination<br>only <code>google</code> and <code>bing</code> are currently available
          nullable: true
        language_name:
          type: string
          description: <em>language name</em>
          nullable: true
        language_code:
          type: string
          description: <em>language code according to <a href="https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes" target="_blank" rel="noopener noreferrer">ISO 639-1</a></em>
          nullable: true
        keywords:
          type: integer
          description: <em>the number of keywords available for the given location and language
          nullable: true
        serps:
          type: integer
          description: <em>the number of SERP pages available for the given location and language
          nullable: true
    DataforseoLabsLocationsAndLanguagesResultInfo:
      type: object
      properties:
        location_code:
          type: integer
          description: <em>location code</em>
        location_name:
          type: string
          description: <em>full name of the location</em>
          nullable: true
        location_code_parent:
          type: integer
          description: <em>the code of the superordinate location</em><br>the value will be <code>null</code> as <code>Country</code> is the only supported <code>location_type</code> for this API
          nullable: true
        country_iso_code:
          type: string
          description: <em>ISO country code of the location</em>
          nullable: true
        location_type:
          type: string
          description: <em>location type</em><br>possible values:<br><code>Country</code>
          nullable: true
        available_languages:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/AvailableLanguages'
            nullable: true
          description: <em>supported languages</em><br>contains the languages which are supported for a specific location
          nullable: true
    DataforseoLabsLocationsAndLanguagesTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/DataforseoLabsLocationsAndLanguagesResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    DataforseoLabsLocationsAndLanguagesResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/DataforseoLabsLocationsAndLanguagesTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    DataforseoLabsCategoriesResultInfo:
      type: object
      properties:
        category_code:
          type: integer
          description: <em>category code</em>
          nullable: true
        category_name:
          type: string
          description: <em>full name of the category</em>
          nullable: true
        category_code_parent:
          type: integer
          description: '<em>the code of the superordinate category</em><br>example:<br>`"category_code": 10178`,<br>`"category_name": "Apparel Accessories"`,<br>`"category_code_parent": 10021`<br>where `category_code_parent`<br>corresponds to: <br>`"category_code": 10021`,<br>`"category_name": "Apparel"`<br>`"category_code_parent": null`'
          nullable: true
    DataforseoLabsCategoriesTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/DataforseoLabsCategoriesResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    DataforseoLabsCategoriesResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/DataforseoLabsCategoriesTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    DataforseoLabsGoogleAvailableHistoryResultInfo:
      type: object
      properties:
        date:
          type: string
          description: available dateindicates the date of the range available for setting in the Domain Metrics by Categories endpointexample:2022-05-16
          nullable: true
    DataforseoLabsGoogleAvailableHistoryTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/DataforseoLabsGoogleAvailableHistoryResultInfo'
                nullable: true
              description: array of objects containing results
              nullable: true
    DataforseoLabsGoogleAvailableHistoryResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/DataforseoLabsGoogleAvailableHistoryTaskInfo'
                nullable: true
              description: array of tasks
              nullable: true
    DataforseoLabsGoogleKeywordsForSiteLiveRequestInfo:
      type: object
      properties:
        target:
          type: string
          description: '<em>domain name or page url</em><br><strong>required field</strong><br>the domain name of the target website, subdomain or URL of the target webpage;<br>the <strong>domain name</strong> must be specified <strong>without</strong> <code>https://</code> or <code>www.</code>;<br>the <strong>subdomain</strong> must be specified <strong>without</strong> <code>https://</code>;<br>the <strong>webpage URL</strong> must be specified <strong>with</strong> <code>https://</code> or <code>www.</code><br><strong>Note:</strong> if you specify the <strong>webpage URL</strong> without <code>https://</code> or <code>www.</code>, the result will be returned for the <strong>entire domain</strong> rather than the specific page'
        location_name:
          type: string
          description: <em>full name of the location</em><br><strong>required field if you don't specify</strong> <code>location_code</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_name</code> by making a separate request to the<br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class="long-string">United Kingdom</code>
        location_code:
          type: integer
          description: <em>unique location identifier</em><br><strong>required field if you don't specify</strong> <code>location_name</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_code</code> by making a separate request to the<br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class="long-string">2840</code>
        language_name:
          type: string
          description: '<em>full name of the language</em><br>optional field<br>if you use this field, you don''t need to specify <code>language_code</code><br>you can receive the list of available languages with their <code>language_name</code> by making a separate request to the<br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class="long-string">English</code><br><strong>Note:</strong> if omitted, results default to the language with the most keyword records in the specified location;<br>refer to the <code>available_languages.keywords</code> field of the <a href="https://docs.dataforseo.com/v3/dataforseo_labs/locations_and_languages" target="_blank">Locations and Languages endpoint</a> to determine the default language'
          nullable: true
        language_code:
          type: string
          description: '<em>language code</em><br>optional field<br>if you use this field, you don''t need to specify <code>language_name</code><br>you can receive the list of available languages with their <code>language_code</code> by making a separate request to the<br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class="long-string">en</code><br><strong>Note:</strong> if omitted, results default to the language with the most keyword records in the specified location;<br>refer to the <code>available_languages.keywords</code> field of the <a href="https://docs.dataforseo.com/v3/dataforseo_labs/locations_and_languages" target="_blank">Locations and Languages endpoint</a> to determine the default language'
          nullable: true
        include_serp_info:
          type: boolean
          description: '<em>include data from SERP for each keyword</em><br>optional field<br>if set to <code>true</code>, we will return a <code>serp_info</code> array containing SERP data (number of search results, relevant URL, and SERP features) for every keyword in the response<br>default value: <code>false</code>'
          nullable: true
        include_subdomains:
          type: boolean
          description: '<em>indicates if the subdomains will be included in the search</em><br>optional field<br>if set to <code>false</code>, the subdomains will be ignored<br>default value: <code>true</code>'
          nullable: true
        include_clickstream_data:
          type: boolean
          description: '<em>include or exclude data from clickstream-based metrics in the result</em><br>optional field<br>if the parameter is set to_<code>true</code>, you will receive <code>clickstream_keyword_info</code>, <code>keyword_info_normalized_with_clickstream</code>, and <code>keyword_info_normalized_with_bing</code> fields in the response<br>default value: <code>false</code><br>with this parameter enabled, you will be charged double the price for the request<p>learn more about how clickstream-based metrics are calculated in this <a href="https://dataforseo.com/help-center/what-are-clickstream-based-metrics-and-how-do-we-calculate-them" rel="noopener noreferrer" target="_blank">help center article</a>'
          nullable: true
        limit:
          type: integer
          description: '<em>the maximum number of keywords in the results array</em><br>optional field<br>default value: <code>100</code><br>maximum value: <code>1000</code>'
          nullable: true
        offset:
          type: integer
          description: '<em>offset in the results array of returned keywords</em><br>optional field<br>default value: <code>0</code><br>if you specify the <code>10</code> value, the first ten keywords in the results array will be omitted and the data will be provided for the successive keywords<br><strong>Note:</strong> we recommend using this parameter only when retrieving up to 10,000 results<br>for retrieving over 10,000 results, use the <code>offset_token</code> instead.'
          nullable: true
        offset_token:
          type: string
          description: '<em>offset token for subsequent requests</em><br>optional field<br>provided in the identical filed of the response to each request;<br>use this parameter to avoid timeouts while trying to obtain over 10,000 results in a single request;<br>by specifying the unique <code>offset_token</code> value from the response array, you will get the subsequent results of the initial task;<br><code>offset_token</code> values are unique for each subsequent task<br><strong>Note:</strong> if the <code>offset_token</code> is specified in the request, all other parameters except <code>limit</code> will not be taken into account when processing a task.<br>learn more about this parameter on our <a href="https://dataforseo.com/help-center/what-is-the-difference-between-the-offset-and-offset_token-parameters#offset_token" target="_blank">Help Center</a>'
          nullable: true
        filters:
          type: array
          items:
            type: object
            nullable: true
          description: '<em>array of results filtering parameters</em><br>optional field<br><strong>you can add several filters at once (8 filters maximum)</strong><br>you should set a logical operator <code>and</code>, <code>or</code> between the conditions<br>the following operators are supported:<br><code>regex</code>, <code>not_regex</code>, <code>&lt;</code>, <code>&lt;=</code>, <code>&gt;</code>, <code>&gt;=</code>, <code>=</code>, <code>&lt;&gt;</code>, <code>in</code>, <code>not_in</code>, <code>match</code>, <code>not_match</code>, <code>ilike</code>, <code>not_ilike</code>, <code>like</code>, <code>not_like</code><br>you can use the <code>%</code> operator with <code>like</code> and <code>not_like</code>, as well as <code>ilike</code> and <code>not_ilike</code> to match any string of zero or more characters<br><strong>note that you can not filter the results by <code>relevance</code></strong><br>example:<br><code>["keyword_info.search_volume","&gt;",0]</code><br>for more information about filters, please refer to <a href="/v3/dataforseo_labs/filters" target="_blank" rel="noopener noreferrer">Dataforseo Labs - Filters</a> or this <a href="https://dataforseo.com/help-center/how-to-use-filters-in-dataforseo-labs-api" target="_blank" rel="noopener noreferrer">help center guide</a>'
          nullable: true
        order_by:
          type: array
          items:
            type: string
          description: '<em>results sorting rules</em><br>optional field<br>you can use the same values as in the <code>filters</code> array to sort the results<br>possible sorting types:<br><code>asc</code> - results will be sorted in the ascending order<br><code>desc</code> - results will be sorted in the descending order<br>you should use a comma to set up a sorting parameter<p>default rule:<br><code>["relevance,desc"]</code><br>relevance is used as the default sorting rule to provide you with the closest keyword ideas. We recommend using this sorting rule to get highly-relevant search terms. <strong>Note</strong> that <code>relevance</code> is only our internal system identifier, so <strong>it can not be used as a filter</strong>, and you will not find this field in the <code>result</code> array. The relevance score is based on a similar principle as used in <a href="/v3/keywords_data/google/keywords_for_keywords/live/?php">the Keywords For Keywords</a> endpoint.<strong>note that you can set no more than three sorting rules in a single request</strong><br>you should use a comma to separate several sorting rules<br>example:<br><code>["relevance,desc","keyword_info.search_volume,desc"]</code>'
          nullable: true
        tag:
          type: string
          description: <em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response
          nullable: true
      example:
        - target: apple.com
          language_code: en
          location_code: 2840
          include_serp_info: true
          include_subdomains: true
          filters:
            - serp_info.se_results_count
            - '>'
            - 0
          limit: 3
    SearchVolumeTrend:
      type: object
      properties:
        monthly:
          type: integer
          description: <em>search volume change in percent compared to the previous month</em>
          nullable: true
        quarterly:
          type: integer
          description: <em>search volume change in percent compared to the previous quarter</em>
          nullable: true
        yearly:
          type: integer
          description: <em>search volume change in percent compared to the previous year</em>
          nullable: true
    KeywordInfo:
      type: object
      properties:
        se_type:
          type: string
          description: <em>search engine type</em>
          nullable: true
        last_updated_time:
          type: string
          description: '<em>date and time when keyword data was updated</em><br>in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”<br>example:<br><code class="long-string">2019-11-15 12:57:46 +00:00</code>'
          nullable: true
        competition:
          type: number
          description: <em>competition</em><br>represents the relative amount of competition associated with the given keyword. This value is based on Google Ads data and can be between 0 and 1 (inclusive)
          nullable: true
        competition_level:
          type: string
          description: '<em>competition level</em><br>represents the relative level of competition associated with the given keyword in paid SERP only;<br>possible values: <code>LOW</code>, <code>MEDIUM</code>, <code>HIGH</code><br>if competition level is unknown, the value is <code>null</code>;<br>learn more about the metric in <a href="https://dataforseo.com/help-center/what-is-competition" target="_blank" rel="noopener noreferrer">this help center article</a>'
          nullable: true
        cpc:
          type: number
          description: <em>cost-per-click</em><br>represents the average cost per click (USD) historically paid for the keyword
          nullable: true
        search_volume:
          type: integer
          description: <em>average monthly search volume rate</em><br>represents the (approximate) number of searches for the given keyword idea on google.com
          format: int64
          nullable: true
        low_top_of_page_bid:
          type: number
          description: <em>minimum bid for the ad to be displayed at the top of the first page</em><br>indicates the value greater than about 20% of the lowest bids for which ads were displayed (based on Google Ads statistics for advertisers)<br>the value may differ depending on the location specified in a POST request
          nullable: true
        high_top_of_page_bid:
          type: number
          description: <em>maximum bid for the ad to be displayed at the top of the first page</em><br>indicates the value greater than about 80% of the lowest bids for which ads were displayed (based on Google Ads statistics for advertisers)<br>the value may differ depending on the location specified in a POST request
          nullable: true
        categories:
          type: array
          items:
            type: integer
          description: <em>product and service categories</em><br>you can download the <a href="https://cdn.dataforseo.com/v3/categories/categories_dataforseo_labs_2023_10_25.csv">full list of possible categories</a>
          nullable: true
        monthly_searches:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/MonthlySearchesInfo'
            nullable: true
          description: '<em>monthly searches</em><br>represents the (approximate) number of searches on this keyword idea (as available for the past twelve months), targeted to the specified geographic locations'
          nullable: true
        search_volume_trend:
          type: object
          oneOf:
            - $ref: '#/components/schemas/SearchVolumeTrend'
          description: <em>search volume trend changes</em><br>represents search volume change in percent compared to the previous period
          nullable: true
    KeywordProperties:
      type: object
      properties:
        se_type:
          type: string
          description: <em>search engine type</em>
          nullable: true
        core_keyword:
          type: string
          description: '<em>main keyword in a group</em><br>contains the main keyword in a group determined by the synonym clustering algorithm<br>if the value is <code>null</code>, our database does not contain any keywords the corresponding algorithm could identify as synonymous with <code>keyword</code>'
          nullable: true
        synonym_clustering_algorithm:
          type: string
          description: '<em>the algorithm used to identify synonyms</em><br>possible values:<br><code>keyword_metrics</code> - indicates the algorithm based on <code>keyword_info</code> parameters<br><code>text_processing</code> - indicates the text-based algorithm<br>if the value is <code>null</code>, our database does not contain any keywords the corresponding algorithm could identify as synonymous with <code>keyword</code>'
          nullable: true
        keyword_difficulty:
          type: integer
          description: '<em>difficulty of ranking in the first top-10 organic results for a keyword</em><br>indicates the chance of getting in top-10 organic results for a keyword on a logarithmic scale from 0 to 100;<br>calculated by analysing, among other parameters, link profiles of the first 10 pages in SERP;<br>learn more about the metric in <a href="https://dataforseo.com/help-center/what-is-keyword-difficulty-and-how-is-it-calculated" target="_blank" rel="noopener noreferrer">this help center guide</a>'
          nullable: true
        detected_language:
          type: string
          description: <em>detected language of the keyword</em><br>indicates the language of the keyword as identified by our system
          nullable: true
        is_another_language:
          type: boolean
          description: '<em>detected language of the keyword is different from the set language</em><br>if <code>true</code>, the language set in the request does not match the language determined by our system for a given keyword'
          nullable: true
        words_count:
          type: integer
          description: <em>number of words in the keyword</em><br>indicates how many words the keyword consists of
          format: int64
          nullable: true
    SerpInfo:
      type: object
      properties:
        se_type:
          type: string
          description: <em>search engine type</em>
          nullable: true
        check_url:
          type: string
          description: <em>direct URL to search engine results</em><br>you can use it to make sure that we provided accurate results
          nullable: true
        serp_item_types:
          type: array
          items:
            type: string
            nullable: true
          description: '<em>types of search results in SERP</em><br>contains types of search results (items) found in SERP<br>possible item types:<br><code>answer_box</code>, <code>app</code>, <code>carousel</code>, <code>multi_carousel</code>, <code>featured_snippet</code>, <code>google_flights</code>, <code>google_reviews</code>, <code>third_party_reviews</code>, <code>google_posts</code>, <code>images</code>, <code>jobs</code>, <code>knowledge_graph</code>, <code>local_pack</code>, <code>hotels_pack</code>, <code>map</code>, <code>organic</code>, <code>paid</code>, <code>people_also_ask</code>, <code>related_searches</code>, <code>people_also_search</code>, <code>shopping</code>, <code>top_stories</code>, <code>twitter</code>, <code>video</code>, <code>events</code>, <code>mention_carousel</code>, <code>recipes</code>, <code>top_sights</code>, <code>scholarly_articles</code>, <code>popular_products</code>, <code>podcasts</code>, <code>questions_and_answers</code>, <code>find_results_on</code>, <code>stocks_box</code>, <code>visual_stories</code>, <code>commercial_units</code>, <code>local_services</code>, <code>google_hotels</code>, <code>math_solver</code>, <code>currency_box</code>, <code>product_considerations</code>, <code>found_on_web</code>, <code>short_videos</code>, <code>refine_products</code>, <code>explore_brands</code>, <code>perspectives</code>, <code>discussions_and_forums</code>, <code>compare_sites</code>, <code>courses</code>, <code>ai_overview</code>;<br><strong>note</strong> that the actual results will be returned only for <code>organic</code>, <code>paid</code>, <code>featured_snippet</code>, and <code>local_pack</code> elements'
          nullable: true
        se_results_count:
          type: integer
          description: <em>number of search results for the returned keyword</em>
          format: int64
          nullable: true
        last_updated_time:
          type: string
          description: '<em>date and time when keyword data was updated</em><br>in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”<br>example:<br><code class="long-string">2019-11-15 12:57:46 +00:00</code>'
          nullable: true
        previous_updated_time:
          type: string
          description: '<em>previous to the most recent date and time when SERP data was updated</em><br>in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”<br>example:<br><code class="long-string">2019-10-15 12:57:46 +00:00</code>'
          nullable: true
    AvgBacklinksInfo:
      type: object
      properties:
        se_type:
          type: string
          description: <em>search engine type</em>
          nullable: true
        backlinks:
          type: number
          description: <em>average number of backlinks</em>
          nullable: true
        dofollow:
          type: number
          description: <em>average number of dofollow links</em>
          nullable: true
        referring_pages:
          type: number
          description: <em>average number of referring pages</em>
          nullable: true
        referring_domains:
          type: number
          description: <em>average number of referring domains</em>
          nullable: true
        referring_main_domains:
          type: number
          description: <em>average number of referring main domains</em>
          nullable: true
        rank:
          type: number
          description: <em>average rank</em><br>learn more about the metric and its calculation formula in <a href="https://dataforseo.com/help-center/what_is_rank_in_backlinks_api" target="_blank" rel="noopener noreferrer">this help center article</a>
          nullable: true
        main_domain_rank:
          type: number
          description: <em>average main domain rank</em><br>learn more about the metric and its calculation formula in <a href="https://dataforseo.com/help-center/what_is_rank_in_backlinks_api" target="_blank" rel="noopener noreferrer">this help center article</a>
          nullable: true
        last_updated_time:
          type: string
          description: '<em>date and time when keyword data was updated</em><br>in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”<br>example:<br><code class="long-string">2019-11-15 12:57:46 +00:00</code>'
          nullable: true
    SearchIntentInfo:
      type: object
      properties:
        se_type:
          type: string
          description: <em>search engine type</em>
          nullable: true
        main_intent:
          type: string
          description: '<em>main search intent</em><br>possible values: <code>informational</code>, <code>navigational</code>, <code>commercial</code>, <code>transactional</code>'
          nullable: true
        foreign_intent:
          type: array
          items:
            type: string
            nullable: true
          description: '<em>supplementary search intents</em><br>possible values: <code>informational</code>, <code>navigational</code>, <code>commercial</code>, <code>transactional</code>'
          nullable: true
        last_updated_time:
          type: string
          description: '<em>date and time when keyword data was updated</em><br>in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”<br>example:<br><code class="long-string">2019-11-15 12:57:46 +00:00</code>'
          nullable: true
    KeywordDataInfo:
      type: object
      properties:
        se_type:
          type: string
          description: <em>search engine type</em>
          nullable: true
        keyword:
          type: string
          description: <em>returned keyword idea</em>
          nullable: true
        location_code:
          type: integer
          description: <em>location code in a POST array</em>
          nullable: true
        language_code:
          type: string
          description: <em>language code in a POST array</em>
          nullable: true
        keyword_info:
          type: object
          oneOf:
            - $ref: '#/components/schemas/KeywordInfo'
          description: <em>keyword data for the returned keyword idea</em>
          nullable: true
        keyword_info_normalized_with_bing:
          type: object
          oneOf:
            - $ref: '#/components/schemas/KeywordInfoNormalizedWithInfo'
          description: <em>contains keyword search volume normalized with Bing search volume</em>
          nullable: true
        keyword_info_normalized_with_clickstream:
          type: object
          oneOf:
            - $ref: '#/components/schemas/KeywordInfoNormalizedWithInfo'
          description: <em>contains keyword search volume normalized with clickstream data<br></em>
          nullable: true
        clickstream_keyword_info:
          type: object
          oneOf:
            - $ref: '#/components/schemas/ClickstreamKeywordInfo'
          description: '<em>clickstream data for the returned keyword</em><br>to retrieve results for this field, the parameter <code>include_clickstream_data</code> must be set to <code>true</code>'
          nullable: true
        keyword_properties:
          type: object
          oneOf:
            - $ref: '#/components/schemas/KeywordProperties'
          description: <em>additional information about the keyword</em>
          nullable: true
        serp_info:
          type: object
          oneOf:
            - $ref: '#/components/schemas/SerpInfo'
          description: <em>SERP data</em><br>the value will be <code>null</code> if you didn't set the field <code>include_serp_info</code> to <code>true</code> in the POST array or if there is no SERP data for this keyword in our database
          nullable: true
        avg_backlinks_info:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AvgBacklinksInfo'
          description: '<em>backlink data for the returned keyword</em><br>this object provides the average number of backlinks, referring pages and domains, as well as the average rank values among the top-10 webpages ranking organically for the keyword'
          nullable: true
        search_intent_info:
          type: object
          oneOf:
            - $ref: '#/components/schemas/SearchIntentInfo'
          description: <em>search intent info for the returned keyword</em><br>learn about search intent in this <a href="https://dataforseo.com/help-center/search-intent-and-its-types" target="_blank" rel="noopener noreferrer">help center article</a>
          nullable: true
    DataforseoLabsGoogleKeywordsForSiteLiveResultInfo:
      type: object
      properties:
        se_type:
          type: string
          description: <em>search engine type</em>
          nullable: true
        target:
          type: string
          description: <em>target domain in a POST array</em>
          nullable: true
        location_code:
          type: integer
          description: <em>location code in a POST array</em>
          nullable: true
        language_code:
          type: string
          description: <em>language code in a POST array</em>
          nullable: true
        total_count:
          type: integer
          description: <em>total number of results in our database relevant to your request</em>
          format: int64
          nullable: true
        items_count:
          type: integer
          description: <em>the number of results returned in the <code>items</code> array</em>
          format: int64
          nullable: true
        offset:
          type: integer
          description: <em>current offset value</em>
          nullable: true
        offset_token:
          type: string
          description: <em>offset token for subsequent requests</em><br>you can use the string provided in this field to get the subsequent results of the initial task;<br><strong>note:</strong> <code>offset_token</code> values are unique for each subsequent task
          nullable: true
        items:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/KeywordDataInfo'
            nullable: true
          description: <em>contains keyword ideas and related data</em>
          nullable: true
    DataforseoLabsGoogleKeywordsForSiteLiveTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/DataforseoLabsGoogleKeywordsForSiteLiveResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    DataforseoLabsGoogleKeywordsForSiteLiveResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/DataforseoLabsGoogleKeywordsForSiteLiveTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    DataforseoLabsGoogleRelatedKeywordsLiveRequestInfo:
      type: object
      properties:
        keyword:
          type: string
          description: <em>keyword</em><br><strong>required field</strong><br>UTF-8 encoding<br>the keywords will be converted to lowercase format<p>learn more about rules and limitations of <code>keyword</code> and <code>keywords</code> fields in DataForSEO APIs in this <a href="https://dataforseo.com/help-center/rules-and-limitations-of-keyword-and-keywords-fields-in-dataforseo-apis" rel="noopener noreferrer" target="_blank">Help Center article</a>
        location_name:
          type: string
          description: <em>full name of the location</em><br><strong>required field if you don't specify</strong> <code>location_code</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_name</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class="long-string">United Kingdom</code>
        location_code:
          type: integer
          description: <em>location code</em><br><strong>required field if you don't specify</strong> <code>location_name</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_code</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class="long-string">2840</code>
        language_name:
          type: string
          description: <em>full name of the language</em><br><strong>required field if you don't specify</strong> <code>language_code</code><br><strong>Note:</strong> it is required to specify either <code>language_name</code> or <code>language_code</code><br>you can receive the list of available locations with their <code>language_name</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class="long-string">English</code>
        language_code:
          type: string
          description: <em>language code</em><br><strong>required field if you don't specify</strong> <code>language_name</code><br><strong>Note:</strong> it is required to specify either <code>language_name</code> or <code>language_code</code><br>you can receive the list of available locations with their <code>language_code</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class="long-string">en</code>
          nullable: true
        depth:
          type: integer
          description: '<em>keyword search depth</em><br>optional field<br>default value: <code>1</code><p>number of the returned results depends on the value you set in this field<br>you can specify a level from 0 to 4<br>estimated number of keywords for each level (maximum):<br>0 - the keyword set in the <code>keyword</code> field<br>1 – 8 keywords<br>2 – 72 keywords<br>3 – 584 keywords<br>4 – 4680 keywords'
          nullable: true
        include_seed_keyword:
          type: boolean
          description: '<em>include data for the seed keyword</em><br>optional field<br>if set to <code>true</code>, data for the seed keyword specified in the <code>keyword</code> field will be provided in the <code>seed_keyword_data</code> array of the response<br>default value: <code>false</code>'
          nullable: true
        include_serp_info:
          type: boolean
          description: '<em>include data from SERP for each keyword</em><br>optional field<br>if set to <code>true</code>, we will return a <code>serp_info</code> array containing SERP data (number of search results, relevant URL, and SERP features) for every keyword in the response<br>default value: <code>false</code>'
          nullable: true
        include_clickstream_data:
          type: boolean
          description: ''
          nullable: true
        ignore_synonyms:
          type: boolean
          description: ''
          nullable: true
        replace_with_core_keyword:
          type: boolean
          description: '<em>return data for core keyword</em><br>optional field<br>if <code>true</code>, <code>serp_info</code> and <code>related_keywords</code> will be returned for the main keyword in the group that the specified <code>keyword</code> belongs to;<br>if <code>false</code>, <code>serp_info</code> and <code>related_keywords</code> will be returned for the specified <code>keyword</code> (if available);<br>refer to <a href="https://dataforseo.com/help-center/replace_with_core_keyword" rel="noopener noreferrer" target="_blank">this help center article</a> for more details;<br>default value: <code>false</code>'
          nullable: true
        filters:
          type: array
          items:
            type: object
            nullable: true
          description: '<em>array of results filtering parameters</em><br>optional field<br><strong>you can add several filters at once (8 filters maximum)</strong><br>you should set a logical operator <code>and</code>, <code>or</code> between the conditions<br>the following operators are supported:<br><code>regex</code>, <code>not_regex</code>, <code>&lt;</code>, <code>&lt;=</code>, <code>&gt;</code>, <code>&gt;=</code>, <code>=</code>, <code>&lt;&gt;</code>, <code>in</code>, <code>not_in</code>, <code>match</code>, <code>not_match</code>, <code>ilike</code>, <code>not_ilike</code>, <code>like</code>,<code>not_like</code><br>you can use the <code>%</code> operator with <code>like</code> and <code>not_like</code>, as well as <code>ilike</code> and <code>not_ilike</code> to match any string of zero or more characters<br>example:<br><code>["keyword_data.keyword_info.search_volume","&gt;",0]</code><p><code>[["keyword_info.search_volume","in",[0,1000]],<br>"and",<br>["keyword_data.keyword_info.competition_level","=","LOW"]]</code><p><code>[["keyword_data.keyword_info.search_volume","&gt;",100],<br>"and",<br>[["keyword_data.keyword_info.cpc","&lt;",0.5],<br>"or",<p>["keyword_info.high_top_of_page_bid","&lt;=",0.5]]]</code><br>for more information about filters, please refer to <a href="/v3/dataforseo_labs/filters" target="_blank" rel="noopener noreferrer">Dataforseo Labs - Filters</a> or this <a href="https://dataforseo.com/help-center/how-to-use-filters-in-dataforseo-labs-api" rel="noopener noreferrer" target="_blank">help center guide</a>'
          nullable: true
        order_by:
          type: array
          items:
            type: string
          description: '<em>results sorting rules</em><br>optional field<br>you can use the same values as in the <code>filters</code> array to sort the results<br>possible sorting types:<br><code>asc</code> - results will be sorted in the ascending order<br><code>desc</code> - results will be sorted in the descending order<br>you should use a comma to set up a sorting type<br>example:<br><code>["keyword_data.keyword_info.competition,desc"]</code><br>default rule:<br><code>["keyword_data.keyword_info.search_volume,desc"]</code><br><strong>note that you can set no more than three sorting rules in a single request</strong><br>you should use a comma to separate several sorting rules<br>example:<br><code>["keyword_data.keyword_info.search_volume,desc","keyword_data.keyword_info.cpc,desc"]</code>'
          nullable: true
        limit:
          type: integer
          description: '<em>the maximum number of returned keywords</em><br>optional field<br>default value: <code>100</code><br>maximum value: <code>1000</code>'
          nullable: true
        offset:
          type: integer
          description: '<em>offset in the results array of returned keywords</em><br>optional field<br>default value: <code>0</code><br>if you specify the <code>10</code> value, the first ten keywords in the results array will be omitted and the data will be provided for the successive keywords'
          nullable: true
        tag:
          type: string
          description: <em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response
          nullable: true
      example:
        - keyword: phone
          language_name: English
          location_code: 2840
          limit: 3
    DataforseoLabsGoogleRelatedKeywordsLiveItem:
      type: object
      properties:
        se_type:
          type: string
          description: <em>search engine type</em>
          nullable: true
        keyword_data:
          type: object
          oneOf:
            - $ref: '#/components/schemas/KeywordDataInfo'
          properties:
            avg_backlinks_info:
              type: object
              oneOf:
                - $ref: '#/components/schemas/AvgBacklinksInfo'
              nullable: true
            search_intent_info:
              type: object
              oneOf:
                - $ref: '#/components/schemas/SearchIntentInfo'
              nullable: true
          description: <em>keyword data for the returned keyword</em>
          nullable: true
        depth:
          type: integer
          description: <em>keyword search depth</em>
          nullable: true
        related_keywords:
          type: array
          items:
            type: string
            nullable: true
          description: <em>list of related keywords</em><br>represents the list of search queries which are related to the keyword returned in the array above
          nullable: true
    DataforseoLabsGoogleRelatedKeywordsLiveResultInfo:
      type: object
      properties:
        se_type:
          type: string
          description: <em>search engine type</em>
          nullable: true
        seed_keyword:
          type: string
          description: <em>keyword in a POST array</em>
          nullable: true
        seed_keyword_data:
          type: object
          oneOf:
            - $ref: '#/components/schemas/KeywordDataInfo'
          description: <em>keyword data for the seed keyword</em><br>fields in the array are identical to that of <code>keyword_data</code>
          nullable: true
        location_code:
          type: integer
          description: <em>location code in a POST array</em>
          nullable: true
        language_code:
          type: string
          description: <em>language code in a POST array</em>
          nullable: true
        total_count:
          type: integer
          description: <em>total amount of results in our database relevant to your request</em>
          format: int64
          nullable: true
        items_count:
          type: integer
          description: <em>the number of results returned in the <code>items</code> array</em>
          format: int64
          nullable: true
        items:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/DataforseoLabsGoogleRelatedKeywordsLiveItem'
            nullable: true
          description: <em>contains keywords and related data</em>
          nullable: true
    DataforseoLabsGoogleRelatedKeywordsLiveTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/DataforseoLabsGoogleRelatedKeywordsLiveResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    DataforseoLabsGoogleRelatedKeywordsLiveResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/DataforseoLabsGoogleRelatedKeywordsLiveTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    DataforseoLabsGoogleKeywordSuggestionsLiveRequestInfo:
      type: object
      properties:
        keyword:
          type: string
          description: <em>keyword</em><br><strong>required field</strong><br>UTF-8 encoding<br>the keywords will be converted to lowercase format;<p>learn more about rules and limitations of <code>keyword</code> and <code>keywords</code> fields in DataForSEO APIs in this <a href="https://dataforseo.com/help-center/rules-and-limitations-of-keyword-and-keywords-fields-in-dataforseo-apis" rel="noopener noreferrer" target="_blank">Help Center article</a>
        location_name:
          type: string
          description: '<em>full name of the location</em><br>optional field<br>if you use this field, you don''t need to specify <code>location_code</code><br>you can receive the list of available locations with their <code>location_name</code> by making a separate request to the<br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>ignore this field to get the results for all available locations<br>example:<br><code class="long-string">United Kingdom</code>'
          nullable: true
        location_code:
          type: integer
          description: '<em>location code</em><br>optional field<br>if you use this field, you don''t need to specify <code>location_name</code><br>you can receive the list of available locations with their <code>location_code</code> by making a separate request to the<br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>ignore this field to get the results for all available locations<br>example:<br><code class="long-string">2840</code>'
          nullable: true
        language_name:
          type: string
          description: '<em>full name of the language</em><br>optional field<br>if you use this field, you don''t need to specify <code>language_code</code><br>you can receive the list of available languages with their <code>language_name</code> by making a separate request to the<br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class="long-string">English</code><br><strong>Note:</strong> if omitted, results default to the language with the most keyword records in the specified location;<br>refer to the <code>available_languages.keywords</code> field of the <a href="https://docs.dataforseo.com/v3/dataforseo_labs/locations_and_languages" target="_blank">Locations and Languages endpoint</a> to determine the default language'
          nullable: true
        language_code:
          type: string
          description: '<em>language code</em><br>optional field<br>if you use this field, you don''t need to specify <code>language_name</code><br>you can receive the list of available languages with their <code>language_code</code> by making a separate request to the<br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class="long-string">en</code><br><strong>Note:</strong> if omitted, results default to the language with the most keyword records in the specified location;<br>refer to the <code>available_languages.keywords</code> field of the <a href="https://docs.dataforseo.com/v3/dataforseo_labs/locations_and_languages" target="_blank">Locations and Languages endpoint</a> to determine the default language'
          nullable: true
        include_seed_keyword:
          type: boolean
          description: '<em>include data for the seed keyword</em><br>optional field<br>if set to <code>true</code>, data for the seed keyword specified in the <code>keyword</code> field will be provided in the <code>seed_keyword_data</code> array of the response<br>default value: <code>false</code>'
          nullable: true
        include_serp_info:
          type: boolean
          description: '<em>include data from SERP for each keyword</em><br>optional field<br>if set to <code>true</code>, we will return a <code>serp_info</code> array containing SERP data (number of search results, relevant URL, and SERP features) for every keyword in the response<br>default value: <code>false</code>'
          nullable: true
        include_clickstream_data:
          type: boolean
          description: '<em>include or exclude data from clickstream-based metrics in the result</em><br>optional field<br>if the parameter is set to <code>true</code>, you will receive <code>clickstream_keyword_info</code>, <code>keyword_info_normalized_with_clickstream</code>, and <code>keyword_info_normalized_with_bing</code> fields in the response<br>default value: <code>false</code><br>with this parameter enabled, you will be charged double the price for the request<p>learn more about how clickstream-based metrics are calculated in this <a href="https://dataforseo.com/help-center/what-are-clickstream-based-metrics-and-how-do-we-calculate-them" rel="noopener noreferrer" target="_blank">help center article</a>'
          nullable: true
        exact_match:
          type: boolean
          description: '<em>search for the exact phrase</em><br>optional field<br>if set to <code>true</code>, the returned keywords will include the exact keyword phrase you specified, with potentially other words before or after that phrase<br>default value: <code>false</code>'
          nullable: true
        ignore_synonyms:
          type: boolean
          description: '<em>ignore highly similar keywords</em><br>optional field<br>if set to <code class="prettyprint">true</code> only core keywords will be returned, all highly similar keywords will be excluded;<br>default value: <code>false</code>'
          nullable: true
        filters:
          type: array
          items:
            type: object
            nullable: true
          description: '<em>array of results filtering parameters</em><br>optional field<br><strong>you can add several filters at once (8 filters maximum)</strong><br>you should set a logical operator <code>and</code>, <code>or</code> between the conditions<br>the following operators are supported:<br><code>regex</code>, <code>not_regex</code>, <code>&lt;</code>, <code>&lt;=</code>, <code>&gt;</code>, <code>&gt;=</code>, <code>=</code>, <code>&lt;&gt;</code>, <code>in</code>, <code>not_in</code>, <code>match</code>, <code>not_match</code>, <code>ilike</code>, <code>not_ilike</code>, <code>like</code>, <code>not_like</code><br>you can use the <code>%</code> operator with <code>like</code> and <code>not_like</code>, as well as <code>ilike</code> and <code>not_ilike</code> to match any string of zero or more characters<br>example:<br><code>["keyword_info.search_volume","&gt;",0]</code><br><code>[["keyword_info.search_volume","in",[0,1000]],<br>"and",<br>["keyword_info.competition_level","=","LOW"]]</code><code>[["keyword_info.search_volume","&gt;",100],<br>"and",<br>[["keyword_info.cpc","&lt;",0.5],<br>"or",<br>["keyword_info.high_top_of_page_bid","&lt;=",0.5]]]</code><br>for more information about filters, please refer to <a href="/v3/dataforseo_labs/filters" target="_blank" rel="noopener noreferrer">Dataforseo Labs - Filters</a> or this <a href="https://dataforseo.com/help-center/how-to-use-filters-in-dataforseo-labs-api" target="_blank" rel="noopener noreferrer">help center guide</a>'
          nullable: true
        order_by:
          type: array
          items:
            type: string
          description: '<em>results sorting rules</em><br>optional field<br>you can use the same values as in the <code>filters</code> array to sort the results<br>possible sorting types:<br><code>asc</code> - results will be sorted in the ascending order<br><code>desc</code> - results will be sorted in the descending order<br>a comma is used as a separator<br>example:<br><code>["keyword_info.competition,desc"]</code><br>default rule:<br><code>["keyword_info.search_volume,desc"]</code><br><strong>note that you can set no more than three sorting rules in a single request</strong><br>you should use a comma to separate several sorting rules<br>example:<br><code>["keyword_info.search_volume,desc","keyword_info.cpc,desc"]</code>'
          nullable: true
        limit:
          type: integer
          description: '<em>the maximum number of returned keywords</em><br>optional field<br>default value: <code>100</code><br>maximum value: <code>1000</code>'
          nullable: true
        offset:
          type: integer
          description: '<em>offset in the results array of returned keywords</em><br>optional field<br>default value: <code>0</code><br>if you specify the <code>10</code> value, the first ten keywords in the results array will be omitted and the data will be provided for the successive keywords<br><strong>Note:</strong> we recommend using this parameter only when retrieving up to 10,000 results<br>for retrieving over 10,000 results, use the <code>offset_token</code> instead.'
          nullable: true
        offset_token:
          type: string
          description: '<em>offset token for subsequent requests</em><br>optional field<br>provided in the identical filed of the response to each request;<br>use this parameter to avoid timeouts while trying to obtain over 10,000 results in a single request;<br>by specifying the unique <code>offset_token</code> value from the response array, you will get the subsequent results of the initial task;<br><code>offset_token</code> values are unique for each subsequent task<br><strong>Note:</strong> if the <code>offset_token</code> is specified in the request, all other parameters except <code>limit</code> will not be taken into account when processing a task.<br>learn more about this parameter on our <a href="https://dataforseo.com/help-center/what-is-the-difference-between-the-offset-and-offset_token-parameters#offset_token" target="_blank">Help Center</a>'
          nullable: true
        tag:
          type: string
          description: <em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response
          nullable: true
      example:
        - keyword: phone
          location_code: 2840
          language_code: en
          include_serp_info: true
          include_seed_keyword: true
          limit: 1
    DataforseoLabsGoogleKeywordSuggestionsLiveResultInfo:
      type: object
      properties:
        se_type:
          type: string
          description: <em>search engine type</em>
          nullable: true
        seed_keyword:
          type: string
          description: <em>keyword in a POST array</em>
          nullable: true
        seed_keyword_data:
          type: object
          oneOf:
            - $ref: '#/components/schemas/KeywordDataInfo'
          description: <em>keyword data for the seed keyword</em><br>fields in this object are identical to those of the <code>items</code> array
          nullable: true
        location_code:
          type: integer
          description: '<em>location code in a POST array</em><br>if there is no data, then the value is_<code>null</code>n'
          nullable: true
        language_code:
          type: string
          description: '<em>language code in a POST array</em><br>if there is no data, then the value is_<code>null</code>n'
          nullable: true
        total_count:
          type: integer
          description: <em>total amount of results in our database relevant to your request</em>
          format: int64
          nullable: true
        items_count:
          type: integer
          description: <em>the number of results returned in the <code>items</code> array</em>
          format: int64
          nullable: true
        offset:
          type: integer
          description: <em>current offset value</em>
          nullable: true
        offset_token:
          type: string
          description: <em>offset token for subsequent requests</em><br>you can use the string provided in this field to get the subsequent results of the initial task;<br><strong>note:</strong> <code>offset_token</code> values are unique for each subsequent task
          nullable: true
        items:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/KeywordDataInfo'
            nullable: true
          description: <em>contains keywords and related data</em>
          nullable: true
    DataforseoLabsGoogleKeywordSuggestionsLiveTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/DataforseoLabsGoogleKeywordSuggestionsLiveResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    DataforseoLabsGoogleKeywordSuggestionsLiveResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/DataforseoLabsGoogleKeywordSuggestionsLiveTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    DataforseoLabsGoogleKeywordIdeasLiveRequestInfo:
      type: object
      properties:
        keywords:
          type: array
          items:
            type: string
          description: '<em>keywords</em><br><strong>required field</strong><br>UTF-8 encoding<br>The maximum number of keywords you can specify: 200.<br>The keywords will be converted to lowercase format<p>learn more about rules and limitations of <code>keyword</code> and <code>keywords</code> fields in DataForSEO APIs in this <a href="https://dataforseo.com/help-center/rules-and-limitations-of-keyword-and-keywords-fields-in-dataforseo-apis" rel="noopener noreferrer" target="_blank">Help Center article</a>'
        location_name:
          type: string
          description: <em>full name of the location</em><br><strong>required field if you don't specify</strong> <code>location_code</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_name</code> by making a separate request to the<br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class="long-string">United Kingdom</code>
        location_code:
          type: integer
          description: <em>unique location identifier</em><br><strong>required field if you don't specify</strong> <code>location_name</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_code</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class="long-string">2840</code>
        language_name:
          type: string
          description: '<em>full name of the language</em><br>optional field<br>if you use this field, you don''t need to specify <code>language_code</code><br>you can receive the list of available languages with their <code>language_name</code> by making a separate request to the<br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class="long-string">English</code><br><strong>Note:</strong> if omitted, results default to the language with the most keyword records in the specified location;<br>refer to the <code>available_languages.keywords</code> field of the <a href="https://docs.dataforseo.com/v3/dataforseo_labs/locations_and_languages" target="_blank">Locations and Languages endpoint</a> to determine the default language'
          nullable: true
        language_code:
          type: string
          description: '<em>language code</em><br>optional field<br>if you use this field, you don''t need to specify <code>language_name</code><br>you can receive the list of available languages with their <code>language_code</code> by making a separate request to the<br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class="long-string">en</code><br><strong>Note:</strong> if omitted, results default to the language with the most keyword records in the specified location;<br>refer to the <code>available_languages.keywords</code> field of the <a href="https://docs.dataforseo.com/v3/dataforseo_labs/locations_and_languages" target="_blank">Locations and Languages endpoint</a> to determine the default language'
          nullable: true
        closely_variants:
          type: boolean
          description: '<em>search mode</em><br>optional field<br>if set to_<code class="prettyprint">true</code> the results will be based on the phrase-match search algorithm<br>if set to <code class="prettyprint">false</code> the results will be based on the broad-match search algorithm<br>default value: <code>false</code>n'
          nullable: true
        ignore_synonyms:
          type: boolean
          description: '<em>ignore highly similar keywords</em><br>optional field<br>if set to_<code class="prettyprint">true</code> only core keywords will be returned, all highly similar keywords will be excluded;  <br>default value: <code>false</code>n'
          nullable: true
        include_serp_info:
          type: boolean
          description: '<em>include data from SERP for each keyword</em><br>optional field<br>if set to <code>true</code>, we will return a <code>serp_info</code> array containing SERP data (number of search results, relevant URL, and SERP features) for every keyword in the response<br>default value: <code>false</code>'
          nullable: true
        include_clickstream_data:
          type: boolean
          description: '<em>include or exclude data from clickstream-based metrics in the result</em><br>optional field<br>if the parameter is set to <code>true</code>, you will receive <code>clickstream_keyword_info</code>, <code>keyword_info_normalized_with_clickstream</code>, and <code>keyword_info_normalized_with_bing</code> fields in the response<br>default value: <code>false</code><br>with this parameter enabled, you will be charged double the price for the request<p>learn more about how clickstream-based metrics are calculated in this <a href="https://dataforseo.com/help-center/what-are-clickstream-based-metrics-and-how-do-we-calculate-them" rel="noopener noreferrer" target="_blank">help center article</a>'
          nullable: true
        limit:
          type: integer
          description: '<em>the maximum number of keywords in the results array</em><br>optional field<br>default value: <code>700</code><br>maximum value: <code>1000</code>'
          nullable: true
        offset:
          type: integer
          description: '<em>offset in the results array of returned keywords</em><br>optional field<br>default value: <code>0</code><br>if you specify the <code>10</code> value, the first ten keywords in the results array will be omitted and the data will be provided for the successive keywords<br><strong>Note:</strong> we recommend using this parameter only when retrieving up to 10,000 results<br>for retrieving over 10,000 results, use the <code>offset_token</code> instead.'
          nullable: true
        offset_token:
          type: string
          description: '<em>offset token for subsequent requests</em><br>optional field<br>provided in the identical filed of the response to each request;<br>use this parameter to avoid timeouts while trying to obtain over 10,000 results in a single request;<br>by specifying the unique <code>offset_token</code> value from the response array, you will get the subsequent results of the initial task;<br><code>offset_token</code> values are unique for each subsequent task <br><strong>Note:</strong> if the <code>offset_token</code> is specified in the request, all other parameters except <code>limit</code> will not be taken into account when processing a task.<br>learn more about this parameter on our <a href="https://dataforseo.com/help-center/what-is-the-difference-between-the-offset-and-offset_token-parameters#offset_token" target="_blank">Help Center</a>'
          nullable: true
        filters:
          type: array
          items:
            type: object
            nullable: true
          description: '<em>array of results filtering parameters</em><br>optional field<br><strong>you can add several filters at once (8 filters maximum)</strong><br>you should set a logical operator <code>and</code>, <code>or</code> between the conditions<br>the following operators are supported:<br><code>regex</code>, <code>not_regex</code>, <code>&lt;</code>, <code>&lt;=</code>, <code>&gt;</code>, <code>&gt;=</code>, <code>=</code>, <code>&lt;&gt;</code>, <code>in</code>, <code>not_in</code>, <code>match</code>, <code>not_match</code>, <code>ilike</code>, <code>not_ilike</code>, <code>like</code>, <code>not_like</code><br>you can use the <code>%</code> operator with <code>like</code> and <code>not_like</code>,as well as <code>ilike</code>, <code>not_ilike</code> to match any string of zero or more characters<br><strong>note that you can not filter the results by <code>relevance</code></strong><br>example:<br><code>["keyword_info.search_volume","&gt;",0]</code><p><code>[["keyword_info.search_volume","in",[0,1000]],<br>"and",<br>["keyword_info.competition_level","=","LOW"]]</code><p><code>[["keyword_info.search_volume","&gt;",100],<br>"and",<br>[["keyword_info.cpc","&lt;",0.5],<br>"or",<p>["keyword_info.high_top_of_page_bid","&lt;=",0.5]]]</code><br>for more information about filters, please refer to <a href="/v3/dataforseo_labs/filters" target="_blank" rel="noopener noreferrer">Dataforseo Labs - Filters</a> or this <a href="https://dataforseo.com/help-center/how-to-use-filters-in-dataforseo-labs-api" rel="noopener noreferrer" target="_blank">help center guide</a>'
          nullable: true
        order_by:
          type: array
          items:
            type: string
          description: '<em>results sorting rules</em><br>optional field<br>you can use the same values as in the <code>filters</code> array to sort the results<br>possible sorting types:<br><code>asc</code> - results will be sorted in the ascending order<br><code>desc</code> - results will be sorted in the descending order<br>you should use a comma to set up a sorting parameter<p>default rule:<br><code>["relevance,desc"]</code><br>relevance is used as the default sorting rule to provide you with the closest keyword ideas. We recommend using this sorting rule to get highly-relevant search terms. <strong>Note</strong> that <code>relevance</code> is only our internal system identifier, so <strong>it can not be used as a filter</strong>, and you will not find this field in the <code>result</code> array. The relevance score is based on a similar principle as used in <a href="/v3/keywords_data/google/keywords_for_keywords/live/?php">the Keywords For Keywords</a> endpoint.<p><strong>note that you can set no more than three sorting rules in a single request</strong><br>you should use a comma to separate several sorting rules<br>example:<br><code>["relevance,desc","keyword_info.search_volume,desc"]</code>'
          nullable: true
        tag:
          type: string
          description: <em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response
          nullable: true
      example:
        - keywords:
            - phone
            - watch
          location_code: 2840
          language_code: en
          include_serp_info: true
          limit: 3
    DataforseoLabsGoogleKeywordIdeasLiveResultInfo:
      type: object
      properties:
        se_type:
          type: string
          description: <em>search engine type</em>
          nullable: true
        seed_keywords:
          type: array
          items:
            type: string
            nullable: true
          description: <em>keywords in a POST array</em><br><strong>keywords are returned with decoded %## (plus character '+' will be decoded to a space character)</strong>
          nullable: true
        location_code:
          type: integer
          description: <em>location code in a POST array</em>
          nullable: true
        language_code:
          type: string
          description: <em>language code in a POST array</em>
          nullable: true
        total_count:
          type: integer
          description: <em>total number of results relevant to your request in our database </em>
          format: int64
          nullable: true
        items_count:
          type: integer
          description: <em>number of results returned in the <code>items</code> array</em>
          format: int64
          nullable: true
        offset:
          type: integer
          description: <em>current offset value</em>
          nullable: true
        offset_token:
          type: string
          description: <em>offset token for subsequent requests</em><br>you can use the string provided in this field to get the subsequent results of the initial task;<br><strong>note:</strong> <code>offset_token</code> values are unique for each subsequent task
          nullable: true
        items:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/KeywordDataInfo'
            nullable: true
          description: <em>contains keyword ideas and related data</em>
          nullable: true
    DataforseoLabsGoogleKeywordIdeasLiveTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/DataforseoLabsGoogleKeywordIdeasLiveResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    DataforseoLabsGoogleKeywordIdeasLiveResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/DataforseoLabsGoogleKeywordIdeasLiveTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    DataforseoLabsGoogleBulkKeywordDifficultyLiveRequestInfo:
      type: object
      properties:
        keywords:
          type: array
          items:
            type: string
          description: '<em>target keywords</em><br><strong>required field</strong><br>UTF-8 encoding<br>maximum number of keywords you can specify in this array: 1000<br>the keywords will be converted to lowercase format<p>learn more about rules and limitations of <code>keyword</code> and <code>keywords</code> fields in DataForSEO APIs in this <a href="https://dataforseo.com/help-center/rules-and-limitations-of-keyword-and-keywords-fields-in-dataforseo-apis" rel="noopener noreferrer" target="_blank">Help Center article</a>'
        location_name:
          type: string
          description: <em>full name of the location</em><br><strong>required field if don't specify <code>location_code</code></strong><br>you can receive the list of available locations with their <code>location_name</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class="long-string">United Kingdom</code>
        location_code:
          type: integer
          description: <em>location code</em><br><strong>required field if don't specify <code>location_name</code></strong><br>you can receive the list of available locations with their <code>location_code</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class="long-string">2840</code>
        language_name:
          type: string
          description: <em>full name of the language</em><br><strong>required field if don't specify <code>language_code</code></strong><br>you can receive the list of available languages with their <code>language_name</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class="long-string">English</code>
        language_code:
          type: string
          description: <em>language code</em><br><strong>required field if don't specify <code>language_name</code></strong><br>you can receive the list of available languages with their <code>language_code</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class="long-string">en</code>
          nullable: true
        tag:
          type: string
          description: <em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response
          nullable: true
      example:
        - location_code: 2840
          language_code: en
          keywords:
            - dentist new york
            - pizza brooklyn
            - car dealer los angeles
    DataforseoLabsGoogleBulkKeywordDifficultyLiveItem:
      type: object
      properties:
        se_type:
          type: string
          description: <em>search engine type</em>
          nullable: true
        keyword:
          type: string
          description: <em>keyword in a POST array</em>
          nullable: true
        keyword_difficulty:
          type: integer
          description: '<em>difficulty of ranking in the first top-10 organic results for a keyword</em><br>indicates the chance of getting in top-10 organic results for a keyword on a logarithmic scale from 0 to 100;<br>calculated by analysing, among other parameters, link profiles of the first 10 pages in SERP;<br>learn more about the metric in <a href="https://dataforseo.com/help-center/what-is-keyword-difficulty-and-how-is-it-calculated" rel="noopener noreferrer" target="_blank">this help center guide</a>'
          nullable: true
    DataforseoLabsGoogleBulkKeywordDifficultyLiveResultInfo:
      type: object
      properties:
        se_type:
          type: string
          description: <em>search engine type</em>
          nullable: true
        location_code:
          type: integer
          description: '<em>location code in a POST array</em><br>if there is no data, then the value is <code>null</code>'
          nullable: true
        language_code:
          type: string
          description: '<em>language code in a POST array</em><br>if there is no data, then the value is <code>null</code>'
          nullable: true
        total_count:
          type: integer
          description: <em>total amount of results in our database relevant to your request</em>
          format: int64
          nullable: true
        items_count:
          type: integer
          description: <em>the number of results returned in the <code>items</code> array</em>
          format: int64
          nullable: true
        items:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/DataforseoLabsGoogleBulkKeywordDifficultyLiveItem'
            nullable: true
          description: <em>contains keywords and related keyword difficulty scores</em>
          nullable: true
    DataforseoLabsGoogleBulkKeywordDifficultyLiveTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/DataforseoLabsGoogleBulkKeywordDifficultyLiveResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    DataforseoLabsGoogleBulkKeywordDifficultyLiveResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/DataforseoLabsGoogleBulkKeywordDifficultyLiveTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    DataforseoLabsGoogleSearchIntentLiveRequestInfo:
      type: object
      properties:
        keywords:
          type: array
          items:
            type: string
          description: '<em>target keywords</em><br><strong>required field</strong><br>UTF-8 encoding<br>maximum number of keywords you can specify in this array: 1000;<br>the keywords will be converted to lowercase format<p>learn more about rules and limitations of <code>keyword</code> and <code>keywords</code> fields in DataForSEO APIs in this <a href="https://dataforseo.com/help-center/rules-and-limitations-of-keyword-and-keywords-fields-in-dataforseo-apis" rel="noopener noreferrer" target="_blank">Help Center article</a>'
        tag:
          type: string
          description: <em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response
          nullable: true
      example:
        - keywords:
            - login page
            - audi a7
            - elon musk
            - milk store new york
    KeywordIntentInfo:
      type: object
      properties:
        label:
          type: string
          description: '<em>search intent name</em><br>possible values: <code>informational</code>, <code>navigational</code>, <code>commercial</code>, <code>transactional</code>'
          nullable: true
        probability:
          type: number
          description: <em>search intent probability</em><br><code>1</code> indicates the highest probability
          nullable: true
    DataforseoLabsGoogleSearchIntentLiveItem:
      type: object
      properties:
        keyword:
          type: string
          description: <em>target keyword in a POST array</em>
          nullable: true
        keyword_intent:
          type: object
          oneOf:
            - $ref: '#/components/schemas/KeywordIntentInfo'
          description: <em>search intent data relevant for the specified keyword</em>
          nullable: true
        secondary_keyword_intents:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/KeywordIntentInfo'
            nullable: true
          description: <em>contains objects with other possible search intents for the specified keyword</em>
          nullable: true
    DataforseoLabsGoogleSearchIntentLiveResultInfo:
      type: object
      properties:
        items_count:
          type: integer
          description: <em>the number of results returned in the <code>items</code> array</em>
          format: int64
          nullable: true
        items:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/DataforseoLabsGoogleSearchIntentLiveItem'
            nullable: true
          description: <em>array of items with relevant traffic estimation data</em>
          nullable: true
    DataforseoLabsGoogleSearchIntentLiveTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/DataforseoLabsGoogleSearchIntentLiveResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    DataforseoLabsGoogleSearchIntentLiveResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/DataforseoLabsGoogleSearchIntentLiveTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    DataforseoLabsGoogleCategoriesForKeywordsLanguagesResultInfo:
      type: object
      properties:
        language_name:
          type: string
          description: <em>language name</em>
          nullable: true
        language_code:
          type: string
          description: <em>language code according to <a href="https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes" target="_blank" rel="noopener noreferrer">ISO 639-1</a></em>
          nullable: true
    DataforseoLabsGoogleCategoriesForKeywordsLanguagesTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/DataforseoLabsGoogleCategoriesForKeywordsLanguagesResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    DataforseoLabsGoogleCategoriesForKeywordsLanguagesResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/DataforseoLabsGoogleCategoriesForKeywordsLanguagesTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    DataforseoLabsGoogleCategoriesForDomainLiveRequestInfo:
      type: object
      properties:
        target:
          type: string
          description: <em>domain or subdomain</em><br><strong>required field</strong><br>the domain or subdomain name of the target website<br>the domain or subdomain should be specified without <code>https://</code> and <code>www.</code>
        location_name:
          type: string
          description: <em>full name of the location</em><br><strong>required field if you don't specify</strong> <code>location_code</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_name</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class="long-string">United Kingdom</code>
        location_code:
          type: integer
          description: <em>location code</em><br><strong>required field if you don't specify</strong> <code>location_name</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_code</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class="long-string">2840</code>
        language_name:
          type: string
          description: <em>full name of the language</em><br><strong>required field if you don't specify</strong> <code>language_code</code><br><strong>Note:</strong> it is required to specify either <code>language_name</code> or <code>language_code</code><br>you can receive the list of available languages with their <code>language_name</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class="long-string">English</code>
        language_code:
          type: string
          description: <em>language code</em><br><strong>required field if you don't specify</strong> <code>language_name</code><br><strong>Note:</strong> it is required to specify either <code>language_name</code> or <code>language_code</code><br>you can receive the list of available languages with their <code>language_code</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class="long-string">en</code>
          nullable: true
        include_subcategories:
          type: boolean
          description: '<em>indicates if the subcategories will be included in the search</em><br>optional field<br>if set to <code>false</code>, the subcategories will be ignored<br>default value: <code>false</code><br>learn more about the parameter in this <a href="https://dataforseo.com/help-center/include_subcategories-in-categories-for-domain-endpoint" rel="noopener noreferrer" target="_blank">help center article</a>'
          nullable: true
        include_clickstream_data:
          type: boolean
          description: '<em>include or exclude data from clickstream-based metrics in the result</em><br>optional field<br>if the parameter is set to_<code>true</code>, you will receive <code>clickstream_etv</code>, <code>clickstream_gender_distribution</code>, and_<code>clickstream_age_distribution</code>_fields with clickstream data in the response<br>default value: <code>false</code><br>with this parameter enabled, you will be charged double the price for the request<p>learn more about how clickstream-based metrics are calculated in this <a href="https://dataforseo.com/help-center/what-are-clickstream-based-metrics-and-how-do-we-calculate-them" rel="noopener noreferrer" target="_blank">help center article</a>n'
          nullable: true
        historical_serp_mode:
          type: string
          description: '<em>data collection mode</em><br>optional field<br>you can use this field to filter the results;<br>possible types of filtering:<br><code>live</code> — return metrics for SERPs in which the specified <code>target</code> currently has ranking results;<br><code>lost</code> — return metrics for SERPs in which the specified <code>target</code> had previously had ranking results, but didn''t have them during the last check;<br><code>all</code> — return metrics for both types of SERPs.<br>default value: <code>live</code>'
          nullable: true
        item_types:
          type: array
          items:
            type: string
          description: '<em>display results by item type</em><br>optional field<br>indicates the type of search results included in the response<p><strong>Note:</strong> if the <code>item_types</code> array contains item types that are different from the <code>organic</code> object, 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;<p>possible values: <br><code>["organic", "paid", "featured_snippet", "local_pack"]</code><br>default value: <br><code>["organic", "paid"]</code>'
          nullable: true
        filters:
          type: array
          items:
            type: object
            nullable: true
          description: '<em>array of results filtering parameters</em><br>optional field<br><strong>you can add several filters at once (8 filters maximum)</strong><br>you should set a logical operator <code>and</code>, <code>or</code> between the conditions<br>the following operators are supported:<br><code>regex</code>, <code>not_regex</code>, <code>&lt;</code>, <code>&lt;=</code>, <code>&gt;</code>, <code>&gt;=</code>, <code>=</code>, <code>&lt;&gt;</code>, <code>in</code>, <code>not_in</code><br>example:<br><code>["metrics.organic.pos_1,"&gt;",0]</code><p><code>[[["metrics.organic.count","&gt;=",100],"and",["metrics.organic.pos_1","&gt;",0]],<br>"or",<br>["metrics.organic.etv","in",[10,100]]]</code><br>for more information about filters, please refer to <a href="/v3/dataforseo_labs/filters" target="_blank" rel="noopener noreferrer">Dataforseo Labs - Filters</a> or this <a href="https://dataforseo.com/help-center/how-to-use-filters-in-dataforseo-labs-api" rel="noopener noreferrer" target="_blank">help center guide</a>'
          nullable: true
        order_by:
          type: array
          items:
            type: string
          description: '<em>results sorting rules</em><br>optional field<br>you can use the same values as in the <code>filters</code> array to sort the results<br>possible sorting types:<br><code>asc</code> - results will be sorted in the ascending order<br><code>desc</code> - results will be sorted in the descending order<br>you should use a comma to specify a sorting type<br>example:<br><code>["metrics.paid.etv,asc"]</code><br><strong>Note:</strong> you can set no more than three sorting rules in a single request<br>you should use a comma to separate several sorting rules<br>example:<br><code>["metrics.organic.etv,desc","metrics.paid.count,asc"]</code><p>default rule:<br><code>["metrics.organic.count,desc"]</code><br><strong>Note:</strong> if the <code>item_types</code> array contains item types that are different from the <code>organic</code> object, the results will be ordered by the first item type in the array'
          nullable: true
        limit:
          type: integer
          description: '<em>the maximum number of returned categories</em><br>optional field<br>default value: <code>100</code><br>maximum value: <code>1000</code>'
          nullable: true
        offset:
          type: integer
          description: '<em>offset in the results array of returned categories </em><br>optional field<br>default value: <code>0</code><br>if you specify the <code>10</code> value, the first ten categories in the results array will be omitted and the data will be provided for the successive categories'
          nullable: true
        tag:
          type: string
          description: <em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response
          nullable: true
      example:
        - target: dataforseo.com
          language_code: en
          location_name: United States
          item_types:
            - paid
            - organic
            - featured_snippet
            - local_pack
          limit: 3
    DataforseoLabsMetricsInfo:
      type: object
      properties:
        pos_1:
          type: integer
          description: '<em>number of organic SERPs where the domain or subdomain ranks #1</em>'
          nullable: true
        pos_2_3:
          type: integer
          description: '<em>number of organic SERPs where the domain or subdomain ranks #2-3</em>'
          nullable: true
        pos_4_10:
          type: integer
          description: '<em>number of organic SERPs where the domain or subdomain ranks #4-10</em>'
          nullable: true
        pos_11_20:
          type: integer
          description: '<em>number of organic SERPs where the domain or subdomain ranks #11-20</em>'
          nullable: true
        pos_21_30:
          type: integer
          description: '<em>number of organic SERPs where the domain or subdomain ranks #21-30</em>'
          nullable: true
        pos_31_40:
          type: integer
          description: '<em>number of organic SERPs where the domain or subdomain ranks #31-40</em>'
          nullable: true
        pos_41_50:
          type: integer
          description: '<em>number of organic SERPs where the domain or subdomain ranks #41-50</em>'
          nullable: true
        pos_51_60:
          type: integer
          description: '<em>number of organic SERPs where the domain or subdomain ranks #51-60</em>'
          nullable: true
        pos_61_70:
          type: integer
          description: '<em>number of organic SERPs where the domain or subdomain ranks #61-70</em>'
          nullable: true
        pos_71_80:
          type: integer
          description: '<em>number of organic SERPs where the domain or subdomain ranks #71-80</em>'
          nullable: true
        pos_81_90:
          type: integer
          description: '<em>number of organic SERPs where the domain or subdomain ranks #81-90</em>'
          nullable: true
        pos_91_100:
          type: integer
          description: '<em>number of organic SERPs where the domain or subdomain ranks #91-100</em>'
          nullable: true
        etv:
          type: number
          description: <em>estimated traffic volume</em><br>estimated organic monthly traffic to the domain or subdomain<br>calculated as the product of CTR (click-through-rate) and search volume values of all keywords in the category that the domain or subdomain ranks for<br>learn more about how the metric is calculated in <a href="https://dataforseo.com/help-center/how-is-etv-calculated" rel="noopener noreferrer" target="_blank">this help center article</a>
          nullable: true
        count:
          type: integer
          description: <em>total count of organic SERPs that contain the domain or subdomain</em>
          format: int64
          nullable: true
        estimated_paid_traffic_cost:
          type: number
          description: <em>estimated cost of converting organic search traffic into paid</em><br>represents the estimated monthly cost (USD) of running ads for all keywords in the category that the domain or subdomain ranks for<br>the metric is calculated as the product of organic <code>etv</code> and paid <code>cpc</code> values and indicates the cost of driving the estimated volume of monthly organic traffic through PPC advertising in Google Search<br>learn more about how the metric is calculated in <a href="https://dataforseo.com/help-center/how-is-traffic-cost-calculated" rel="noopener noreferrer" target="_blank">this help center article</a>
          nullable: true
        is_new:
          type: integer
          description: <em>number of new ranked elements</em><br>indicates how many new ranked elements were found for the indicated target
          nullable: true
        is_up:
          type: integer
          description: <em>rank went up</em><br>indicates how many ranked elements of the indicated target went up
          nullable: true
        is_down:
          type: integer
          description: <em>rank went down</em><br>indicates how many ranked elements of the indicated target went down
          nullable: true
        is_lost:
          type: integer
          description: '<em>lost ranked elements</em><br>indicates how many ranked elements of the indicated target were previously presented in SERPs, but weren''t found during the last check'
          nullable: true
        clickstream_etv:
          type: number
          description: '<em>estimated traffic volume based on clickstream data</em><br>calculated as the product of click-through-rate and clickstream search volume values of all keywords the domain ranks for<br>to retrieve results for this field, the parameter <code>include_clickstream_data</code> must be set to <code>true</code><br>learn more about how the metric is calculated in this <a href="https://dataforseo.com/help-center/whats-clickstream-estimated-traffic-volume-and-how-is-it-calculated" rel="noopener noreferrer" target="_blank">help center article</a>'
          format: double
          nullable: true
        clickstream_gender_distribution:
          type: object
          additionalProperties:
            type: integer
            format: int64
            nullable: true
          description: '<em>distribution of estimated clickstream-based metrics by gender</em><br>to retrieve results for this field, the parameter <code>include_clickstream_data</code> must be set to <code>true</code><br>learn more about how the metric is calculated in this <a href="https://dataforseo.com/help-center/what-are-clickstream-based-metrics-and-how-do-we-calculate-them" rel="noopener noreferrer" target="_blank">help center article</a>'
          nullable: true
        clickstream_age_distribution:
          type: object
          additionalProperties:
            type: integer
            format: int64
            nullable: true
          description: '<em>distribution of clickstream-based metrics by age</em><br>to retrieve results for this field, the parameter <code>include_clickstream_data</code> must be set to <code>true</code><br>learn more about how the metric is calculated in this <a href="https://dataforseo.com/help-center/what-are-clickstream-based-metrics-and-how-do-we-calculate-them" rel="noopener noreferrer" target="_blank">help center article</a>'
          nullable: true
    DataforseoLabsGoogleCategoriesForDomainLiveItem:
      type: object
      properties:
        se_type:
          type: string
          description: <em>search engine type</em>
          nullable: true
        categories:
          type: array
          items:
            type: integer
          description: <em>product and service categories</em><br>you can download <a href="https://cdn.dataforseo.com/v3/categories/categories_dataforseo_labs_2023_10_25.csv" target="_blank" rel="noopener noreferrer">the full list of possible categories</a>
          nullable: true
        metrics:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/DataforseoLabsMetricsInfo'
          description: <em>ranking data relevant to the specified domain or subdomain</em>
          nullable: true
    DataforseoLabsGoogleCategoriesForDomainLiveResultInfo:
      type: object
      properties:
        se_type:
          type: string
          description: <em>search engine type</em>
          nullable: true
        target:
          type: string
          description: <em>target domain or subdomain in a POST array</em>
          nullable: true
        location_code:
          type: integer
          description: <em>location code in a POST array</em>
          nullable: true
        language_code:
          type: string
          description: <em>language code in a POST array</em>
          nullable: true
        total_count:
          type: integer
          description: <em>total amount of results in our database relevant to your request</em>
          format: int64
          nullable: true
        items_count:
          type: integer
          description: <em>the number of results returned in the <code>items</code> array</em>
          format: int64
          nullable: true
        items:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/DataforseoLabsGoogleCategoriesForDomainLiveItem'
            nullable: true
          description: <em>contains relevant categories and related ranking data</em>
          nullable: true
    DataforseoLabsGoogleCategoriesForDomainLiveTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/DataforseoLabsGoogleCategoriesForDomainLiveResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    DataforseoLabsGoogleCategoriesForDomainLiveResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/DataforseoLabsGoogleCategoriesForDomainLiveTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    DataforseoLabsGoogleCategoriesForKeywordsLiveRequestInfo:
      type: object
      properties:
        keywords:
          type: array
          items:
            type: string
          description: '<em>target keywords</em><br><strong>required field</strong><br>UTF-8 encoding<br>maximum number of keywords you can specify in this array: 1000<br>the keywords will be converted to lowercase format<p>learn more about rules and limitations of <code>keyword</code> and <code>keywords</code> fields in DataForSEO APIs in this <a href="https://dataforseo.com/help-center/rules-and-limitations-of-keyword-and-keywords-fields-in-dataforseo-apis" rel="noopener noreferrer" target="_blank">Help Center article</a>'
        language_name:
          type: string
          description: <em>full name of the language</em><br><strong>required field if don't specify <code>language_code</code></strong><br>you can receive the list of available languages with their <code>language_name</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/google/categories_for_keywords/languages</code><br>example:<br><code class="long-string">English</code>
        language_code:
          type: string
          description: <em>language code</em><br><strong>required field if don't specify <code>language_name</code></strong><br>you can receive the list of available languages with their <code>language_code</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/google/categories_for_keywords/languages</code><br>example:<br><code class="long-string">en</code>
          nullable: true
        tag:
          type: string
          description: <em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response
          nullable: true
      example:
        - language_code: en
          keywords:
            - dentist new york
            - pizza brooklyn
            - car dealer los angeles
    DataforseoLabsGoogleCategoriesForKeywordsLiveItem:
      type: object
      properties:
        keyword:
          type: string
          description: <em>keyword in a POST array</em>
          nullable: true
        categories:
          type: array
          items:
            type: integer
          description: <em>product and service categories</em><br>you can download <a href="https://cdn.dataforseo.com/v3/categories/categories_dataforseo_labs_2023_10_25.csv" rel="noopener noreferrer" target="_blank">the full list of possible categories</a>
          nullable: true
    DataforseoLabsGoogleCategoriesForKeywordsLiveResultInfo:
      type: object
      properties:
        language_code:
          type: string
          description: '<em>language code in a POST array</em><br>if there is no data, then the value is_<code>null</code>n'
          nullable: true
        items_count:
          type: integer
          description: <em>the number of results returned in the <code>items</code> array</em>
          format: int64
          nullable: true
        items:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/DataforseoLabsGoogleCategoriesForKeywordsLiveItem'
            nullable: true
          description: <em>contains keywords and related keyword difficulty scores</em>
          nullable: true
    DataforseoLabsGoogleCategoriesForKeywordsLiveTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/DataforseoLabsGoogleCategoriesForKeywordsLiveResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    DataforseoLabsGoogleCategoriesForKeywordsLiveResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/DataforseoLabsGoogleCategoriesForKeywordsLiveTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    DataforseoLabsGoogleKeywordsForCategoriesLiveRequestInfo:
      type: object
      properties:
        category_codes:
          type: array
          items:
            type: string
          description: '<em>product and service categories</em><br><strong>required field</strong><br>The maximum number of categories you can specify: 20<br>you can download <a href="https://cdn.dataforseo.com/v3/categories/categories_dataforseo_labs_2023_10_25.csv">the full list of possible categories</a>'
        location_name:
          type: string
          description: <em>full name of the location</em><br><strong>required field if you don't specify</strong> <code>location_code</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_name</code> by making a separate request to the<br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class="long-string">United Kingdom</code>
        location_code:
          type: integer
          description: <em>unique location identifier</em><br><strong>required field if you don't specify</strong> <code>location_name</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_code</code> by making a separate request to the<br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class="long-string">2840</code>
        language_name:
          type: string
          description: <em>full name of the language</em><br><strong>required field if you don't specify</strong> <code>language_code</code><br><strong>Note:</strong> it is required to specify either <code>language_name</code> or <code>language_code</code><br>you can receive the list of available languages with their <code>language_name</code> by making a separate request to the<br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class="long-string">English</code>
        language_code:
          type: string
          description: <em>unique language identifier</em><br><strong>required field if you don't specify</strong> <code>language_name</code><br><strong>Note:</strong> it is required to specify either <code>language_name</code> or <code>language_code</code><br>you can receive the list of available languages with their <code>language_code</code> by making a separate request to the<br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class="long-string">en</code>
          nullable: true
        category_intersection:
          type: boolean
          description: '<em>category intersections</em><br>optional field<br>if set to <code class="prettyprint">true</code>, you will get keywords featured in all specified categories;<br>if set to <code class="prettyprint">false</code>, you will keywords that are specified in any of the specified categories;<br>default value: <code>true</code>'
          nullable: true
        include_serp_info:
          type: boolean
          description: '<em>include data from SERP for each keyword</em><br>optional field<br>if set to <code>true</code>, we will return a <code>serp_info</code> array containing SERP data (number of search results, relevant URL, and SERP features) for every keyword in the response<br>default value: <code>false</code>'
          nullable: true
        include_clickstream_data:
          type: boolean
          description: '<em>include or exclude data from clickstream-based metrics in the result</em><br>optional field<br>if the parameter is set to <code>true</code>, you will receive <code>clickstream_keyword_info</code>, <code>keyword_info_normalized_with_clickstream</code>, and <code>keyword_info_normalized_with_bing</code> fields in the response<br>default value: <code>false</code><br>with this parameter enabled, you will be charged double the price for the request<p>learn more about how clickstream-based metrics are calculated in this <a href="https://dataforseo.com/help-center/what-are-clickstream-based-metrics-and-how-do-we-calculate-them" rel="noopener noreferrer" target="_blank">help center article</a>'
          nullable: true
        ignore_synonyms:
          type: boolean
          description: '<em>ignore highly similar keywords</em><br>optional field<br>if set to <code class="prettyprint">true</code> only core keywords will be returned, all highly similar keywords will be excluded;<br>default value: <code>false</code>'
          nullable: true
        limit:
          type: integer
          description: '<em>the maximum number of keywords in the results array</em><br>optional field<br>default value: <code>100</code><br>maximum value: <code>1000</code>'
          nullable: true
        offset:
          type: integer
          description: '<em>offset in the results array of returned keywords</em><br>optional field<br>default value: <code>0</code><br>if you specify the <code>10</code> value, the first ten keywords in the results array will be omitted and the data will be provided for the successive keywords<br><strong>Note:</strong> we recommend using this parameter only when retrieving up to 10,000 results<br>for retrieving over 10,000 results, use the <code>offset_token</code> instead.'
          nullable: true
        offset_token:
          type: string
          description: '<em>offset token for subsequent requests</em><br>optional field<br>provided in the identical filed of the response to each request;<br>use this parameter to avoid timeouts while trying to obtain over 10,000 results in a single request;<br>by specifying the unique <code>offset_token</code> value from the response array, you will get the subsequent results of the initial task;<br><code>offset_token</code> values are unique for each subsequent task<br><strong>Note:</strong> if the <code>offset_token</code> is specified in the request, all other parameters except <code>limit</code> will not be taken into account when processing a task.<br>learn more about this parameter on our <a href="https://dataforseo.com/help-center/what-is-the-difference-between-the-offset-and-offset_token-parameters#offset_token" target="_blank">Help Center</a>'
          nullable: true
        filters:
          type: array
          items:
            type: object
            nullable: true
          description: '<em>array of results filtering parameters</em><br>optional field<br><strong>you can add several filters at once (8 filters maximum)</strong><br>you should set a logical operator <code>and</code>, <code>or</code> between the conditions<br>the following operators are supported:<br><code>regex</code>, <code>not_regex</code>, <code>&lt;</code>, <code>&lt;=</code>, <code>&gt;</code>, <code>&gt;=</code>, <code>=</code>, <code>&lt;&gt;</code>, <code>in</code>, <code>not_in</code>, <code>match</code>, <code>not_match</code>, <code>ilike</code>, <code>not_ilike</code>, <code>like</code>, <code>not_like</code><br>you can use the <code>%</code> operator with <code>like</code> and <code>not_like</code>,as well as <code>ilike</code>, <code>not_ilike</code> to match any string of zero or more characters<br>example:<br><code>["keyword_info.search_volume","&gt;",0]</code><br><code>[["keyword_info.search_volume","in",[0,1000]],<br>"and",<br>["keyword_info.competition_level","=","LOW"]]</code><p><code>[["keyword_info.search_volume","&gt;",100],<br>"and",<br>[["keyword_info.cpc","&lt;",0.5],<br>"or",<br>["keyword_info.high_top_of_page_bid","&lt;=",0.5]]]</code><br>for more information about filters, please refer to <a href="/v3/dataforseo_labs/filters" target="_blank" rel="noopener noreferrer">Dataforseo Labs - Filters</a> or this <a href="https://dataforseo.com/help-center/how-to-use-filters-in-dataforseo-labs-api" target="_blank" rel="noopener noreferrer">help center guide</a>'
          nullable: true
        order_by:
          type: array
          items:
            type: string
          description: '<em>results sorting rules</em><br>optional field<br>you can use the same values as in the <code>filters</code> array to sort the results<br>possible sorting types:<br><code>asc</code> - results will be sorted in the ascending order<br><code>desc</code> - results will be sorted in the descending order<br>you should use a comma to set up a sorting type<br>example:<br><code>["keyword_info.competition,desc"]</code><br>default rule:<br><code>["keyword_info.search_volume,desc"]</code><br><strong>note that you can set no more than three sorting rules in a single request</strong><br>you should use a comma to separate several sorting rules<br>example:<br><code>["keyword_info.search_volume,desc","keyword_info.competition,asc"]</code>'
          nullable: true
        tag:
          type: string
          description: <em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response
          nullable: true
      example:
        - category_codes:
            - '12191'
            - '12193'
          language_name: English
          location_code: 2840
          include_serp_info: true
          limit: 3
    DataforseoLabsGoogleKeywordsForCategoriesLiveResultInfo:
      type: object
      properties:
        se_type:
          type: string
          description: <em>search engine type</em>
          nullable: true
        seed_categories:
          type: array
          items:
            type: integer
            nullable: true
          description: <em>categories in a POST array</em>
          nullable: true
        location_code:
          type: integer
          description: <em>location code in a POST array</em>
          nullable: true
        language_code:
          type: string
          description: <em>language code in a POST array</em>
          nullable: true
        total_count:
          type: integer
          description: <em>the total amount of results in our database relevant to your request</em>
          format: int64
          nullable: true
        items_count:
          type: integer
          description: <em>the number of results returned in the <code>items</code> array</em>
          format: int64
          nullable: true
        offset:
          type: integer
          description: <em>current offset value</em>
          nullable: true
        offset_token:
          type: string
          description: <em>offset token for subsequent requests</em><br>you can use the string provided in this field to get the subsequent results of the initial task;<br><strong>note:</strong> <code>offset_token</code> values are unique for each subsequent task
          nullable: true
        items:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/KeywordDataInfo'
            nullable: true
          description: <em>contains keyword ideas and related data</em>
          nullable: true
    DataforseoLabsGoogleKeywordsForCategoriesLiveTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/DataforseoLabsGoogleKeywordsForCategoriesLiveResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    DataforseoLabsGoogleKeywordsForCategoriesLiveResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/DataforseoLabsGoogleKeywordsForCategoriesLiveTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    DataforseoLabsGoogleDomainMetricsByCategoriesLiveRequestInfo:
      type: object
      properties:
        category_codes:
          type: array
          items:
            type: string
          description: '<em>product and service categories</em><br><strong>required field</strong><br>The maximum number of categories you can specify: 5<br>you can download <a href="https://cdn.dataforseo.com/v3/categories/categories_dataforseo_labs_2023_10_25.csv">the full list of possible categories</a>'
        first_date:
          type: string
          description: '<em>first date of comparison period</em><br><strong>required field</strong><br>first date for which domain metrics will be provided;<br>date format: <code>"yyyy-mm-dd"</code>;<br>example: <code>"2021-06-01"</code>;<br>the list available dates is available through the <a href="/v3/dataforseo_labs/google/available_history/live/" rel="noopener noreferrer" target="_blank">available history endpoint</a>;<br><strong>Note:</strong> <code>first_date</code> cannot be greater than today''s date;<br><strong>Also note:</strong> the dates specified in <code>first_date</code> and <code>second_date</code> cannot point to the same month of the same year;<br>you can specify the dates in any order: <code>first_date</code> can be greater than <code>second_date</code> and vice versa;<br>minimum date: <code>"2020-10-01"</code>'
        second_date:
          type: string
          description: '<em>second date of comparison period</em><br><strong>required field</strong><br>second date for which domain metrics will be provided;<br>date format: <code>"yyyy-mm-dd"</code>;<br>example: <code>"2021-10-01"</code>;<br>the list available dates is available through the <a href="/v3/dataforseo_labs/google/available_history/live/" rel="noopener noreferrer" target="_blank">available history endpoint</a>;<br><strong>Note:</strong> <code>second_date</code> cannot be greater than today''s date;<br><strong>Also note:</strong> the dates specified in <code>first_date</code> and <code>second_date</code> cannot point to the same month of the same year;<br>you can specify the dates in any order: <code>second_date</code> can be greater than <code>first_date</code> and vice versa;<br>minimum date: <code>"2020-10-01"</code>'
        location_name:
          type: string
          description: <em>full name of the location</em><br><strong>required field if you don't specify</strong> <code>location_code</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code>;<br>you can receive the list of available locations with their <code>location_name</code> by making a separate request to<br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br>example:<br><code class="long-string">United Kingdom</code>
        location_code:
          type: integer
          description: <em>unique location identifier</em><br><strong>required field if you don't specify</strong> <code>location_name</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code>;<br>you can receive the list of available locations with their <code>location_code</code> by making a separate request to<br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br>example:<br><code class="long-string">2840</code>
        language_name:
          type: string
          description: <em>full name of the language</em><br><strong>required field if you don't specify</strong> <code>language_code</code><br><strong>Note:</strong> it is required to specify either <code>language_name</code> or <code>language_code</code>;<br>you can receive the list of available languages with their <code>language_name</code> by making a separate request to<br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br>example:<br><code class="long-string">English</code>
        language_code:
          type: string
          description: <em>unique language identifier</em><br><strong>required field if you don't specify</strong> <code>language_name</code><br><strong>Note:</strong> it is required to specify either <code>language_name</code> or <code>language_code</code>;<br>you can receive the list of available languages with their <code>language_code</code> by making a separate request to <code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br>example:<br><code class="long-string">en</code>
          nullable: true
        item_types:
          type: array
          items:
            type: string
          description: '<em>display results by item type</em><br>optional field<br>indicates the type of search results included in the response;<p><strong>Note:</strong> if the <code>item_types</code> array contains item types that are different from the <code>organic</code> object, 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;<p>possible values: <br><code>["organic", "paid", "featured_snippet", "local_pack"]</code>;<br>default value: <br><code>["organic", "paid"]</code>'
          nullable: true
        top_categories_count:
          type: integer
          description: '<em>number of additional domain categories</em><br>optional field<br>by using this parameter, you can receive domains relevant to additional categories that are not specified in <code>category_codes</code> above;<br>to learn more about the parameter, please refer to <a href="https://dataforseo.com/help-center/what-is-top_categories_count" rel="noopener noreferrer" target="_blank">this help center article;</a><br>by default, <code>top_categories_count</code> is equal to the number of categories specified in the <code>category_codes</code> array;<br><strong>Note:</strong> <code>top_categories_count</code> cannot be less than the number of categories in the <code>category_codes</code> array;<br>maximum value: <code>5</code>'
          format: int64
          nullable: true
        include_subdomains:
          type: boolean
          description: '<em>return subdomains in the API response</em><br>optional field<br>if <code>false</code>, the API response will contain <code>main_domain</code> only;<br>if <code>true</code>, the API will return <code>main_domain</code> plus its subdomains (if available);<br>default value: <code>true</code>'
          nullable: true
        etv_min:
          type: integer
          description: '<em>minimum current organic ETV of the domain</em><br>optional field<br>if specified, the API will return only domains with <code>organic_etv</code> greater than the specified value'
          nullable: true
        etv_max:
          type: integer
          description: '<em>maximum current organic ETV of the domain</em><br>optional field<br>if specified, the API will return only domains with <code>organic_etv</code> lesser than the specified value'
          nullable: true
        correlate:
          type: boolean
          description: '<em>correlate data with previously obtained datasets</em><br>optional field<br>default value: <code>true</code>;<br>if you use this parameter, our system will correlate data you obtain now with previously obtained datasets;<br>this parameter is intended to mitigate any inconsistencies that may result from changes to our database;<br><strong>Note:</strong> we do not recommend setting <code>correlate</code> to <code>false</code>'
          nullable: true
        limit:
          type: integer
          description: '<em>the maximum number of domains in the results array</em><br>optional field<br>default value: <code>100</code>;<br>maximum value: <code>1000</code>'
          nullable: true
        offset:
          type: integer
          description: '<em>offset in the results array of returned domains</em><br>optional field<br>default value: <code>0</code>;<br>if you specify the <code>10</code> value, the first ten domains in the results array will be omitted and the data will be provided for the successive domains'
          nullable: true
        filters:
          type: array
          items:
            type: object
            nullable: true
          description: '<em>array of results filtering parameters</em><br>optional field<br><strong>you can add several filters at once (8 filters maximum)</strong>;<br>you should set a logical operator <code>and</code>, <code>or</code> between the conditions<br>the following operators are supported:<br><code>regex</code>, <code>not_regex</code>, <code>&lt;</code>, <code>&lt;=</code>, <code>&gt;</code>, <code>&gt;=</code>, <code>=</code>, <code>&lt;&gt;</code>, <code>in</code>, <code>not_in</code>, <code>match</code>, <code>not_match</code>, <code>ilike</code>, <code>not_ilike</code>, <code>like</code>, <code>not_like</code>;<br>you can use the <code>%</code> operator with <code>like</code> and <code>not_like</code>, as well as <code>ilike</code> and <code>not_ilike</code> to match any string of zero or more characters;<br>example:<br><code>["metrics_history.202110.organic.pos_1", ">", 15]</code>;<br>for more information about filters, please refer to <a href="/v3/dataforseo_labs/filters" target="_blank" rel="noopener noreferrer">Dataforseo Labs - Filters</a> or this <a href="https://dataforseo.com/help-center/how-to-use-filters-in-dataforseo-labs-api" target="_blank" rel="noopener noreferrer">help center guide</a>'
          nullable: true
        order_by:
          type: array
          items:
            type: string
          description: '<em>results sorting rules</em><br>optional field<br>you can use the same values as in the <code>filters</code> array to sort the results;<br>default rule: <code>["organic_etv,desc"]</code>;<br>possible sorting types:<br><code>asc</code> - results will be sorted in ascending order<br><code>desc</code> - results will be sorted in descending order;<br>you should use a comma to set up a sorting type;<br>example:<br><code>["organic_count,desc"]</code>;<br><strong>note that you can set no more than three sorting rules in a single request</strong>;<br>you should use a comma to separate several sorting rules;<br>example:<br><code>["organic_etv,desc","organic_count,asc"]</code>'
          nullable: true
        tag:
          type: string
          description: <em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em>;<br>you can use this parameter to identify the task and match it with the result;<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response
          nullable: true
      example:
        - location_code: 2840
          language_code: en
          category_codes:
            - '13418'
            - '11494'
          first_date: '2021-06-01'
          second_date: '2021-10-01'
          limit: 3
    DataforseoLabsGoogleDomainMetricsByCategoriesLiveItem:
      type: object
      properties:
        se_type:
          type: string
          description: <em>search engine type</em>
          nullable: true
        top_categories:
          type: array
          items:
            type: integer
            nullable: true
          description: <em>categories for which domains are collected</em>
          nullable: true
        organic_etv:
          type: number
          description: <em>current organic ETV of the domain</em>
          nullable: true
        organic_count:
          type: integer
          description: <em>current total count of organic SERPs that contain the domain</em>
          format: int64
          nullable: true
        organic_is_lost:
          type: integer
          description: '<em>current number of lost ranked elements</em><br>indicates how many ranked elements of the domain were previously presented in SERPs, but weren’t found during the last check'
          nullable: true
        organic_is_new:
          type: integer
          description: <em>current number of new ranked elements</em><br>indicates how many new ranked elements were found for the domain
          nullable: true
        domain:
          type: string
          description: <em>domain found for the specified category</em>
          nullable: true
        main_domain:
          type: string
          description: <em>primary domain</em>
          nullable: true
        metrics_history:
          type: object
          additionalProperties:
            type: object
            additionalProperties:
              type: object
              oneOf:
                - $ref: '#/components/schemas/DataforseoLabsMetricsInfo'
              nullable: true
          description: <em>historical ranking and traffic data of the domain</em>
          nullable: true
        metrics_difference:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/DataforseoLabsMetricsInfo'
          description: <em>metrics difference between <code>first_date</code> and <code>second_date</code></em><br>calculated by subtracting domain metrics as of the greater date from domain metrics as of the smaller date
          nullable: true
    DataforseoLabsGoogleDomainMetricsByCategoriesLiveResultInfo:
      type: object
      properties:
        se_type:
          type: string
          description: <em>search engine type</em>
          nullable: true
        categories:
          type: array
          items:
            type: integer
          description: <em>categories in a POST array</em>
          nullable: true
        location_code:
          type: integer
          description: <em>location code in a POST array</em>
          nullable: true
        language_code:
          type: string
          description: <em>language code in a POST array</em>
          nullable: true
        total_count:
          type: integer
          description: <em>total amount of results in our database relevant to your request</em>
          format: int64
          nullable: true
        items_count:
          type: integer
          description: <em>the number of results returned in the <code>items</code> array</em>
          format: int64
          nullable: true
        items:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/DataforseoLabsGoogleDomainMetricsByCategoriesLiveItem'
            nullable: true
          description: <em>contains historical ranking and traffic data</em>
          nullable: true
    DataforseoLabsGoogleDomainMetricsByCategoriesLiveTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/DataforseoLabsGoogleDomainMetricsByCategoriesLiveResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    DataforseoLabsGoogleDomainMetricsByCategoriesLiveResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/DataforseoLabsGoogleDomainMetricsByCategoriesLiveTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    DataforseoLabsGoogleTopSearchesLiveRequestInfo:
      type: object
      properties:
        location_name:
          type: string
          description: <em>full name of the location</em><br><strong>required field if you don't specify</strong> <code>location_code</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_name</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class="long-string">United Kingdom</code>
        location_code:
          type: integer
          description: <em>location code</em><br><strong>required field if you don't specify</strong> <code>location_name</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_code</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class="long-string">2840</code>
        language_name:
          type: string
          description: <em>full name of the language</em><br><strong>required field if you don't specify</strong> <code>language_code</code><br><strong>Note:</strong> it is required to specify either <code>language_name</code> or <code>language_code</code><br>you can receive the list of available locations with their <code>language_name</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class="long-string">English</code>
        language_code:
          type: string
          description: <em>language code</em><br><strong>required field if you don't specify</strong> <code>language_name</code><br><strong>Note:</strong> it is required to specify either <code>language_name</code> or <code>language_code</code><br>you can receive the list of available locations with their <code>language_code</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class="long-string">en</code>
          nullable: true
        include_serp_info:
          type: boolean
          description: '<em>include data from SERP for each keyword</em><br>optional field<br>if set to <code>true</code>, we will return a <code>serp_info</code> array containing SERP data (number of search results, relevant URL, and SERP features) for every keyword in the response<br>default value: <code>false</code>'
          nullable: true
        include_clickstream_data:
          type: boolean
          description: '<em>include or exclude data from clickstream-based metrics in the result</em><br>optional field<br>if the parameter is set to <code>true</code>, you will receive <code>clickstream_keyword_info</code>, <code>keyword_info_normalized_with_clickstream</code>, and <code>keyword_info_normalized_with_bing</code> fields in the response<br>default value: <code>false</code><br>with this parameter enabled, you will be charged double the price for the request<p>learn more about how clickstream-based metrics are calculated in this <a href="https://dataforseo.com/help-center/what-are-clickstream-based-metrics-and-how-do-we-calculate-them" rel="noopener noreferrer" target="_blank">help center article</a>'
          nullable: true
        ignore_synonyms:
          type: boolean
          description: '<em>ignore highly similar keywords</em><br>optional field<br>if set to <code class="prettyprint">true</code> only core keywords will be returned, all highly similar keywords will be excluded;  <br>default value: <code>false</code>'
          nullable: true
        filters:
          type: array
          items:
            type: object
            nullable: true
          description: '<em>array of results filtering parameters</em><br>optional field<br><strong>you can add several filters at once (8 filters maximum)</strong><br>you should set a logical operator <code>and</code>, <code>or</code> between the conditions<br>the following operators are supported:<br><code>regex</code>, <code>not_regex</code>, <code>&lt;</code>, <code>&lt;=</code>, <code>&gt;</code>, <code>&gt;=</code>, <code>=</code>, <code>&lt;&gt;</code>, <code>in</code>, <code>not_in</code>, <code>match</code>, <code>not_match</code>, <code>ilike</code>, <code>not_ilike</code>, <code>like</code>,<code>not_like</code><br>you can use the <code>%</code> operator with <code>like</code> and <code>not_like</code>,as well as <code>ilike</code> and <code>not_ilike</code> to match any string of zero or more characters<br>example:<br><code>["keyword_info.search_volume","&gt;",0]</code><p><code>[["keyword_info.search_volume","in",[0,1000]],<br>"and",<br>["keyword_info.competition_level","=","LOW"]]</code><p><code>[["keyword_info.search_volume","&gt;",100],<br>"and",<br>[["keyword_info.cpc","&lt;",0.5],<br>"or",<p>["keyword_info.high_top_of_page_bid","&lt;=",0.5]]]</code><br>for more information about filters, please refer to <a href="/v3/dataforseo_labs/filters" target="_blank" rel="noopener noreferrer">Dataforseo Labs - Filters</a> or this <a href="https://dataforseo.com/help-center/how-to-use-filters-in-dataforseo-labs-api" rel="noopener noreferrer" target="_blank">help center guide</a>'
          nullable: true
        order_by:
          type: array
          items:
            type: string
          description: '<em>results sorting rules</em><br>optional field<br>you can use the same values as in the <code>filters</code> array to sort the results<br>possible sorting types:<br><code>asc</code> - results will be sorted in the ascending order<br><code>desc</code> - results will be sorted in the descending order<br>you should use a comma to set up a sorting type<br>example:<br><code>["keyword_info.competition,desc"]</code><br>default rule:<br><code>["keyword_info.search_volume,desc"]</code><br><strong>note that you can set no more than three sorting rules in a single request</strong><br>you should use a comma to separate several sorting rules<br>example:<br><code>["keyword_info.search_volume,desc","keyword_info.cpc,desc"]</code>'
          nullable: true
        tag:
          type: string
          description: <em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response
          nullable: true
        limit:
          type: integer
          description: '<em>the maximum number of returned keywords</em><br>optional field<br></strong>note:</strong> you can get more than 1000 results by using the <code>offset_token</code> provided in the response to each subsequent request<br>default value: <code>1000</code><br>maximum value: <code>1000</code>'
          nullable: true
        offset:
          type: integer
          description: '<em>offset in the results array of returned keywords</em><br>optional field<br>default value: <code>0</code><br>if you specify the <code>10</code> value, the first ten keywords in the results array will be omitted and the data will be provided for the successive keywords<br><strong>Note:</strong> we recommend using this parameter only when retrieving up to 10,000 results<br>for retrieving over 10,000 results, use the <code>offset_token</code> instead.'
          nullable: true
        offset_token:
          type: string
          description: '<em>offset token for subsequent requests</em><br>optional field<br>provided in the identical filed of the response to each request;<br>use this parameter to avoid timeouts while trying to obtain over 10,000 results in a single request;<br>by specifying the unique <code>offset_token</code> value from the response array, you will get the subsequent results of the initial task;<br><code>offset_token</code> values are unique for each subsequent task <br><strong>Note:</strong> if the <code>offset_token</code> is specified in the request, all other parameters except <code>limit</code> will not be taken into account when processing a task.<br>learn more about this parameter on our <a href="https://dataforseo.com/help-center/what-is-the-difference-between-the-offset-and-offset_token-parameters#offset_token" target="_blank">Help Center</a>'
          nullable: true
      example:
        - language_name: English
          location_code: 2840
          limit: 3
    DataforseoLabsGoogleTopSearchesLiveResultInfo:
      type: object
      properties:
        se_type:
          type: string
          description: <em>search engine type</em>
          nullable: true
        location_code:
          type: integer
          description: <em>location code in a POST array</em>
          nullable: true
        language_code:
          type: string
          description: <em>language code in a POST array</em>
          nullable: true
        total_count:
          type: integer
          description: <em>total amount of results in our database relevant to your request</em>
          format: int64
          nullable: true
        items_count:
          type: integer
          description: <em>the number of results returned in the <code>items</code> array</em>
          format: int64
          nullable: true
        offset:
          type: integer
          description: <em>current offset value</em>
          nullable: true
        offset_token:
          type: string
          description: <em>offset token for subsequent requests</em><br>you can use the string provided in this field to get the subsequent results of the initial task;<br><strong>note:</strong> <code>offset_token</code> values are unique for each subsequent task
          nullable: true
        items:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/KeywordDataInfo'
            nullable: true
          description: <em>contains keywords and related data</em>
          nullable: true
    DataforseoLabsGoogleTopSearchesLiveTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/DataforseoLabsGoogleTopSearchesLiveResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    DataforseoLabsGoogleTopSearchesLiveResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/DataforseoLabsGoogleTopSearchesLiveTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    DataforseoLabsGoogleRankedKeywordsLiveRequestInfo:
      type: object
      properties:
        target:
          type: string
          description: '<em>domain name or page url</em><br><strong>required field</strong><br>the domain name of the target website, subdomain or URL of the target webpage;<br>the <strong>domain name</strong> must be specified <strong>without</strong> <code>https://</code> or <code>www.</code>;<br>the <strong>subdomain</strong> must be specified <strong>without</strong> <code>https://</code>;<br>the <strong>webpage URL</strong> must be specified <strong>with</strong> <code>https://</code> or <code>www.</code><br><strong>Note:</strong> if you specify the <strong>webpage URL</strong> without <code>https://</code> or <code>www.</code>, the result will be returned for the <strong>entire domain</strong> rather than the specific page'
        location_name:
          type: string
          description: '<em>full name of the location</em><br>optional field<br>if you use this field, you don''t need to specify <code>location_code</code><br>you can receive the list of available locations with their <code>location_name</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>ignore this field to get the results for all available locations<br>example:<br><code class="long-string">United Kingdom</code>'
          nullable: true
        location_code:
          type: integer
          description: '<em>location code</em><br>optional field<br>if you use this field, you don''t need to specify <code>location_name</code><br>you can receive the list of available locations with their <code>location_code</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>ignore this field to get the results for all available locations<br>example:<br><code class="long-string">2840</code>'
          nullable: true
        language_name:
          type: string
          description: '<em>full name of the language</em><br>optional field<br>if you use this field, you don''t need to specify <code>language_code</code><br>you can receive the list of available languages with their <code>language_name</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>ignore this field to get the results for all available languages<br>example:<br><code class="long-string">English</code>'
          nullable: true
        language_code:
          type: string
          description: '<em>language code</em><br>optional field<br>if you use this field, you don''t need to specify <code>language_name</code><br>you can receive the list of available languages with their <code>language_code</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>ignore this field to get the results for all available languages<br>example:<br><code class="long-string">en</code>'
          nullable: true
        ignore_synonyms:
          type: boolean
          description: '<em>ignore highly similar keywords</em><br>optional field<br>if set to <code class="prettyprint">true</code> only core keywords will be returned, all highly similar keywords will be excluded;  <br>default value: <code>false</code>'
          nullable: true
        item_types:
          type: array
          items:
            type: string
          description: '<em>display results by item type</em><br>optional field<br>indicates the type of search results included in the response<p><strong>Note:</strong> if the <code>item_types</code> array contains item types that are different from <code>organic</code>, 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;<p>possible values: <br><code>["organic", "paid", "featured_snippet", "local_pack", "ai_overview_reference"]</code><br>default value: <br><code>["organic", "paid"]</code>'
          nullable: true
        include_clickstream_data:
          type: boolean
          description: '<em>include or exclude data from clickstream-based metrics in the result</em><br>optional field<br>if the parameter is set to <code>true</code>, you will receive <code>clickstream_keyword_info</code>, <code>clickstream_etv</code>, <code>clickstream_gender_distribution</code>, <code>clickstream_age_distribution</code>, <code>keyword_info_normalized_with_clickstream</code>, and <code>keyword_info_normalized_with_bing</code> fields in the response<br>default value: <code>false</code><br>with this parameter enabled, you will be charged double the price for the request<p>learn more about how clickstream-based metrics are calculated in this <a href="https://dataforseo.com/help-center/what-are-clickstream-based-metrics-and-how-do-we-calculate-them" rel="noopener noreferrer" target="_blank">help center article</a>'
          nullable: true
        limit:
          type: integer
          description: '<em>the maximum number of returned keywords</em><br>optional field<br>default value: <code>100</code><br>maximum value: <code>1000</code>'
          nullable: true
        offset:
          type: integer
          description: '<em>offset in the results array of returned keywords</em><br>optional field<br>default value: <code>0</code><br>if you specify the <code>10</code> value, the first ten keywords in the results array will be omitted and the data will be provided for the successive keywords'
          nullable: true
        load_rank_absolute:
          type: boolean
          description: '<em>return rankings distribution by <code>rank_absolute</code></code></em><br>optional field<br>default value: <code>false</code><br>if set to <code>true</code>, we will return the field <code>metrics_absolute</code> containing rankings distribution by the <code>rank_absolute</code> parameter that indicates the result’s position among all SERP elements'
          nullable: true
        historical_serp_mode:
          type: string
          description: '<em>data collection mode</em><br>optional field<br>you can use this field to filter the results;<br>possible types of filtering:<br><code>live</code> — return keywords for which the specified <code>target</code> currently has ranking results in SERP;<br><code>lost</code> — return keywords for which the specified <code>target</code> had previously had ranking results in SERP, but didn''t have them during the last check;<br><code>all</code> — return both types of keywords.<br>default value: <code>live</code>'
          nullable: true
        filters:
          type: array
          items:
            type: object
            nullable: true
          description: '<em>array of results filtering parameters</em><br>optional field<br><strong>you can add several filters at once (8 filters maximum)</strong><br>you should set a logical operator <code>and</code>, <code>or</code> between the conditions<br>the following operators are supported:<br><code>regex</code>, <code>not_regex</code>, <code>&lt;</code>, <code>&lt;=</code>, <code>&gt;</code>, <code>&gt;=</code>, <code>=</code>, <code>&lt;&gt;</code>, <code>in</code>, <code>not_in</code>, <code>match</code>, <code>not_match</code>, <code>ilike</code>, <code>not_ilike</code>, <code>like</code>, <code>not_like</code><br>you can use the <code>%</code> operator with <code>like</code> and <code>not_like</code>, as well as <code>ilike</code> and <code>not_ilike</code> to match any string of zero or more characters<br>example:<br><code>["ranked_serp_element.serp_item.rank_group","&lt;=",10]</code><p><code>[["ranked_serp_element.serp_item.rank_group","&lt;=",10],<br>"and",<br>["ranked_serp_element.serp_item.type","&lt;&gt;","paid"]]</code><p><code>[["keyword_data.keyword_info.search_volume","&lt;&gt;",0],<br>"and",<br>[["ranked_serp_element.serp_item.type","&lt;&gt;","paid"],"or",["ranked_serp_element.serp_item.is_malicious","=",false]]]</code><p>if you want to get the keywords a particular webpage ranks for, you can use a <code><a href="/v3/dataforseo_labs/google/ranked_keywords/live/#target">target</a></code> field or filter by the <code>ranked_serp_element.serp_item.relative_url</code> parameter<br>example:<br><code>["ranked_serp_element.serp_item.relative_url", "=", "/apis/rank-tracker-api"]</code><br>for more information about filters, please refer to <a href="/v3/dataforseo_labs/filters" target="_blank" rel="noopener noreferrer">Dataforseo Labs - Filters</a> or this <a href="https://dataforseo.com/help-center/how-to-use-filters-in-dataforseo-labs-api" rel="noopener noreferrer" target="_blank">help center guide</a>'
          nullable: true
        order_by:
          type: array
          items:
            type: string
          description: '<em>results sorting rules</em><br>optional field<br>you can use the same values as in the <code>filters</code> array to sort the results<br>possible sorting types:<br><code>asc</code> - results will be sorted in the ascending order<br><code>desc</code> - results will be sorted in the descending order<br>you should use a comma to set up a sorting type<br>example:<br><code>["keyword_data.keyword_info.competition,desc"]</code><br>default rule:<br><code>["ranked_serp_element.serp_item.rank_group,asc"]</code><br><strong>note that you can set no more than three sorting rules in a single request</strong><br>you should use a comma to separate several sorting rules<br>example:<br><code>["keyword_data.keyword_info.search_volume,desc","keyword_data.keyword_info.cpc,desc"]</code>'
          nullable: true
        tag:
          type: string
          description: <em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response
          nullable: true
      example:
        - target: dataforseo.com
          language_name: English
          location_name: United States
          load_rank_absolute: true
          limit: 3
    RankChanges:
      type: object
      properties:
        previous_rank_absolute:
          type: integer
          description: '<em>previous absolute rank in SERP</em><br>            indicates previous rank of the element in Google SERP;<br>            if this element is new, the value will be <code>null</code>'
          nullable: true
        is_new:
          type: boolean
          description: <em>number of new ranked elements</em><br>            indicates how many new ranked elements were found for this domain or webpage
          nullable: true
        is_up:
          type: boolean
          description: <em>rank went up</em><br>            indicates how many ranked elements of this target went up in Google Search
          nullable: true
        is_down:
          type: boolean
          description: <em>rank went down</em><br>            indicates how many ranked elements of this target went down in Google Search
          nullable: true
    BacklinksInfo:
      type: object
      properties:
        referring_domains:
          type: integer
          description: <em>average number of referring domains</em>
          format: int64
          nullable: true
        referring_main_domains:
          type: integer
          description: <em>average number of referring main domains</em>
          format: int64
          nullable: true
        referring_pages:
          type: integer
          description: <em>average number of referring pages</em>
          format: int64
          nullable: true
        dofollow:
          type: integer
          description: <em>average number of dofollow links</em>
          format: int64
          nullable: true
        backlinks:
          type: integer
          description: <em>average number of backlinks</em>
          format: int64
          nullable: true
        time_update:
          type: string
          description: '<em>date and time when backlink data was updated</em><br>            in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”;<br>            example:<br>            <code class="long-string">2019-11-15 12:57:46 +00:00</code>'
          nullable: true
    RankInfo:
      type: object
      properties:
        page_rank:
          type: integer
          description: <em>page rank</em><br>            <code>page_rank</code> is calculated based on the method for node ranking in a linked database - a principle used in the original Google PageRank algorithm;<br>            learn more about the metric and how it is calculated in <a href="https://dataforseo.com/help-center/what_is_rank_in_backlinks_api" rel="noopener noreferrer" target="_blank">this help center article</a>
          nullable: true
        main_domain_rank:
          type: integer
          description: <em>average main domain rank</em><br>            learn more about the metric and its calculation formula in <a href="https://dataforseo.com/help-center/what_is_rank_in_backlinks_api" rel="noopener noreferrer" target="_blank">this help center article</a>
          nullable: true
    DataLabsPaidSerpElementItem:
      type: object
      allOf:
        - type: object
          oneOf:
            - $ref: '#/components/schemas/BaseDataforseoLabsApiElementItem'
          nullable: true
        - type: object
          properties:
            title:
              type: string
              description: <em>title of the result in SERP</em>
              nullable: true
            domain:
              type: string
              description: <em>subdomain in SERP</em>
              nullable: true
            description:
              type: string
              description: <em>description of the results element in SERP</em>
              nullable: true
            breadcrumb:
              type: string
              description: <em>breadcrumb in SERP</em>
              nullable: true
            url:
              type: string
              description: <em> relevant URL in SERP</em>
              nullable: true
            highlighted:
              type: array
              items:
                type: string
                nullable: true
              description: <em>words highlighted in bold within the results <code>description</code></em>
              nullable: true
            extra:
              type: object
              additionalProperties:
                type: string
                nullable: true
              nullable: true
            description_rows:
              type: array
              items:
                type: string
                nullable: true
              description: '<em>extended description</em><br>            if there is none, equals <code>null</code>'
              nullable: true
            links:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AdLinkElement'
                nullable: true
              description: '<em>sitelinks</em><br>            the links shown below some of Google''s search results<br>            if there are none, equals <code>null</code>'
              nullable: true
            main_domain:
              type: string
              description: <em>primary domain name in SERP</em>
              nullable: true
            relative_url:
              type: string
              description: <em>URL in SERP that does not specify the HTTPs protocol and domain name</em>
              nullable: true
            etv:
              type: number
              description: <em>estimated traffic volume</em><br>            estimated organic monthly traffic to the domain or webpage;<br>            calculated as the product of CTR (click-through-rate) and search volume values of all keywords the domain or webpage rank for;<br>            learn more about how the metric is calculated in <a href="https://dataforseo.com/help-center/how-is-etv-calculated" rel="noopener noreferrer" target="_blank">this help center article</a>
              nullable: true
            estimated_paid_traffic_cost:
              type: number
              description: <em>estimated cost of converting organic search traffic into paid</em><br>            represents the estimated monthly cost of running ads for all keywords that a domain or webpage ranks for;<br>            the metric is calculated as the product of organic <code>etv</code> and paid <code>cpc</code> values and indicates the cost of driving the estimated volume of monthly organic traffic through PPC advertising in Google Search;<br>            learn more about how the metric is calculated in <a href="https://dataforseo.com/help-center/how-is-traffic-cost-calculated" rel="noopener noreferrer" target="_blank">this help center article</a>
              nullable: true
            clickstream_etv:
              type: number
              description: '<em>estimated traffic volume based on clickstream data</em><br>            calculated as the product of click-through-rate and clickstream search volume values of all keywords the domain or webpage ranks for;<br>            to retrieve results for this field, the parameter <code>include_clickstream_data</code> must be set to <code>true</code>;<br>            learn more about how the metric is calculated in this <a href="https://dataforseo.com/help-center/whats-clickstream-estimated-traffic-volume-and-how-is-it-calculated" rel="noopener noreferrer" target="_blank">help center article</a>'
              format: double
              nullable: true
            rank_changes:
              type: object
              oneOf:
                - $ref: '#/components/schemas/RankChanges'
              properties:
                previous_rank_absolute:
                  type: number
                  description: "previous absolute rank in SERP\nindicates previous rank of the element in Google SERP;\nif this element is new, the value will be null"
                  nullable: true
                is_new:
                  type: boolean
                  description: "element was previously present in SERP\nif the value is true, previously collected SERP didn’t contain this element"
                is_up:
                  type: boolean
                  description: "rank of this element went up\nif the value is true, position of the element in SERP is higher compared to the previous check"
                is_down:
                  type: boolean
                  description: "rank of this element went down\nif the value is true, position of the element in SERP is lower compared to the previous check"
              description: <em>changes in rankings</em><br>            contains information about the ranking changes of the SERP element since the <code>previous_updated_time</code>
              nullable: true
            backlinks_info:
              type: object
              oneOf:
                - $ref: '#/components/schemas/BacklinksInfo'
              description: <em>backlinks information for the relevant page URL</em>
              nullable: true
            rank_info:
              type: object
              oneOf:
                - $ref: '#/components/schemas/RankInfo'
              description: <em>page and domain rank information</em>
              nullable: true
    RankedSerpElement:
      type: object
      properties:
        se_type:
          type: string
          description: <em>search engine type</em>
          nullable: true
        serp_item:
          type: object
          oneOf:
            - $ref: '#/components/schemas/BaseDataforseoLabsApiElementItem'
          description: <em>contains data on the SERP element</em><br>            the list of supported SERP elements can be found below
          nullable: true
        check_url:
          type: string
          description: <em>direct URL to search engine results</em><br>            you can use it to make sure that we provided accurate results
          nullable: true
        serp_item_types:
          type: array
          items:
            type: string
            nullable: true
          description: '<em>types of search results in SERP</em><br>            contains types of search results (items) found in SERP<br>            possible item types:<br>            <code>answer_box</code>, <code>app</code>, <code>carousel</code>, <code>multi_carousel</code>, <code>featured_snippet</code>, <code>google_flights</code>, <code>google_reviews</code>, <code>third_party_reviews</code>, <code>google_posts</code>, <code>images</code>, <code>jobs</code>, <code>knowledge_graph</code>, <code>local_pack</code>, <code>hotels_pack</code>, <code>map</code>, <code>organic</code>, <code>paid</code>, <code>people_also_ask</code>, <code>related_searches</code>, <code>people_also_search</code>, <code>shopping</code>, <code>top_stories</code>, <code>twitter</code>, <code>video</code>, <code>events</code>, <code>mention_carousel</code>, <code>recipes</code>, <code>top_sights</code>, <code>scholarly_articles</code>, <code>popular_products</code>, <code>podcasts</code>, <code>questions_and_answers</code>, <code>find_results_on</code>, <code>stocks_box</code>, <code>visual_stories</code>, <code>commercial_units</code>, <code>local_services</code>, <code>google_hotels</code>, <code>math_solver</code>, <code>currency_box</code>, <code>product_considerations</code>, <code>found_on_web</code>, <code>short_videos</code>, <code>refine_products</code>, <code>explore_brands</code>, <code>perspectives</code>, <code>discussions_and_forums</code>, <code>compare_sites</code>, <code>courses</code>, <code>ai_overview</code>;<br>            <strong>note</strong> that the actual results will be returned only for <code>organic</code>, <code>paid</code>, <code>featured_snippet</code>, and <code>local_pack</code> elements'
          nullable: true
        se_results_count:
          type: integer
          description: <em>number of search results for the returned keyword</em>
          format: int64
          nullable: true
        keyword_difficulty:
          type: integer
          description: '<em>difficulty of ranking in the first top-10 organic results for a keyword</em><br>            indicates the chance of getting in top-10 organic results for a keyword on a logarithmic scale from 0 to 100;<br>            calculated by analysing, among other parameters, link profiles of the first 10 pages in SERP;<br>            learn more about the metric in <a href="https://dataforseo.com/help-center/what-is-keyword-difficulty-and-how-is-it-calculated" rel="noopener noreferrer" target="_blank">this help center guide</a>'
          nullable: true
        is_lost:
          type: boolean
          description: '<em>lost ranked elements</em><br>            indicates how many ranked elements of this target were previously presented in SERPs, but weren''t found during the last check'
          nullable: true
        last_updated_time:
          type: string
          description: '<em>date and time when keyword data was updated</em><br>            in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”<br>            example:<br>            <code class="long-string">2019-11-15 12:57:46 +00:00</code>'
          nullable: true
        previous_updated_time:
          type: string
          description: '<em>previous to the most recent date and time when SERP data was updated</em><br>            in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”<br>            example:<br>            <code class="long-string">2019-10-15 12:57:46 +00:00</code>'
          nullable: true
    DataforseoLabsGoogleRankedKeywordsLiveItem:
      type: object
      properties:
        se_type:
          type: string
          description: <em>search engine type</em>
          nullable: true
        keyword_data:
          type: object
          oneOf:
            - $ref: '#/components/schemas/KeywordDataInfo'
          description: <em>keyword data for the returned keyword</em>
          nullable: true
        ranked_serp_element:
          type: object
          oneOf:
            - $ref: '#/components/schemas/RankedSerpElement'
          description: <em>contains data on the domain's SERP element found for the returned <code>keyword</code></em>
          nullable: true
    DataLabsOrganicSerpElementItem:
      type: object
      allOf:
        - type: object
          oneOf:
            - $ref: '#/components/schemas/BaseDataforseoLabsApiElementItem'
          nullable: true
        - type: object
          properties:
            domain:
              type: string
              description: <em>subdomain in SERP</em>
              nullable: true
            title:
              type: string
              description: <em>title of the result in SERP</em>
              nullable: true
            url:
              type: string
              description: <em> relevant URL in SERP</em>
              nullable: true
            breadcrumb:
              type: string
              description: <em>breadcrumb in SERP</em>
              nullable: true
            website_name:
              type: string
              description: <em>relevant website name in SERP</em>
              nullable: true
            is_image:
              type: boolean
              description: <em>indicates whether the element contains an <code class="prettyprint">image</code></em><br><strong>Note:</strong> this check no longer appears in SERP
              nullable: true
            is_video:
              type: boolean
              description: <em>indicates whether the element contains a <code class="prettyprint">video</code></em><br><strong>Note:</strong> this check no longer appears in SERP
              nullable: true
            is_featured_snippet:
              type: boolean
              description: <em>indicates whether the element is a <code class="prettyprint">featured_snippet</code></em><br><strong>Note:</strong> this check no longer appears in SERP
              nullable: true
            is_malicious:
              type: boolean
              description: <em>indicates whether the element is marked as malicious</em><br><strong>Note:</strong> this check no longer appears in SERP
              nullable: true
            description:
              type: string
              description: <em>description of the results element in SERP</em>
              nullable: true
            pre_snippet:
              type: string
              description: <em>includes additional information appended before the result description in SERP</em>
              nullable: true
            extended_snippet:
              type: string
              description: <em>includes additional information appended after the result description in SERP</em>
              nullable: true
            amp_version:
              type: boolean
              description: <em>Accelerated Mobile Pages</em><br>            indicates whether an item has the Accelerated Mobile Page (AMP) version
              nullable: true
            rating:
              type: object
              oneOf:
                - $ref: '#/components/schemas/RatingInfo'
              description: <em>the item's rating </em><br>            the popularity rate based on reviews and displayed in SERP
              nullable: true
            highlighted:
              type: array
              items:
                type: string
                nullable: true
              description: <em>words highlighted in bold within the results <code>description</code></em>
              nullable: true
            links:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/LinkElement'
                nullable: true
              description: '<em>sitelinks</em><br>            the links shown below some of Google''s search results<br>            if there are none, equals <code>null</code>'
              nullable: true
            about_this_result:
              type: object
              oneOf:
                - $ref: '#/components/schemas/AboutThisResultElement'
              description: <em>contains information from the 'About this result' panel</em><br>            <a href="https://blog.google/products/search/learn-more-and-get-more-from-search/">'About this result' panel</a> provides additional context about why Google returned this result for the given query;<br>            this feature appears after clicking on the three dots next to most results
              nullable: true
              deprecated: true
            main_domain:
              type: string
              description: <em>primary domain name in SERP</em>
              nullable: true
            relative_url:
              type: string
              description: <em>URL in SERP that does not specify the HTTPs protocol and domain name</em>
              nullable: true
            etv:
              type: number
              description: <em>estimated traffic volume</em><br>            estimated organic monthly traffic to the domain or webpage;<br>            calculated as the product of CTR (click-through-rate) and search volume values of all keywords the domain or webpage rank for;<br>            learn more about how the metric is calculated in <a href="https://dataforseo.com/help-center/how-is-etv-calculated" rel="noopener noreferrer" target="_blank">this help center article</a>
              nullable: true
            estimated_paid_traffic_cost:
              type: number
              description: <em>estimated cost of converting organic search traffic into paid</em><br>            represents the estimated monthly cost of running ads for all keywords that a domain or webpage ranks for;<br>            the metric is calculated as the product of organic <code>etv</code> and paid <code>cpc</code> values and indicates the cost of driving the estimated volume of monthly organic traffic through PPC advertising in Google Search;<br>            learn more about how the metric is calculated in <a href="https://dataforseo.com/help-center/how-is-traffic-cost-calculated" rel="noopener noreferrer" target="_blank">this help center article</a>
              nullable: true
            clickstream_etv:
              type: number
              description: '<em>estimated traffic volume based on clickstream data</em><br>            calculated as the product of click-through-rate and clickstream search volume values of all keywords the domain or webpage ranks for;<br>            to retrieve results for this field, the parameter <code>include_clickstream_data</code> must be set to <code>true</code>;<br>            learn more about how the metric is calculated in this <a href="https://dataforseo.com/help-center/whats-clickstream-estimated-traffic-volume-and-how-is-it-calculated" rel="noopener noreferrer" target="_blank">help center article</a>'
              format: double
              nullable: true
            rank_changes:
              type: object
              oneOf:
                - $ref: '#/components/schemas/RankChanges'
              properties:
                previous_rank_absolute:
                  type: number
                  description: "previous absolute rank in SERP\nindicates previous rank of the element in Google SERP;\nif this element is new, the value will be null"
                  nullable: true
                is_new:
                  type: boolean
                  description: "element was previously present in SERP\nif the value is true, previously collected SERP didn’t contain this element"
                is_up:
                  type: boolean
                  description: "rank of this element went up\nif the value is true, position of the element in SERP is higher compared to the previous check"
                is_down:
                  type: boolean
                  description: "rank of this element went down\nif the value is true, position of the element in SERP is lower compared to the previous check"
              description: <em>changes in rankings</em><br>            contains information about the ranking changes of the SERP element since the <code>previous_updated_time</code>
              nullable: true
            backlinks_info:
              type: object
              oneOf:
                - $ref: '#/components/schemas/BacklinksInfo'
              description: <em>backlinks information for the relevant page URL</em>
              nullable: true
            rank_info:
              type: object
              oneOf:
                - $ref: '#/components/schemas/RankInfo'
              description: <em>page and domain rank information</em>
              nullable: true
    DataforseoLabsGoogleRankedKeywordsLiveResultInfo:
      type: object
      properties:
        se_type:
          type: string
          description: <em>search engine type</em>
          nullable: true
        target:
          type: string
          description: <em>target domain or webpage in a POST array</em>
          nullable: true
        location_code:
          type: integer
          description: '<em>location code in a POST array</em><br>            if there is no data, then the value is <code>null</code>'
          nullable: true
        language_code:
          type: string
          description: '<em>language code in a POST array</em><br>            if there is no data, then the value is <code>null</code>'
          nullable: true
        total_count:
          type: integer
          description: <em>total number of results in our database relevant to your request</em>
          format: int64
          nullable: true
        items_count:
          type: integer
          description: <em>the number of results returned in the <code>items</code> array</em>
          format: int64
          nullable: true
        metrics:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/DataforseoLabsMetricsInfo'
          description: <em>ranking data relevant to the specified domain or webpage </em><br>            ranking data is provided by the <code>rank_group</code> parameters that show the result’s rank considering only equivalent SERP elements
          nullable: true
        metrics_absolute:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/DataforseoLabsMetricsInfo'
          description: <em>ranking data relevant to the specified domain or webpage</em><br>            ranking data is provided by the <code>rank_absolute</code> parameters that indicate the result’s position among all SERP elements
          nullable: true
        items:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/DataforseoLabsGoogleRankedKeywordsLiveItem'
            nullable: true
          description: <em>contains ranked keywords and related data</em>
          nullable: true
    DataforseoLabsGoogleRankedKeywordsLiveTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/DataforseoLabsGoogleRankedKeywordsLiveResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    DataforseoLabsGoogleRankedKeywordsLiveResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/DataforseoLabsGoogleRankedKeywordsLiveTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    DataforseoLabsGoogleSerpCompetitorsLiveRequestInfo:
      type: object
      properties:
        keywords:
          type: array
          items:
            type: string
          description: <em>keywords array</em><br><strong>required field</strong><br>the results will be based on the keywords you specify in this array<br>UTF-8 encoding;<br>the keywords will be converted to lowercase format;<br><strong>you can specify the maximum of 200 keywords</strong><p>learn more about rules and limitations of <code>keyword</code> and <code>keywords</code> fields in DataForSEO APIs in this <a href="https://dataforseo.com/help-center/rules-and-limitations-of-keyword-and-keywords-fields-in-dataforseo-apis" rel="noopener noreferrer" target="_blank">Help Center article</a>
        location_name:
          type: string
          description: <em>full name of the location</em><br><strong>required field if you don't specify</strong> <code>location_code</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with <code>location_name</code> parameters by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class="long-string">United Kingdom</code>
        location_code:
          type: integer
          description: <em>unique location identifier</em><br><strong>required field if you don't specify</strong> <code>location_name</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_code</code> parameters by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class="long-string">2840</code>
        language_name:
          type: string
          description: <em>full name of the language</em><br><strong>required field if you don't specify</strong> <code>language_code</code><br><strong>Note:</strong> it is required to specify either <code>language_name</code> or <code>language_code</code><br>you can receive the list of available languages with their <code>language_name</code> parameters by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class="long-string">English</code>
        language_code:
          type: string
          description: <em>unique language identifier</em><br><strong>required field if you don't specify</strong> <code>language_name</code><br><strong>Note:</strong> it is required to specify either <code>language_name</code> or <code>language_code</code><br>you can receive the list of available languages with their <code>language_code</code> parameters by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class="long-string">en</code>
          nullable: true
        include_subdomains:
          type: boolean
          description: '<em>indicates if the subdomains will be included in the search</em><br>optional field<br>if set to <code>false</code>, the subdomains will be ignored<br>default value: <code>true</code>'
          nullable: true
        item_types:
          type: array
          items:
            type: string
          description: '<em>search results type</em><br>indicates type of search results included in the response<br>optional field<p>possible values: <br><code>["organic", "paid", "featured_snippet", "local_pack"]</code><br>default value: <br><code>["organic", "paid"]</code>'
          nullable: true
        limit:
          type: integer
          description: '<em>the maximum number of returned domains</em><br>optional field<br>default value: <code>100</code><br>maximum value: <code>1000</code>'
          nullable: true
        offset:
          type: integer
          description: '<em>offset in the results array of returned domains</em><br>optional field<br>default value: <code>0</code><br>if you specify the <code>10</code> value, the first ten domains in the results array will be omitted and the data will be provided for the successive domains'
          nullable: true
        filters:
          type: array
          items:
            type: object
            nullable: true
          description: '<em>array of results filtering parameters</em><br>optional field<br><strong>you can add several filters at once (8 filters maximum)</strong><br>you should set a logical operator <code>and</code>, <code>or</code> between the conditions<br>the following operators are supported:<br><code>regex</code>, <code>not_regex</code>, <code>&lt;</code>, <code>&lt;=</code>, <code>&gt;</code>, <code>&gt;=</code>, <code>=</code>, <code>&lt;&gt;</code>, <code>in</code>, <code>not_in</code>, <code>match</code>, <code>not_match</code>, <code>ilike</code>, <code>not_ilike</code>, <code>like</code>, <code>not_like</code><br>you can use the <code>%</code> operator with <code>like</code> and <code>not_like</code>, as well as <code>ilike</code> and <code>not_ilike</code> to match any string of zero or more characters<br>example:<br><code>["median_position","in",[1,10]]</code><p><code>[["median_position","in",[1,10]],"and",["domain","not_like","%wikipedia.org%"]]</code><p><code>[["domain","not_like","%wikipedia.org%"],<br>"and",<br>[["relevant_serp_items","&gt;",0],"or",["median_position","in",[1,10]]]]</code><br>for more information about filters, please refer to <a href="/v3/dataforseo_labs/filters" target="_blank" rel="noopener noreferrer">Dataforseo Labs - Filters</a> or this <a href="https://dataforseo.com/help-center/how-to-use-filters-in-dataforseo-labs-api" rel="noopener noreferrer" target="_blank">help center guide</a>'
          nullable: true
        order_by:
          type: array
          items:
            type: string
          description: '<em>results sorting rules</em><br>optional field<br>you can use the same values as in the <code>filters</code> array to sort the results<br>possible sorting types:<br><code>asc</code> - results will be sorted in the ascending order<br><code>desc</code> - results will be sorted in the descending order<br>the comma is used as a separator<br>example:<br><code>["avg_position,asc"]</code><br>default rule:<br><code>["rating,desc"]</code><br><strong>note that you can set no more than three sorting rules in a single request</strong><br>you should use a comma to separate several sorting rules<br>example:<br><code>["avg_position,asc","etv,desc"]</code>'
          nullable: true
        tag:
          type: string
          description: <em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response
          nullable: true
      example:
        - keywords:
            - phone
          language_name: English
          location_code: 2840
          item_types:
            - organic
          limit: 5
    DataforseoLabsGoogleSerpCompetitorsLiveItem:
      type: object
      properties:
        se_type:
          type: string
          description: <em>search engine type</em>
          nullable: true
        domain:
          type: string
          description: <em>domain name of the detected SERP competitor</em>
          nullable: true
        avg_position:
          type: number
          description: <em>the average position of the domain for the specified keywords</em><br>the arithmetic mean of values in the <code>keywords_positions</code> array
          format: float
          nullable: true
        median_position:
          type: number
          description: <em>the median position of the domain for the specified keywords</em><br>the median of the values in the <code>keywords_positions</code> array
          nullable: true
        rating:
          type: number
          description: <em>the margin between the greatest possible and actual keyword positions</em><br>represents the relative visibility rate of the domain in SERP for the specified keywords<br>calculated as <em>sum(100-<code>keywords_positions</code>)</em>
          nullable: true
        etv:
          type: number
          description: <em>estimated traffic volume</em><br>represents the estimated monthly traffic that specified keywords are driving to the website<br>calculated as the sum of the products of the specified keywords' search volume values and CTR (click-through-rate) rates at certain positions in SERP<br>learn more about how the metric is calculated in <a href="https://dataforseo.com/help-center/how-is-etv-calculated" rel="noopener noreferrer" target="_blank">this help center article</a>
          nullable: true
        keywords_count:
          type: integer
          description: <em>the number of specified keywords the domain has positions for in SERPs</em>
          format: int64
          nullable: true
        visibility:
          type: number
          description: '<em>SERP visibility rate</em><br>represents the website visibility rate based on the SERP positions of the specified keywords<br>Keywords with positions in the range from <strong>1 to 10</strong> are assigned the visibility index from 1 to 0.1, respectively<br>Keywords with positions in the range from <strong>11 to 20</strong> have the fixed visibility index of 0.05<br>keywords with positions from <strong>20 to 100</strong> have the visibility index equal to 0'
          nullable: true
        relevant_serp_items:
          type: integer
          description: <em>the number of SERP elements relevant to the domain</em><br>represents the number of search results in SERP relevant to the domain for the specified keywords
          nullable: true
        keywords_positions:
          type: object
          additionalProperties:
            type: array
            items:
              type: integer
              nullable: true
            nullable: true
          description: <em>keyword positions</em><br>SERP positions the related domain holds in SERP for the specified keywords
          nullable: true
    DataforseoLabsGoogleSerpCompetitorsLiveResultInfo:
      type: object
      properties:
        se_type:
          type: string
          description: <em>search engine type</em>
          nullable: true
        seed_keywords:
          type: array
          items:
            type: string
            nullable: true
          description: <em>keywords specified in the request</em><br><strong>keyword is returned with decoded %## (plus character '+' will be decoded to a space character)</strong>
          nullable: true
        location_code:
          type: integer
          description: '<em>location code in a POST array</em><br>if there is no data, then the value is_<code>null</code>n'
          nullable: true
        language_code:
          type: string
          description: '<em>language code in a POST array</em><br>if there is no data, then the value is_<code>null</code>n'
          nullable: true
        total_count:
          type: integer
          description: <em>the total amount of results in our database relevant to your request</em>
          format: int64
          nullable: true
        items_count:
          type: integer
          description: <em>the number of results returned in the <code>items</code> array</em>
          format: int64
          nullable: true
        items:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/DataforseoLabsGoogleSerpCompetitorsLiveItem'
            nullable: true
          description: <em>contains detected SERP competitors and related data</em>
          nullable: true
    DataforseoLabsGoogleSerpCompetitorsLiveTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/DataforseoLabsGoogleSerpCompetitorsLiveResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    DataforseoLabsGoogleSerpCompetitorsLiveResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/DataforseoLabsGoogleSerpCompetitorsLiveTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    DataforseoLabsGoogleCompetitorsDomainLiveRequestInfo:
      type: object
      properties:
        target:
          type: string
          description: '<em>domain</em><br><strong>required field</strong><br>the domain name of the target website<br>the domain should be specified without <code>https://</code> and <code>www.</code><br>you can specify page URL, but the results will be specific to the domain in the specified URL'
        location_name:
          type: string
          description: <em>full name of the location</em><br><strong>required field if you don't specify</strong> <code>location_code</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_name</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class="long-string">United Kingdom</code>
        location_code:
          type: integer
          description: <em>location code</em><br><strong>required field if you don't specify</strong> <code>location_name</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_code</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class="long-string">2840</code>
        language_name:
          type: string
          description: <em>full name of the language</em><br><strong>required field if you don't specify</strong> <code>language_code</code><br><strong>Note:</strong> it is required to specify either <code>language_name</code> or <code>language_code</code><br>you can receive the list of available languages with their <code>language_name</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class="long-string">English</code>
        language_code:
          type: string
          description: <em>language code</em><br><strong>required field if you don't specify</strong> <code>language_name</code><br><strong>Note:</strong> it is required to specify either <code>language_name</code> or <code>language_code</code><br>you can receive the list of available languages with their <code>language_code</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class="long-string">en</code>
          nullable: true
        item_types:
          type: array
          items:
            type: string
          description: '<em>display results by item type</em><br>optional field<br>indicates the type of search results included in the response<p><strong>Note:</strong> if the <code>item_types</code> array contains item types that are different from <code>organic</code>, 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;<p>possible values: <br><code>["organic", "paid", "featured_snippet", "local_pack"]</code><br>default value: <br><code>["organic", "paid"]</code>'
          nullable: true
        include_clickstream_data:
          type: boolean
          description: '<em>include or exclude data from clickstream-based metrics in the result</em><br>optional field<br>if the parameter is set to_<code>true</code>, you will receive <code>clickstream_etv</code>, <code>clickstream_gender_distribution</code>, and_<code>clickstream_age_distribution</code>_fields with clickstream data in the response<br>default value: <code>false</code><br>with this parameter enabled, you will be charged double the price for the request<p>learn more about how clickstream-based metrics are calculated in this <a href="https://dataforseo.com/help-center/what-are-clickstream-based-metrics-and-how-do-we-calculate-them" rel="noopener noreferrer" target="_blank">help center article</a>n'
          nullable: true
        filters:
          type: array
          items:
            type: object
            nullable: true
          description: '<em>array of results filtering parameters</em><br>optional field<br><strong>you can add several filters at once (8 filters maximum)</strong><br>you should set a logical operator <code>and</code>, <code>or</code> between the conditions<br>the following operators are supported:<br><code>regex</code>, <code>not_regex</code>, <code>&lt;</code>, <code>&lt;=</code>, <code>&gt;</code>, <code>&gt;=</code>, <code>=</code>, <code>&lt;&gt;</code>, <code>in</code>, <code>not_in</code><br>example:<br><code>["metrics.organic.count","&gt;",50]</code><p><code>[[["metrics.organic.count","&gt;=",50],"and",["metrics.organic.pos_1","in",[1,5]]],<br>"or",<br>["metrics.organic.etv","&gt;=","100"]]</code><p>for more information about filters, please refer to <a href="/v3/dataforseo_labs/filters" target="_blank" rel="noopener noreferrer">Dataforseo Labs - Filters</a> or this <a href="https://dataforseo.com/help-center/how-to-use-filters-in-dataforseo-labs-api" rel="noopener noreferrer" target="_blank">help center guide</a>'
          nullable: true
        order_by:
          type: array
          items:
            type: string
          description: '<em>results sorting rules</em><br>optional field<br>you can use the same values as in the <code>filters</code> array to sort the results<br>possible sorting types:<br><code>asc</code> - results will be sorted in the ascending order<br><code>desc</code> - results will be sorted in the descending order<br>you should use a comma to specify a sorting type<br>example:<br><code>["metrics.paid.etv,asc"]</code><br><strong>Note:</strong> you can set no more than three sorting rules in a single request<br>you should use a comma to separate several sorting rules<br>example:<br><code>["metrics.organic.etv,desc","metrics.paid.count,asc"]</code><p>default rule:<br><code>["metrics.organic.count,desc"]</code><br><strong>Note:</strong> if the <code>item_types</code> array contains item types that are different from <code>organic</code>, the results will be ordered by the first item type in the array'
          nullable: true
        limit:
          type: integer
          description: '<em>the maximum number of returned domains</em><br>optional field<br>default value: <code>100</code><br>maximum value: <code>1000</code>'
          nullable: true
        offset:
          type: integer
          description: '<em>offset in the results array of returned domains</em><br>optional field<br>default value: <code>0</code><br>if you specify the <code>10</code> value, the first ten keywords in the results array will be omitted and the data will be provided for the successive keywords'
          nullable: true
        max_rank_group:
          type: integer
          description: '<em>maximum rank up to which competitors will be considered</em><br>optional field<br>default value: <code>100</code><p>if you specify <code>10</code> here, we will extract competitors from the top 10 Google search results only'
          nullable: true
        exclude_top_domains:
          type: boolean
          description: '<em>indicates whether to exclude world''s largest websites</em><br>optional field<br>default value: <code>false</code><br>set to <code>true</code> if you want to get highly-relevant competitors excluding the websites listed below:<p><code>wikipedia.org<br>pinterest.com<br>amazon.com<br>google.com<br>facebook.com<br>wordpress.com<br>medium.com<br>quora.com<br>reddit.com<br>youtube.com<br>ebay.com<br>uol.com.br<br>instagram.com<br>olx.com<br>twitter.com<br>linkedin.com<br>slideshare.net</code>'
          nullable: true
        exclude_domains:
          type: array
          items:
            type: string
          description: '<em>exclude domains from the results</em><br>optional field<br>use this parameter to exclude specific domains from the results<br><strong>Note:</strong> you can specify up to 1000 domains in this array<p>example:<br><code>"exclude_domains": [<br>"reddit.com",<br>"youtube.com"<br>]</code>'
          nullable: true
        intersecting_domains:
          type: array
          items:
            type: string
          description: '<em>additional domains for improving results accuracy</em><br>optional field<br>to improve the accuracy of the result, you can specify domains that are known to intersect with the <code>target</code> in SERPs;<br>if you use this array, metrics in the result will be based on SERPs where both <code>target</code> website and <code>intersecting_domains</code> appear;<br><strong>Note:</strong> you can specify up to 20 domains in this array'
          nullable: true
        ignore_synonyms:
          type: boolean
          description: '<em>ignore highly similar keywords</em><br>optional field<br>if set to_<code class="prettyprint">true</code>, only core keywords will be returned, all highly similar keywords will be excluded;  <br>default value: <code>false</code>n'
          nullable: true
        tag:
          type: string
          description: <em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response
          nullable: true
      example:
        - target: newmouth.com
          intersecting_domains:
            - dentaly.org
            - health.com
            - trysnow.com
          language_name: English
          location_code: 2840
          limit: 3
    DataforseoLabsGoogleCompetitorsDomainLiveItem:
      type: object
      properties:
        se_type:
          type: string
          description: <em>search engine type</em>
          nullable: true
        domain:
          type: string
          description: <em>domain name</em>
          nullable: true
        avg_position:
          type: number
          description: <em>average position of the domain in SERP</em><br><strong>Note:</strong> average position is calculated for intersected keywords only;<br>the value for a given domain may differ when combined with different target websites
          format: float
          nullable: true
        sum_position:
          type: integer
          description: <em>sum of all domain positions in SERP</em><br><strong>Note:</strong> average position is calculated for intersected keywords only;<br>the value for a given domain may differ when combined with different target websites
          nullable: true
        intersections:
          type: integer
          description: <em>number of intersecting keywords</em>
          nullable: true
        full_domain_metrics:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/DataforseoLabsMetricsInfo'
          description: <em>metrics for all keywords of the domain</em><br>full overview of ranking and traffic data relevant to all keywords that the provided <code>domain</code> is ranking for
          nullable: true
        metrics:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/DataforseoLabsMetricsInfo'
          description: <em>metrics for intersecting keywords</em><br>ranking and traffic data relevant to the keywords that the provided <code>domain</code> shares with the <code>target</code> domain<br><strong>note:</strong> in this array ranking and traffic data is provided for the <code>target</code> considering the keywords <code>target</code> shares in search with the competitor's <code>domain</code>
          nullable: true
        competitor_metrics:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/DataforseoLabsMetricsInfo'
          description: <em>metrics for intersecting keywords</em><br>ranking and traffic data relevant to the keywords that the provided <code>domain</code> shares with the <code>target</code> domain<br><strong>note:</strong> in this array ranking and traffic data is provided for the returned competitor's <code>domain</code>
          nullable: true
    DataforseoLabsGoogleCompetitorsDomainLiveResultInfo:
      type: object
      properties:
        se_type:
          type: string
          description: <em>search engine type</em>
          nullable: true
        target:
          type: string
          description: <em>target domain in a POST array</em>
          nullable: true
        location_code:
          type: integer
          description: <em>location code in a POST array</em>
          nullable: true
        language_code:
          type: string
          description: <em>language code in a POST array</em>
          nullable: true
        total_count:
          type: integer
          description: <em>total amount of results in our database relevant to your request</em>
          format: int64
          nullable: true
        items_count:
          type: integer
          description: <em>the number of results returned in the <code>items</code> array</em>
          format: int64
          nullable: true
        items:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/DataforseoLabsGoogleCompetitorsDomainLiveItem'
            nullable: true
          description: <em>contains data related to the <code>target</code> and competitor domains</em>
          nullable: true
    DataforseoLabsGoogleCompetitorsDomainLiveTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/DataforseoLabsGoogleCompetitorsDomainLiveResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    DataforseoLabsGoogleCompetitorsDomainLiveResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/DataforseoLabsGoogleCompetitorsDomainLiveTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    DataforseoLabsGoogleDomainIntersectionLiveRequestInfo:
      type: object
      properties:
        target1:
          type: string
          description: domain            required field            the domain name of the first target website            the domain should be specified without https:// and www.
        target2:
          type: string
          description: domain            required field            the domain name of the second target website            the domain should be specified without https:// and www.
        location_name:
          type: string
          description: 'full name of the location            required field if you don''t specify location_code            Note: it is required to specify either location_name or location_code            you can receive the list of available locations with their location_name by making a separate request to the            https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages            example:            United Kingdom'
          nullable: true
        location_code:
          type: integer
          description: 'location code            required field if you don''t specify location_name            Note: it is required to specify either location_name or location_code            you can receive the list of available locations with their location_code by making a separate request to the            https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages            example:            2840'
          nullable: true
        language_name:
          type: string
          description: 'full name of the language            required field if you don''t specify language_code            Note: it is required to specify either language_name or language_code            you can receive the list of available languages with their language_name by making a separate request to the            https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages            example:            English'
          nullable: true
        language_code:
          type: string
          description: 'language code            required field if you don''t specify language_name            Note: it is required to specify either language_name or language_code            you can receive the list of available languages with their language_code by making a separate request to the            https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages            example:            en'
          nullable: true
        intersections:
          type: boolean
          description: 'domain intersections in SERP            optional field            if you set intersections to true, you will get the keywords for which both target domains specified as target1 and target2 have results within the same SERP; the corresponding SERP elements for both domains will be provided in the results array            Note: this endpoint will not provide results if the number of intersecting keywords exceeds 10 million            if you specify intersections: false, you will get the keywords for which the domain specified as target1 has results in SERP, and the domain specified as target2 doesn''t;            thus, the corresponding SERP elements and other data will be provided for the domain specified as target1only            default value: true'
          nullable: true
        item_types:
          type: array
          items:
            type: string
          description: 'search results type            indicates type of search results included in the response            optional field            possible values:            ["organic", "paid", "featured_snippet", "local_pack"]            default value:            ["organic", "paid"]'
          nullable: true
        include_serp_info:
          type: boolean
          description: 'include data from SERP for each keyword            optional field            if set to true, we will return a serp_info array containing SERP data (number of search results, relevant URL, and SERP features) for every keyword in the response            default value: false'
          nullable: true
        include_clickstream_data:
          type: boolean
          description: 'include or exclude data from clickstream-based metrics in the result            optional field            if the parameter is set to true, you will receive clickstream_keyword_info, clickstream_etv, keyword_info_normalized_with_clickstream, and keyword_info_normalized_with_bing fields in the response            default value: false            with this parameter enabled, you will be charged double the price for the request            learn more about how clickstream-based metrics are calculated in this help center article'
          nullable: true
        limit:
          type: integer
          description: 'the maximum number of returned keywords            optional field            default value: 100            maximum value: 1000'
          nullable: true
        offset:
          type: integer
          description: 'offset in the items array of returned keywords            optional field            default value: 0            if 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'
          nullable: true
        filters:
          type: array
          items:
            type: object
            nullable: true
          description: 'array of results filtering parameters            optional field            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, match, not_match, ilike, not_ilike, like, not_like            you can use the % operator with like and not_like, as well as ilike and not_ilike to match any string of zero or more characters            example:            ["keyword_data.keyword_info.search_volume","in",[100,1000]]            [["first_domain_serp_element.etv",">",0],"and",["first_domain_serp_element.description","like","%goat%"]]            [["keyword_data.keyword_info.search_volume",">",100],                "and",                [["first_domain_serp_element.description","like","%goat%"],                "or",                ["second_domain_serp_element.type","=","organic"]]]            for more information about filters, please refer to Dataforseo Labs - Filters or this help center guide'
          nullable: true
        order_by:
          type: array
          items:
            type: string
          description: 'results sorting rules            optional field            you can use the same values as in the filters array to sort the results            possible sorting types:            asc - results will be sorted in the ascending order            desc - results will be sorted in the descending order            you should use a comma to set up a sorting parameter            example:            ["keyword_data.keyword_info.competition,desc"]            default rule:            ["keyword_data.keyword_info.search_volume,desc"]            note that you can set no more than three sorting rules in a single request            you should use a comma to separate several sorting rules            example:            ["keyword_data.keyword_info.search_volume,desc","keyword_data.keyword_info.cpc,desc"]'
          nullable: true
        tag:
          type: string
          description: user-defined task identifier            optional field            the character limit is 255            you can use this parameter to identify the task and match it with the result            you will find the specified tag value in the data object of the response
          nullable: true
      example:
        - target1: mom.com
          target2: quora.com
          language_code: en
          location_code: 2840
          include_serp_info: true
          limit: 3
    DataforseoLabsGoogleDomainIntersectionLiveItem:
      type: object
      properties:
        se_type:
          type: string
          description: search engine type
          nullable: true
        keyword_data:
          type: object
          oneOf:
            - $ref: '#/components/schemas/KeywordDataInfo'
          description: keyword data for the returned keyword
          nullable: true
        first_domain_serp_element:
          type: object
          oneOf:
            - $ref: '#/components/schemas/BaseDataforseoLabsApiElementItem'
          description: contains data on the first domain's SERP element found for the returned keyword            the list of supported SERP elements can be found below
          nullable: true
        second_domain_serp_element:
          type: object
          oneOf:
            - $ref: '#/components/schemas/BaseDataforseoLabsApiElementItem'
          description: contains data on the second domain's SERP element found for the returned keyword            the list of supported SERP elements can be found below
          nullable: true
    DataLabsLocalPackSerpElementItem:
      type: object
      allOf:
        - type: object
          oneOf:
            - $ref: '#/components/schemas/BaseDataforseoLabsApiElementItem'
          nullable: true
        - type: object
          properties:
            title:
              type: string
              description: title of the result in SERP
              nullable: true
            description:
              type: string
              description: description of the results element in SERP
              nullable: true
            domain:
              type: string
              description: subdomain in SERP
              nullable: true
            phone:
              type: string
              description: phone number
              nullable: true
            url:
              type: string
              description: relevant URL in SERP
              nullable: true
            is_paid:
              type: boolean
              description: indicates whether the element is an ad
              nullable: true
            rating:
              type: object
              oneOf:
                - $ref: '#/components/schemas/RatingInfo'
              description: the item's rating             the popularity rate based on reviews and displayed in SERP
              nullable: true
            main_domain:
              type: string
              description: primary domain name in SERP
              nullable: true
            relative_url:
              type: string
              description: URL in SERP that does not specify the HTTPs protocol and domain name
              nullable: true
            etv:
              type: number
              description: estimated traffic volume            estimated organic monthly traffic to the domain            calculated as the product of CTR (click-through-rate) and search volume values of the returned keyword            learn more about how the metric is calculated in this help center article
              nullable: true
            estimated_paid_traffic_cost:
              type: number
              description: estimated cost of paid monthly search traffic            represents the estimated cost of paid monthly traffic (USD) based on etv and cpc values            learn more about how the metric is calculated in this help center article
              nullable: true
            clickstream_etv:
              type: number
              description: 'estimated traffic volume based on clickstream data            calculated as the product of click-through-rate and clickstream search volume values of all keywords the domain ranks for            to retrieve results for this field, the parameter include_clickstream_data must be set to true            learn more about how the metric is calculated in this help center article'
              format: double
              nullable: true
            rank_changes:
              type: object
              oneOf:
                - $ref: '#/components/schemas/RankChanges'
              properties:
                previous_rank_absolute:
                  type: number
                  description: "previous absolute rank in SERP\nindicates previous rank of the element in Google SERP;\nif this element is new, the value will be null"
                  nullable: true
                is_new:
                  type: boolean
                  description: "element was previously present in SERP\nif the value is true, previously collected SERP didn’t contain this element"
                is_up:
                  type: boolean
                  description: "rank of this element went up\nif the value is true, position of the element in SERP is higher compared to the previous check"
                is_down:
                  type: boolean
                  description: "rank of this element went down\nif the value is true, position of the element in SERP is lower compared to the previous check"
              description: changes in rankings            contains information about the ranking changes of the SERP element since the previous_updated_time
              nullable: true
            backlinks_info:
              type: object
              oneOf:
                - $ref: '#/components/schemas/BacklinksInfo'
              description: backlinks information for the ranked website
              nullable: true
            rank_info:
              type: object
              oneOf:
                - $ref: '#/components/schemas/RankInfo'
              description: page and domain rank information
              nullable: true
    DataforseoLabsGoogleDomainIntersectionLiveResultInfo:
      type: object
      properties:
        se_type:
          type: string
          description: search engine type
          nullable: true
        target1:
          type: string
          description: the first target domain in a POST array
          nullable: true
        target2:
          type: string
          description: the second target domain in a POST array
          nullable: true
        location_code:
          type: integer
          description: location code in a POST array
          nullable: true
        language_code:
          type: string
          description: language code in a POST array
          nullable: true
        total_count:
          type: integer
          description: total amount of results in our database relevant to your request
          format: int64
          nullable: true
        items_count:
          type: integer
          description: the number of results returned in the items array
          format: int64
          nullable: true
        items:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/DataforseoLabsGoogleDomainIntersectionLiveItem'
            nullable: true
          description: 'contains keywords, relevant SERP elements and related data'
          nullable: true
    DataforseoLabsGoogleDomainIntersectionLiveTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/DataforseoLabsGoogleDomainIntersectionLiveResultInfo'
                nullable: true
              description: array of results
              nullable: true
    DataforseoLabsGoogleDomainIntersectionLiveResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/DataforseoLabsGoogleDomainIntersectionLiveTaskInfo'
                nullable: true
              description: array of tasks
              nullable: true
    DataforseoLabsGoogleSubdomainsLiveRequestInfo:
      type: object
      properties:
        target:
          type: string
          description: <em>domain</em><br><strong>required field</strong><br>the domain name of the target website<br>the domain should be specified without <code>https://</code> and <code>www.</code>
        location_name:
          type: string
          description: '<em>full name of the location</em><br>optional field<br>if you use this field, you don''t need to specify <code>location_code</code><br>you can receive the list of available locations with their <code>location_name</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>ignore this field to get the results for all available locations<br>example:<br><code class="long-string">United Kingdom</code>'
          nullable: true
        location_code:
          type: integer
          description: '<em>location code</em><br>optional field<br>if you use this field, you don''t need to specify <code>location_name</code><br>you can receive the list of available locations with their <code>location_code</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>ignore this field to get the results for all available locations<br>example:<br><code class="long-string">2840</code>'
          nullable: true
        language_name:
          type: string
          description: '<em>full name of the language</em><br>optional field<br>if you use this field, you don''t need to specify <code>language_code</code><br>you can receive the list of available languages with their <code>language_name</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>ignore this field to get the results for all available languages<br>example:<br><code class="long-string">English</code>'
          nullable: true
        language_code:
          type: string
          description: '<em>language code</em><br>optional field<br>if you use this field, you don''t need to specify <code>language_name</code><br>you can receive the list of available languages with their <code>language_code</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>ignore this field to get the results for all available languages<br>example:<br><code class="long-string">en</code>'
          nullable: true
        item_types:
          type: array
          items:
            type: string
          description: '<em>display results by item type</em><br>optional field<br>indicates the type of search results included in the response<p><strong>Note:</strong> if the <code>item_types</code> array contains item types that are different from <code>organic</code>, 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;<p>possible values: <br><code>["organic", "paid", "featured_snippet", "local_pack"]</code><br>default value: <br><code>["organic", "paid"]</code>'
          nullable: true
        include_clickstream_data:
          type: boolean
          description: '<em>include or exclude data from clickstream-based metrics in the result</em><br>optional field<br>if the parameter is set to <code>true</code>, you will receive <code>clickstream_etv</code>, <code>clickstream_gender_distribution</code>, and <code>clickstream_age_distribution</code> fields with clickstream data in the response<br>default value: <code>false</code><br>with this parameter enabled, you will be charged double the price for the request<p>learn more about how clickstream-based metrics are calculated in this <a href="https://dataforseo.com/help-center/what-are-clickstream-based-metrics-and-how-do-we-calculate-them" rel="noopener noreferrer" target="_blank">help center article</a>'
          nullable: true
        historical_serp_mode:
          type: string
          description: '<em>data collection mode</em><br>optional field<br>you can use this field to filter the results;<br>possible types of filtering:<br><code>live</code> — return metrics for SERPs in which the specified <code>target</code> currently has ranking results;<br><code>lost</code> — return metrics for SERPs in which the specified <code>target</code> had previously had ranking results, but didn''t have them during the last check;<br><code>all</code> — return metrics for both types of SERPs.<br>default value: <code>live</code>'
          nullable: true
        ignore_synonyms:
          type: boolean
          description: '<em>ignore highly similar keywords</em><br>optional field<br>if set to <code class="prettyprint">true</code>, only core keywords will be returned, all highly similar keywords will be excluded;  <br>default value: <code>false</code>'
          nullable: true
        filters:
          type: array
          items:
            type: object
            nullable: true
          description: '<em>array of results filtering parameters</em><br>optional field<br><strong>you can add several filters at once (8 filters maximum)</strong><br>you should set a logical operator <code>and</code>, <code>or</code> between the conditions<br>the following operators are supported:<br><code>regex</code>, <code>not_regex</code>, <code>&lt;</code>, <code>&lt;=</code>, <code>&gt;</code>, <code>&gt;=</code>, <code>=</code>, <code>&lt;&gt;</code>, <code>in</code>, <code>not_in</code><br>example:<br><code>["metrics.paid.count","&gt;",0]</code><p><code>[["metrics.paid.count","&gt;",0],"and",["metrics.paid.etv","&gt;","50"]]</code><p><code>[["metrics.organic.count","&gt;","10"],<br>"and",<br>[["metrics.organic.pos_1","&lt;&gt;",0],"or",["metrics.organic.pos_2_3","&lt;&gt;",0]]]</code><br>for more information about filters, please refer to <a href="/v3/dataforseo_labs/filters" target="_blank" rel="noopener noreferrer">Dataforseo Labs - Filters</a> or this <a href="https://dataforseo.com/help-center/how-to-use-filters-in-dataforseo-labs-api" rel="noopener noreferrer" target="_blank">help center guide</a>'
          nullable: true
        order_by:
          type: array
          items:
            type: string
          description: '<em>results sorting rules</em><br>optional field<br>you can use the same values as in the <code>filters</code> array to sort the results<br>possible sorting types:<br><code>asc</code> - results will be sorted in the ascending order<br><code>desc</code> - results will be sorted in the descending order<br>you should use a comma to specify a sorting type<br>example:<br><code>["metrics.paid.etv,asc"]</code><br><strong>Note:</strong> you can set no more than three sorting rules in a single request<br>you should use a comma to separate several sorting rules<br>example:<br><code>["metrics.organic.etv,desc","metrics.paid.count,asc"]</code><p>default rule:<br><code>["metrics.organic.count,desc"]</code><br><strong>Note:</strong> if the <code>item_types</code> array contains item types that are different from <code>organic</code>, the results will be ordered by the first item type in the array'
          nullable: true
        limit:
          type: integer
          description: '<em>the maximum number of returned keywords</em><br>optional field<br>default value: <code>100</code><br>maximum value: <code>1000</code>'
          nullable: true
        offset:
          type: integer
          description: '<em>offset in the results array of returned keywords</em><br>optional field<br>default value: <code>0</code><br>if you specify the <code>10</code> value, the first ten keywords in the results array will be omitted and the data will be provided for the successive keywords'
          nullable: true
        tag:
          type: string
          description: <em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response
          nullable: true
      example:
        - target: dataforseo.com
          language_name: English
          location_code: 2840
          filters:
            - 
              - metrics.organic.pos_1
              - <>
              - 0
            - or
            - 
              - metrics.organic.pos_2_3
              - <>
              - 0
    DataforseoLabsGoogleSubdomainsLiveItem:
      type: object
      properties:
        se_type:
          type: string
          description: <em>search engine type</em>
          nullable: true
        subdomain:
          type: string
          description: <em>returned subdomain</em>
          nullable: true
        metrics:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/DataforseoLabsMetricsInfo'
          description: <em>ranking data relevant to subdomain</em>
          nullable: true
    DataforseoLabsGoogleSubdomainsLiveResultInfo:
      type: object
      properties:
        se_type:
          type: string
          description: <em>search engine type</em>
          nullable: true
        target:
          type: string
          description: <em>domain in a POST array</em>
          nullable: true
        location_code:
          type: integer
          description: <em>location code in a POST array</em>
          nullable: true
        language_code:
          type: string
          description: <em>language code in a POST array</em>
          nullable: true
        total_count:
          type: integer
          description: <em>total amount of results in our database relevant to your request</em>
          format: int64
          nullable: true
        items_count:
          type: integer
          description: <em>the number of results returned in the <code>items</code> array</em>
          format: int64
          nullable: true
        items:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/DataforseoLabsGoogleSubdomainsLiveItem'
            nullable: true
          description: <em>contains subdomains and related data</em>
          nullable: true
    DataforseoLabsGoogleSubdomainsLiveTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/DataforseoLabsGoogleSubdomainsLiveResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    DataforseoLabsGoogleSubdomainsLiveResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/DataforseoLabsGoogleSubdomainsLiveTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    DataforseoLabsGoogleRelevantPagesLiveRequestInfo:
      type: object
      properties:
        target:
          type: string
          description: <em>domain</em><br><strong>required field</strong><br>the domain name of the target website<br>the domain should be specified without <code>https://</code> and <code>www.</code>
        location_name:
          type: string
          description: '<em>full name of the location</em><br>optional field<br>if you use this field, you don''t need to specify <code>location_code</code><br>you can receive the list of available locations with their <code>location_name</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>ignore this field to get the results for all available locations<br>example:<br><code class="long-string">United Kingdom</code>'
          nullable: true
        location_code:
          type: integer
          description: '<em>location code</em><br>optional field<br>if you use this field, you don''t need to specify <code>location_name</code><br>you can receive the list of available locations with their <code>location_code</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>ignore this field to get the results for all available locations<br>example:<br><code class="long-string">2840</code>'
          nullable: true
        language_name:
          type: string
          description: '<em>full name of the language</em><br>optional field<br>if you use this field, you don''t need to specify <code>language_code</code><br>you can receive the list of available languages with their <code>language_name</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>ignore this field to get the results for all available languages<br>example:<br><code class="long-string">English</code>'
          nullable: true
        language_code:
          type: string
          description: '<em>language code</em><br>optional field<br>if you use this field, you don''t need to specify <code>language_name</code><br>you can receive the list of available languages with their <code>language_code</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>ignore this field to get the results for all available languages<br>example:<br><code class="long-string">en</code>'
          nullable: true
        item_types:
          type: array
          items:
            type: string
          description: '<em>display results by item type</em><br>optional field<br>indicates the type of search results included in the response<p><strong>Note:</strong> if the <code>item_types</code> array contains item types that are different from <code>organic</code>, 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;<p>possible values: <br><code>["organic", "paid", "featured_snippet", "local_pack"]</code><br>default value: <br><code>["organic", "paid"]</code>'
          nullable: true
        include_clickstream_data:
          type: boolean
          description: '<em>include or exclude data from clickstream-based metrics in the result</em><br>optional field<br>if the parameter is set to <code>true</code>, you will receive <code>clickstream_etv</code>, <code>clickstream_gender_distribution</code>, and <code>clickstream_age_distribution</code> fields with clickstream data in the response<br>default value: <code>false</code><br>with this parameter enabled, you will be charged double the price for the request<p>learn more about how clickstream-based metrics are calculated in this <a href="https://dataforseo.com/help-center/what-are-clickstream-based-metrics-and-how-do-we-calculate-them" rel="noopener noreferrer" target="_blank">help center article</a>'
          nullable: true
        limit:
          type: integer
          description: '<em>the maximum number of returned pages</em><br>optional field<br>default value: <code>100</code><br>maximum value: <code>1000</code>'
          nullable: true
        offset:
          type: integer
          description: '<em>offset in the results array of returned pages</em><br>optional field<br>default value: <code>0</code><br>if you specify the <code>10</code> value, the first ten pages in the results array will be omitted and the data will be provided for the successive pages'
          nullable: true
        historical_serp_mode:
          type: string
          description: '<em>data collection mode</em><br>optional field<br>you can use this field to filter the results;<br>possible types of filtering:<br><code>live</code> — return metrics for SERPs in which the specified <code>target</code> currently has ranking results;<br><code>lost</code> — return metrics for SERPs in which the specified <code>target</code> had previously had ranking results, but didn''t have them during the last check;<br><code>all</code> — return metrics for both types of SERPs.<br>default value: <code>live</code>'
          nullable: true
        ignore_synonyms:
          type: boolean
          description: '<em>ignore highly similar keywords</em><br>optional field<br>if set to <code class="prettyprint">true</code>, only core keywords will be returned, all highly similar keywords will be excluded;  <br>default value: <code>false</code>'
          nullable: true
        filters:
          type: array
          items:
            type: object
            nullable: true
          description: '<em>array of results filtering parameters</em><br>optional field<br><strong>you can add several filters at once (8 filters maximum)</strong><br>you should set a logical operator <code>and</code>, <code>or</code> between the conditions<br>the following operators are supported:<br><code>regex</code>, <code>not_regex</code>, <code>&lt;</code>, <code>&lt;=</code>, <code>&gt;</code>, <code>&gt;=</code>, <code>=</code>, <code>&lt;&gt;</code>, <code>in</code>, <code>not_in</code><p>example:<br><code>["metrics.paid.count","&gt;",0]</code><p><code>[["metrics.organic.count","&gt;",50],"and",["metrics.organic.pos_1","&lt;&gt;",0]]</code><p><code>[[""metrics.organic.count","&gt;",50"],<br>"and",<br>[["metrics.organic.pos_1","&lt;&gt;",0],"or",["metrics.organic.pos_2_3","&lt;&gt;",0]]]</code><br>for more information about filters, please refer to <a href="/v3/dataforseo_labs/filters" target="_blank" rel="noopener noreferrer">Dataforseo Labs - Filters</a> or this <a href="https://dataforseo.com/help-center/how-to-use-filters-in-dataforseo-labs-api" rel="noopener noreferrer" target="_blank">help center guide</a>'
          nullable: true
        order_by:
          type: array
          items:
            type: string
          description: '<em>results sorting rules</em><br>optional field<br>you can use the same values as in the <code>filters</code> array to sort the results<br>possible sorting types:<br><code>asc</code> - results will be sorted in the ascending order<br><code>desc</code> - results will be sorted in the descending order<br>you should use a comma to specify a sorting type<br>example:<br><code>["metrics.paid.etv,asc"]</code><br><strong>Note:</strong> you can set no more than three sorting rules in a single request<br>you should use a comma to separate several sorting rules<br>example:<br><code>["metrics.organic.etv,desc","metrics.paid.count,asc"]</code><p>default rule:<br><code>["metrics.organic.count,desc"]</code><br><strong>Note:</strong> if the <code>item_types</code> array contains item types that are different from <code>organic</code>, the results will be ordered by the first item type in the array'
          nullable: true
        tag:
          type: string
          description: <em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response
          nullable: true
      example:
        - target: amazon.com
          language_name: English
          location_code: 2840
          filters:
            - 
              - metrics.organic.pos_1
              - <>
              - 0
            - or
            - 
              - metrics.organic.pos_2_3
              - <>
              - 0
          limit: 3
    DataforseoLabsGoogleRelevantPagesLiveItem:
      type: object
      properties:
        se_type:
          type: string
          description: <em>search engine type</em>
          nullable: true
        page_address:
          type: string
          description: <em>absolute URL of the relevant page</em>
          nullable: true
        metrics:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/DataforseoLabsMetricsInfo'
          description: <em>rankings and traffic metrics for the relevant page</em>
          nullable: true
    DataforseoLabsGoogleRelevantPagesLiveResultInfo:
      type: object
      properties:
        se_type:
          type: string
          description: <em>search engine type</em>
          nullable: true
        target:
          type: string
          description: <em>target domain in a POST array</em>
          nullable: true
        location_code:
          type: integer
          description: '<em>location code in a POST array</em><br>if there is no data, then the value is <code>null</code>'
          nullable: true
        language_code:
          type: string
          description: '<em>language code in a POST array</em><br>if there is no data, then the value is <code>null</code>'
          nullable: true
        total_count:
          type: integer
          description: <em>total amount of results in our database relevant to your request</em>
          format: int64
          nullable: true
        items_count:
          type: integer
          description: <em>the number of results returned in the <code>items</code> array</em>
          format: int64
          nullable: true
        items:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/DataforseoLabsGoogleRelevantPagesLiveItem'
            nullable: true
          description: <em>relevant pages and related data</em>
          nullable: true
    DataforseoLabsGoogleRelevantPagesLiveTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/DataforseoLabsGoogleRelevantPagesLiveResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    DataforseoLabsGoogleRelevantPagesLiveResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/DataforseoLabsGoogleRelevantPagesLiveTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    DataforseoLabsGoogleDomainRankOverviewLiveRequestInfo:
      type: object
      properties:
        target:
          type: string
          description: <em>domain</em><br><strong>required field</strong><br>the domain name of the target website<br>the domain should be specified without <code>https://</code> and <code>www.</code>
        location_name:
          type: string
          description: '<em>full name of the location</em><br>optional field<br>if you use this field, you don''t need to specify <code>location_code</code><br>you can receive the list of available locations with their <code>location_name</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>ignore this field to get the results for all available locations<br>example:<br><code class="long-string">United Kingdom</code>'
          nullable: true
        location_code:
          type: integer
          description: '<em>location code</em><br>optional field<br>if you use this field, you don''t need to specify <code>location_name</code><br>you can receive the list of available locations with their <code>location_code</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>ignore this field to get the results for all available locations<br>example:<br><code class="long-string">2840</code>'
          nullable: true
        language_name:
          type: string
          description: '<em>full name of the language</em><br>optional field<br>if you use this field, you don''t need to specify <code>language_code</code><br>you can receive the list of available languages with their <code>language_name</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>ignore this field to get the results for all available languages<br>example:<br><code class="long-string">English</code>'
          nullable: true
        language_code:
          type: string
          description: '<em>language code</em><br>optional field<br>if you use this field, you don''t need to specify <code>language_name</code><br>you can receive the list of available languages with their <code>language_code</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>ignore this field to get the results for all available languages<br>example:<br><code class="long-string">en</code>'
          nullable: true
        ignore_synonyms:
          type: boolean
          description: '<em>ignore highly similar keywords</em><br>optional field<br>if set to_<code class="prettyprint">true</code>, all highly similar keywords will be excluded from the ranking and traffic calculations, the results will be based on data for main keywords from groups of synonyms<br>default value: <code>false</code>n'
          nullable: true
        limit:
          type: integer
          description: '<em>the maximum number of returned results for domain</em><br>optional field<br>default value: <code>100</code><br>maximum value: <code>1000</code>'
          nullable: true
        offset:
          type: integer
          description: '<em>offset in the results array of returned items</em><br>optional field<br>default value: <code>0</code><br>if you specify the <code>10</code> value, the first ten <code>items</code> in the results array will be omitted and the data will be provided for the successive items'
          nullable: true
        tag:
          type: string
          description: <em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response
          nullable: true
      example:
        - target: dataforseo.com
          language_name: English
          location_code: 2840
    DataforseoLabsGoogleDomainRankOverviewLiveItem:
      type: object
      properties:
        se_type:
          type: string
          description: <em>search engine type</em>
          nullable: true
        location_code:
          type: integer
          description: <em>location code in a POST array</em>
          nullable: true
        language_code:
          type: string
          description: <em>language code in a POST array</em>
          nullable: true
        metrics:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/DataforseoLabsMetricsInfo'
          description: <em>ranking data relevant to the specified domain</em>
          nullable: true
    DataforseoLabsGoogleDomainRankOverviewLiveResultInfo:
      type: object
      properties:
        se_type:
          type: string
          description: <em>search engine type</em>
          nullable: true
        target:
          type: string
          description: <em>target domain in a POST array</em>
          nullable: true
        location_code:
          type: integer
          description: <em>location code in a POST array</em>
          nullable: true
        language_code:
          type: string
          description: <em>language code in a POST array</em>
          nullable: true
        total_count:
          type: integer
          description: <em>total amount of results in our database relevant to your request</em>
          format: int64
          nullable: true
        items_count:
          type: integer
          description: <em>the number of results returned in the <code>items</code> array</em>
          format: int64
          nullable: true
        items:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/DataforseoLabsGoogleDomainRankOverviewLiveItem'
            nullable: true
          description: <em>contains ranking and traffic data</em>
          nullable: true
    DataforseoLabsGoogleDomainRankOverviewLiveTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/DataforseoLabsGoogleDomainRankOverviewLiveResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    DataforseoLabsGoogleDomainRankOverviewLiveResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/DataforseoLabsGoogleDomainRankOverviewLiveTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    DataforseoLabsGoogleHistoricalSerpsLiveRequestInfo:
      type: object
      properties:
        keyword:
          type: string
          description: '<em>keyword</em><br><strong>required field</strong><br>you can specify <strong>up to 700 characters</strong> in the <code>keyword</code> field;<br>all %## will be decoded (plus character ‘+’ will be decoded to a space character);<br>if you need to use the “%” character for your <code>keyword</code>, please specify it as “%25”;<br>if you need to use the “+” character for your <code>keyword</code>, please specify it as “%2B”'
        date_from:
          type: string
          description: '<em>starting date of the time range</em><br>optional field<br>if you don''t specify this field, the API will return all SERPs collected for 365 days starting from the current <code>datetime</code> value;<br>minimal possible value: 365 days from the current <code>datetime</code> value;<br>date format: <code>"yyyy-mm-dd"</code>'
          nullable: true
        date_to:
          type: string
          description: '<em>ending date of the time range</em><br>optional field<br>if you don''t specify this field, the today''s date will be used by default;<br>date format: <code>"yyyy-mm-dd"</code>;<br>example:<br><code>"2021-09-01"</code>'
          nullable: true
        location_name:
          type: string
          description: <em>full name of the location</em><br><strong>required field if you don't specify</strong> <code>location_code</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_name</code> by making a separate request to <code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class="long-string">United Kingdom</code>
        location_code:
          type: integer
          description: <em>unique location identifier</em><br><strong>required field if you don't specify</strong> <code>location_name</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_code</code> by making a separate request to <code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class="long-string">2840</code>
        language_name:
          type: string
          description: <em>full name of the language</em><br><strong>required field if you don't specify</strong> <code>language_code</code><br><strong>Note:</strong> it is required to specify either <code>language_name</code> or <code>language_code</code><br>you can receive the list of available languages with their <code>language_name</code> parameters by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class="long-string">English</code>
        language_code:
          type: string
          description: <em>unique language identifier</em><br><strong>required field if you don't specify</strong> <code>language_name</code><br><strong>Note:</strong> it is required to specify either <code>language_name</code> or <code>language_code</code><br>you can receive the list of available languages with their <code>language_code</code> parameters by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class="long-string">en</code>
          nullable: true
        tag:
          type: string
          description: <em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response
          nullable: true
      example:
        - keyword: albert einstein
          datetime_from: '2026-09-10 11:12:35'
          datetime_to: '2026-09-20 11:12:35'
          location_code: 2840
          language_code: en
          limit: 10
    DataLabsAnswerBoxSerpElementItem:
      type: object
      allOf:
        - type: object
          oneOf:
            - $ref: '#/components/schemas/BaseDataforseoLabsApiElementItem'
          nullable: true
        - type: object
          properties:
            text:
              type: array
              items:
                type: string
                nullable: true
              description: '<em>text</em><br>            if there is none, equals <code>null</code>'
              nullable: true
            links:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/LinkElement'
                nullable: true
              description: '<em>sitelinks</em><br>            the links shown below some of Google''s search results<br>            if there are none, equals <code>null</code>'
              nullable: true
    DataforseoLabsCarouselElement:
      type: object
      properties:
        type:
          type: string
          description: type of element
          nullable: true
        title:
          type: string
          description: <em>title of the result in SERP</em>
          nullable: true
        sub_title:
          type: string
          description: <em>subtitle of the item</em>
          nullable: true
    DataLabsCarouselSerpElementItem:
      type: object
      allOf:
        - type: object
          oneOf:
            - $ref: '#/components/schemas/BaseDataforseoLabsApiElementItem'
          nullable: true
        - type: object
          properties:
            title:
              type: string
              description: <em>title of the result in SERP</em>
              nullable: true
            items:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/DataforseoLabsCarouselElement'
                nullable: true
              description: <em>historical SERPs and related data found in the database</em>
              nullable: true
    DataLabsMultiCarouselSerpElementItem:
      type: object
      allOf:
        - type: object
          oneOf:
            - $ref: '#/components/schemas/BaseDataforseoLabsApiElementItem'
          nullable: true
        - type: object
          properties:
            items:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/MultiCarouselElement'
                nullable: true
              description: <em>historical SERPs and related data found in the database</em>
              nullable: true
    DataLabsFeaturedSnippetSerpElementItem:
      type: object
      allOf:
        - type: object
          oneOf:
            - $ref: '#/components/schemas/BaseDataforseoLabsApiElementItem'
          nullable: true
        - type: object
          properties:
            domain:
              type: string
              description: <em>domain in SERP</em>
              nullable: true
            title:
              type: string
              description: <em>title of the result in SERP</em>
              nullable: true
            featured_title:
              type: string
              description: <em>title of a given element</em>
              nullable: true
            description:
              type: string
              description: <em>description of the results element in SERP</em>
              nullable: true
            url:
              type: string
              description: <em> relevant URL in SERP</em>
              nullable: true
            table:
              type: object
              oneOf:
                - $ref: '#/components/schemas/Table'
              description: <em>table element</em>
              nullable: true
            main_domain:
              type: string
              description: <em>primary domain name in SERP</em>
              nullable: true
            relative_url:
              type: string
              description: <em>URL in SERP that does not specify the HTTPs protocol and domain name</em>
              nullable: true
            etv:
              type: number
              description: <em>estimated traffic volume</em><br>            estimated organic monthly traffic a featured URL delivers to the domain<br>            calculated as the product of CTR (click-through-rate) and search volume values of the returned keyword<br>            learn more about how the metric is calculated in <a href="https://dataforseo.com/help-center/how-is-etv-calculated" rel="noopener noreferrer" target="_blank">this help center article</a>
              nullable: true
            estimated_paid_traffic_cost:
              type: number
              description: <em>estimated cost of converting organic search traffic into paid</em><br>            represents the estimated monthly cost of running ads for the returned keyword<br>            the metric is calculated as the product of organic <code>etv</code> and paid <code>cpc</code> values and indicates the cost of driving the estimated volume of monthly organic traffic through PPC advertising in Google Search<br>            learn more about how the metric is calculated in <a href="https://dataforseo.com/help-center/how-is-traffic-cost-calculated" rel="noopener noreferrer" target="_blank">this help center article</a>
              nullable: true
            clickstream_etv:
              type: number
              format: double
              nullable: true
            rank_changes:
              type: object
              oneOf:
                - $ref: '#/components/schemas/RankChanges'
              properties:
                previous_rank_absolute:
                  type: number
                  description: "previous absolute rank in SERP\nindicates previous rank of the element in Google SERP;\nif this element is new, the value will be null"
                  nullable: true
                is_new:
                  type: boolean
                  description: "element was previously present in SERP\nif the value is true, previously collected SERP didn’t contain this element"
                is_up:
                  type: boolean
                  description: "rank of this element went up\nif the value is true, position of the element in SERP is higher compared to the previous check"
                is_down:
                  type: boolean
                  description: "rank of this element went down\nif the value is true, position of the element in SERP is lower compared to the previous check"
              description: <em>changes in rankings</em><br>            ranking changes of the SERP element compared to the preceding month;<br>            <strong>Note:</strong> the changes are calculated even if the preceding month is not included in a POST request
              nullable: true
            backlinks_info:
              type: object
              oneOf:
                - $ref: '#/components/schemas/BacklinksInfo'
              description: <em>backlinks information for the ranked website</em>
              nullable: true
            rank_info:
              type: object
              oneOf:
                - $ref: '#/components/schemas/RankInfo'
              description: <em>page and domain rank information</em>
              nullable: true
    DataLabsGoogleFlightsSerpElementItem:
      type: object
      allOf:
        - type: object
          oneOf:
            - $ref: '#/components/schemas/BaseDataforseoLabsApiElementItem'
          nullable: true
        - type: object
          properties:
            title:
              type: string
              description: <em>title of the result in SERP</em>
              nullable: true
            url:
              type: string
              description: <em> relevant URL in SERP</em>
              nullable: true
            items:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/GoogleFlightsElement'
                nullable: true
              description: <em>historical SERPs and related data found in the database</em>
              nullable: true
    DataLabsGoogleReviewsSerpElementItem:
      type: object
      allOf:
        - type: object
          oneOf:
            - $ref: '#/components/schemas/BaseDataforseoLabsApiElementItem'
          nullable: true
        - type: object
          properties:
            reviews_count:
              type: integer
              description: <i>the number of reviews</i>
              format: int64
              nullable: true
            rating:
              type: object
              oneOf:
                - $ref: '#/components/schemas/RatingInfo'
              description: <em>the item's rating </em><br>            the popularity rate based on reviews and displayed in SERP
              nullable: true
            place_id:
              type: string
              description: <em>the identifier of a place</em>
              nullable: true
            feature:
              type: string
              description: <i>the additional feature of the review</i>
              nullable: true
            cid:
              type: string
              description: <em>google-defined client id</em>
              nullable: true
    DataLabsGooglePostsSerpElementItem:
      type: object
      allOf:
        - type: object
          oneOf:
            - $ref: '#/components/schemas/BaseDataforseoLabsApiElementItem'
          nullable: true
        - type: object
          properties:
            posts_id:
              type: string
              description: the identifier of the google_posts feature
              nullable: true
            feature:
              type: string
              description: the additional feature of the review
              nullable: true
            cid:
              type: string
              description: google-defined client id
              nullable: true
      deprecated: true
    DataLabsImagesSerpElementItem:
      type: object
      allOf:
        - type: object
          oneOf:
            - $ref: '#/components/schemas/BaseDataforseoLabsApiElementItem'
          nullable: true
        - type: object
          properties:
            title:
              type: string
              description: <em>title of the result in SERP</em>
              nullable: true
            url:
              type: string
              description: <em> relevant URL in SERP</em>
              nullable: true
            items:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AiModeImagesElementInfo'
                nullable: true
              description: <em>historical SERPs and related data found in the database</em>
              nullable: true
            related_image_searches:
              type: object
              oneOf:
                - $ref: '#/components/schemas/RelatedImageSearchesElement'
              description: '<em>contains keywords and images related to the specified search term</em><br>            if there are none, equals <code>null</code>'
              nullable: true
              deprecated: true
    DataLabsJobsSerpElementItem:
      type: object
      allOf:
        - type: object
          oneOf:
            - $ref: '#/components/schemas/BaseDataforseoLabsApiElementItem'
          nullable: true
        - type: object
          properties:
            title:
              type: string
              description: <em>title of the result in SERP</em>
              nullable: true
            url:
              type: string
              description: <em> relevant URL in SERP</em>
              nullable: true
            items:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/JobsElement'
                nullable: true
              description: <em>historical SERPs and related data found in the database</em>
              nullable: true
    DataforseoLabsKnowledgeGraphImagesItemElementItem:
      type: object
      allOf:
        - type: object
          oneOf:
            - $ref: '#/components/schemas/BaseDataforseoLabsKnowledgeGraphElementItem'
          nullable: true
        - type: object
          properties:
            link:
              type: object
              oneOf:
                - $ref: '#/components/schemas/LinkElement'
              description: <em>link of the element</em>
              nullable: true
            items:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/KnowledgeGraphImagesElement'
                nullable: true
              description: <em>historical SERPs and related data found in the database</em>
              nullable: true
    DataforseoLabsKnowledgeGraphCarouselItemElementItem:
      type: object
      allOf:
        - type: object
          oneOf:
            - $ref: '#/components/schemas/BaseDataforseoLabsKnowledgeGraphElementItem'
          nullable: true
        - type: object
          properties:
            title:
              type: string
              description: <em>title of the result in SERP</em>
              nullable: true
            data_attrid:
              type: string
              description: <em>google defined data attribute ID</em><br>            example:<br>            <code>action:listen_artist</code>
              nullable: true
            link:
              type: object
              oneOf:
                - $ref: '#/components/schemas/LinkElement'
              description: <em>link of the element</em>
              nullable: true
            items:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/KnowledgeGraphListElement'
                nullable: true
              description: <em>historical SERPs and related data found in the database</em>
              nullable: true
    KnowledgeGraphLinkElementInfo:
      type: object
      properties:
        type:
          type: string
          description: type of element
          nullable: true
        title:
          type: string
          description: <em>title of the result in SERP</em>
          nullable: true
        url:
          type: string
          description: <em> relevant URL in SERP</em>
          nullable: true
        domain:
          type: string
          description: <em>domain in SERP</em>
          nullable: true
        snippet:
          type: string
          description: <em>text alongside the link title</em>
          nullable: true
        xpath:
          type: string
          description: <em>the <a href="https://en.wikipedia.org/wiki/XPath">XPath</a> of the element</em>
          nullable: true
    DataforseoLabsKnowledgeGraphDescriptionItemElementItem:
      type: object
      allOf:
        - type: object
          oneOf:
            - $ref: '#/components/schemas/BaseDataforseoLabsKnowledgeGraphElementItem'
          nullable: true
        - type: object
          properties:
            text:
              type: string
              description: <em>description content</em>
              nullable: true
            links:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/KnowledgeGraphLinkElementInfo'
                nullable: true
              description: '<em>sitelinks</em><br>            the links shown below some of Google''s search results<br>            if there are none, equals <code>null</code>'
              nullable: true
    DataforseoLabsKnowledgeGraphListItemElementItem:
      type: object
      allOf:
        - type: object
          oneOf:
            - $ref: '#/components/schemas/BaseDataforseoLabsKnowledgeGraphElementItem'
          nullable: true
        - type: object
          properties:
            title:
              type: string
              description: <em>title of the result in SERP</em>
              nullable: true
            data_attrid:
              type: string
              description: <em>google defined data attribute ID</em><br>            example:<br>            <code>action:listen_artist</code>
              nullable: true
            link:
              type: object
              oneOf:
                - $ref: '#/components/schemas/LinkElement'
              description: <em>link of the element</em>
              nullable: true
            items:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/KnowledgeGraphListElement'
                nullable: true
              description: <em>historical SERPs and related data found in the database</em>
              nullable: true
    DataforseoLabsKnowledgeGraphPartItemElementItem:
      type: object
      allOf:
        - type: object
          oneOf:
            - $ref: '#/components/schemas/BaseDataforseoLabsKnowledgeGraphElementItem'
          nullable: true
        - type: object
          properties:
            title:
              type: string
              description: <em>title of the result in SERP</em>
              nullable: true
            data_attrid:
              type: string
              description: <em>google defined data attribute ID</em><br>            example:<br>            <code>action:listen_artist</code>
              nullable: true
            text:
              type: string
              description: <em>description content</em>
              nullable: true
            links:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/LinkElement'
                nullable: true
              description: '<em>sitelinks</em><br>            the links shown below some of Google''s search results<br>            if there are none, equals <code>null</code>'
              nullable: true
    DataforseoLabsKnowledgeGraphExpandedItemElementItem:
      type: object
      allOf:
        - type: object
          oneOf:
            - $ref: '#/components/schemas/BaseDataforseoLabsKnowledgeGraphElementItem'
          nullable: true
        - type: object
          properties:
            title:
              type: string
              description: <em>title of the result in SERP</em>
              nullable: true
            data_attrid:
              type: string
              description: <em>google defined data attribute ID</em><br>            example:<br>            <code>action:listen_artist</code>
              nullable: true
            expanded_element:
              type: object
              description: <em>link of the element</em>
              nullable: true
    DataforseoLabsKnowledgeGraphRowItemElementItem:
      type: object
      allOf:
        - type: object
          oneOf:
            - $ref: '#/components/schemas/BaseDataforseoLabsKnowledgeGraphElementItem'
          nullable: true
        - type: object
          properties:
            title:
              type: string
              description: <em>title of the result in SERP</em>
              nullable: true
            data_attrid:
              type: string
              description: <em>google defined data attribute ID</em><br>            example:<br>            <code>action:listen_artist</code>
              nullable: true
            text:
              type: string
              description: <em>description content</em>
              nullable: true
            links:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/LinkElement'
                nullable: true
              description: '<em>sitelinks</em><br>            the links shown below some of Google''s search results<br>            if there are none, equals <code>null</code>'
              nullable: true
    DataforseoLabsKnowledgeGraphShoppingItemElementItem:
      type: object
      allOf:
        - type: object
          oneOf:
            - $ref: '#/components/schemas/BaseDataforseoLabsKnowledgeGraphElementItem'
          nullable: true
        - type: object
          properties:
            title:
              type: string
              description: <em>title of the result in SERP</em>
              nullable: true
            data_attrid:
              type: string
              description: <em>google defined data attribute ID</em><br>            example:<br>            <code>action:listen_artist</code>
              nullable: true
            items:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/KnowledgeGraphShoppingElement'
                nullable: true
              description: <em>historical SERPs and related data found in the database</em>
              nullable: true
    DataLabsKnowledgeGraphSerpElementItem:
      type: object
      allOf:
        - type: object
          oneOf:
            - $ref: '#/components/schemas/BaseDataforseoLabsApiElementItem'
          nullable: true
        - type: object
          properties:
            title:
              type: string
              description: <em>title of the result in SERP</em>
              nullable: true
            sub_title:
              type: string
              description: <em>subtitle of the item</em>
              nullable: true
            description:
              type: string
              description: <em>description of the results element in SERP</em>
              nullable: true
            card_id:
              type: string
              description: <em>card id</em>
              nullable: true
            url:
              type: string
              description: <em> relevant URL in SERP</em>
              nullable: true
            image_url:
              type: string
              description: <em>URL of the image from knowledge graph</em>
              nullable: true
            logo_url:
              type: string
              description: <em>URL of the logo from knowledge graph</em>
              nullable: true
            cid:
              type: string
              description: <em>google-defined client id</em>
              nullable: true
            items:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/BaseDataforseoLabsKnowledgeGraphElementItem'
                nullable: true
              description: <em>historical SERPs and related data found in the database</em>
              nullable: true
    DataLabsHotelsPackSerpElementItem:
      type: object
      allOf:
        - type: object
          oneOf:
            - $ref: '#/components/schemas/BaseDataforseoLabsApiElementItem'
          nullable: true
        - type: object
          properties:
            title:
              type: string
              description: <em>title of the result in SERP</em>
              nullable: true
            date_from:
              type: string
              description: <em>starting date of stay</em><br>            in the format “year-month-date”<br>            example:<br>            2019-11-15
              nullable: true
            date_to:
              type: string
              description: <em>ending date of stay</em><br>            in the format “year-month-date”<br>            example:<br>            2019-11-17
              nullable: true
            items:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/HotelsPackElement'
                nullable: true
              description: <em>historical SERPs and related data found in the database</em>
              nullable: true
    DataLabsMapSerpElementItem:
      type: object
      allOf:
        - type: object
          oneOf:
            - $ref: '#/components/schemas/BaseDataforseoLabsApiElementItem'
          nullable: true
        - type: object
          properties:
            title:
              type: string
              description: <em>title of the result in SERP</em>
              nullable: true
            url:
              type: string
              description: <em> relevant URL in SERP</em>
              nullable: true
    PodcastsSerpElementItem:
      type: object
      allOf:
        - type: object
          oneOf:
            - $ref: '#/components/schemas/BaseSerpApiElementItem'
          nullable: true
        - type: object
          properties:
            rank_group:
              type: integer
              description: "group rank in SERP\nposition within a group of elements with identical type values;\npositions of elements with different type values are omitted from rank_group;\nalways equals 0 for desktop"
              nullable: true
            rank_absolute:
              type: integer
              description: "absolute rank in SERP\nabsolute position among all the elements in SERP\nalways equals 0 for desktop"
              nullable: true
            items:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/PodcastsElement'
                nullable: true
              description: contains arrays of elements available in the list
              nullable: true
      deprecated: true
    DataLabsPeopleAlsoAskSerpElementItem:
      type: object
      allOf:
        - type: object
          oneOf:
            - $ref: '#/components/schemas/BaseDataforseoLabsApiElementItem'
          nullable: true
        - type: object
          properties:
            items:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/PeopleAlsoAskElement'
                nullable: true
              description: <em>historical SERPs and related data found in the database</em>
              nullable: true
    DataLabsRelatedSearchesSerpElementItem:
      type: object
      allOf:
        - type: object
          oneOf:
            - $ref: '#/components/schemas/BaseDataforseoLabsApiElementItem'
          nullable: true
        - type: object
          properties:
            items:
              type: array
              items:
                type: string
                nullable: true
              description: <em>historical SERPs and related data found in the database</em>
              nullable: true
    DataLabsPeopleAlsoSearchSerpElementItem:
      type: object
      allOf:
        - type: object
          oneOf:
            - $ref: '#/components/schemas/BaseDataforseoLabsApiElementItem'
          nullable: true
        - type: object
          properties:
            title:
              type: string
              description: <em>title of the result in SERP</em>
              nullable: true
            items:
              type: array
              items:
                type: string
                nullable: true
              description: <em>historical SERPs and related data found in the database</em>
              nullable: true
    DataLabsShoppingSerpElementItem:
      type: object
      allOf:
        - type: object
          oneOf:
            - $ref: '#/components/schemas/BaseDataforseoLabsApiElementItem'
          nullable: true
        - type: object
          properties:
            title:
              type: string
              description: <em>title of the result in SERP</em>
              nullable: true
            items:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/ShoppingElement'
                nullable: true
              description: <em>historical SERPs and related data found in the database</em>
              nullable: true
    DataLabsTopStoriesSerpElementItem:
      type: object
      allOf:
        - type: object
          oneOf:
            - $ref: '#/components/schemas/BaseDataforseoLabsApiElementItem'
          nullable: true
        - type: object
          properties:
            title:
              type: string
              description: <em>title of the result in SERP</em>
              nullable: true
            items:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/TopStoriesElement'
                nullable: true
              description: <em>historical SERPs and related data found in the database</em>
              nullable: true
    DataLabsTwitterSerpElementItem:
      type: object
      allOf:
        - type: object
          oneOf:
            - $ref: '#/components/schemas/BaseDataforseoLabsApiElementItem'
          nullable: true
        - type: object
          properties:
            title:
              type: string
              description: <em>title of the result in SERP</em>
              nullable: true
            url:
              type: string
              description: <em> relevant URL in SERP</em>
              nullable: true
            items:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/TwitterElement'
                nullable: true
              description: <em>historical SERPs and related data found in the database</em>
              nullable: true
    DataLabsVideoSerpElementItem:
      type: object
      allOf:
        - type: object
          oneOf:
            - $ref: '#/components/schemas/BaseDataforseoLabsApiElementItem'
          nullable: true
        - type: object
          properties:
            items:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/VideoElement'
                nullable: true
              description: <em>historical SERPs and related data found in the database</em>
              nullable: true
    DataLabsEventsSerpElementItem:
      type: object
      allOf:
        - type: object
          oneOf:
            - $ref: '#/components/schemas/BaseDataforseoLabsApiElementItem'
          nullable: true
        - type: object
          properties:
            title:
              type: string
              description: <em>title of the result in SERP</em>
              nullable: true
            url:
              type: string
              description: <em> relevant URL in SERP</em>
              nullable: true
            items:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/EventsElement'
                nullable: true
              description: <em>historical SERPs and related data found in the database</em>
              nullable: true
    DataLabsRecipesSerpElementItem:
      type: object
      allOf:
        - type: object
          oneOf:
            - $ref: '#/components/schemas/BaseDataforseoLabsApiElementItem'
          nullable: true
        - type: object
          properties:
            items:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/RecipesElement'
                nullable: true
              description: <em>historical SERPs and related data found in the database</em>
              nullable: true
    DataLabsTopSightsSerpElementItem:
      type: object
      allOf:
        - type: object
          oneOf:
            - $ref: '#/components/schemas/BaseDataforseoLabsApiElementItem'
          nullable: true
        - type: object
          properties:
            title:
              type: string
              description: <em>title of the result in SERP</em>
              nullable: true
            items:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/TopSightsElement'
                nullable: true
              description: <em>historical SERPs and related data found in the database</em>
              nullable: true
    DataLabsScholarlyArticlesSerpElementItem:
      type: object
      allOf:
        - type: object
          oneOf:
            - $ref: '#/components/schemas/BaseDataforseoLabsApiElementItem'
          nullable: true
        - type: object
          properties:
            title:
              type: string
              description: <em>title of the result in SERP</em>
              nullable: true
            url:
              type: string
              description: <em> relevant URL in SERP</em>
              nullable: true
            items:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/ScholarlyArticlesElement'
                nullable: true
              description: <em>historical SERPs and related data found in the database</em>
              nullable: true
    DataLabsPopularProductsSerpElementItem:
      type: object
      allOf:
        - type: object
          oneOf:
            - $ref: '#/components/schemas/BaseDataforseoLabsApiElementItem'
          nullable: true
        - type: object
          properties:
            items:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/PopularProductsElement'
                nullable: true
              description: <em>historical SERPs and related data found in the database</em>
              nullable: true
    DataLabsQuestionsAndAnswersSerpElementItem:
      type: object
      allOf:
        - type: object
          oneOf:
            - $ref: '#/components/schemas/BaseDataforseoLabsApiElementItem'
          nullable: true
        - type: object
          properties:
            items:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/QuestionsAndAnswersElement'
                nullable: true
              description: <em>historical SERPs and related data found in the database</em>
              nullable: true
    DataLabsFindResultsOnSerpElementItem:
      type: object
      allOf:
        - type: object
          oneOf:
            - $ref: '#/components/schemas/BaseDataforseoLabsApiElementItem'
          nullable: true
        - type: object
          properties:
            items:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/FindResultsOnElement'
                nullable: true
              description: <em>historical SERPs and related data found in the database</em>
              nullable: true
    DataLabsStocksBoxSerpElementItem:
      type: object
      allOf:
        - type: object
          oneOf:
            - $ref: '#/components/schemas/BaseDataforseoLabsApiElementItem'
          nullable: true
        - type: object
          properties:
            title:
              type: string
              description: <em>title of the result in SERP</em>
              nullable: true
            source:
              type: string
              description: <em>source of additional information about the result</em>
              nullable: true
            snippet:
              type: string
              description: <em>text alongside the link title</em>
              nullable: true
            price:
              type: object
              oneOf:
                - $ref: '#/components/schemas/PriceInfo'
              description: <em>price of booking a place for the specified dates of stay</em>
              nullable: true
            url:
              type: string
              description: <em> relevant URL in SERP</em>
              nullable: true
            domain:
              type: string
              description: <em>domain in SERP</em>
              nullable: true
            table:
              type: object
              oneOf:
                - $ref: '#/components/schemas/Table'
              description: <em>table element</em>
              nullable: true
            graph:
              type: object
              oneOf:
                - $ref: '#/components/schemas/Graph'
              description: <em>contains data provided in the graph of the element</em>
              nullable: true
    DataLabsCommercialUnitsSerpElementItem:
      type: object
      allOf:
        - type: object
          oneOf:
            - $ref: '#/components/schemas/BaseDataforseoLabsApiElementItem'
          nullable: true
        - type: object
          properties:
            title:
              type: string
              description: <em>title of the result in SERP</em>
              nullable: true
            items:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/CommercialUnitsElement'
                nullable: true
              description: <em>historical SERPs and related data found in the database</em>
              nullable: true
    DataLabsLocalServicesSerpElementItem:
      type: object
      allOf:
        - type: object
          oneOf:
            - $ref: '#/components/schemas/BaseDataforseoLabsApiElementItem'
          nullable: true
        - type: object
          properties:
            title:
              type: string
              description: <em>title of the result in SERP</em>
              nullable: true
            url:
              type: string
              description: <em> relevant URL in SERP</em>
              nullable: true
            domain:
              type: string
              description: <em>domain in SERP</em>
              nullable: true
            items:
              type: object
              description: <em>historical SERPs and related data found in the database</em>
              nullable: true
    DataLabsGoogleHotelsSerpElementItem:
      type: object
      allOf:
        - type: object
          oneOf:
            - $ref: '#/components/schemas/BaseDataforseoLabsApiElementItem'
          nullable: true
        - type: object
          properties:
            hotel_identifier:
              type: string
              description: '<em>unique hotel identifier</em><br>            unique hotel identifier assigned by Google;<br>            example: <code>"CgoIjaeSlI6CnNpVEAE"</code>'
              nullable: true
            url:
              type: string
              description: <em> relevant URL in SERP</em>
              nullable: true
    DataLabsMathSolverSerpElementItem:
      type: object
      allOf:
        - type: object
          oneOf:
            - $ref: '#/components/schemas/BaseDataforseoLabsApiElementItem'
          nullable: true
        - type: object
          properties:
            title:
              type: string
              description: <em>title of the result in SERP</em>
              nullable: true
            result:
              type: string
              description: <em>solution to the equation</em><br>            solution to the mathematical equation specified in the <code>keyword</code> field when setting a task
              nullable: true
            items:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/MathSolverElement'
                nullable: true
              description: <em>historical SERPs and related data found in the database</em>
              nullable: true
            links:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/LinkElement'
                nullable: true
              description: '<em>sitelinks</em><br>            the links shown below some of Google''s search results<br>            if there are none, equals <code>null</code>'
              nullable: true
    DataforseoLabsGoogleHistoricalSerpsLiveItem:
      type: object
      properties:
        se_type:
          type: string
          description: <em>search engine type in a POST array</em>
          nullable: true
        keyword:
          type: string
          description: <em>keyword received in a POST array</em><br>            <strong>the keyword is returned with decoded %## (plus character ‘+’ will be decoded to a space character)</strong>
          nullable: true
        type:
          type: string
          description: type of element
          nullable: true
        se_domain:
          type: string
          description: <em>search engine domain in a POST array</em>
          nullable: true
        location_code:
          type: integer
          description: <em>location code in a POST array</em>
          nullable: true
        language_code:
          type: string
          description: <em>language code in a POST array</em>
          nullable: true
        check_url:
          type: string
          description: <em>direct URL to search engine results</em><br>            you can use it to make sure that we provided accurate results
          nullable: true
        datetime:
          type: string
          description: '<em>date and time when the result was received</em><br>            in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”<br>            example:<br>            <code class="long-string">2019-11-15 12:57:46 +00:00</code>'
          nullable: true
        spell:
          type: object
          oneOf:
            - $ref: '#/components/schemas/SpellInfo'
          description: '<em>autocorrection of the search engine</em><br>            if the search engine provided results for a keyword that was corrected, we will specify the keyword corrected by the search engine and the type of autocorrection'
          nullable: true
        item_types:
          type: array
          items:
            type: string
            nullable: true
          description: '<em>types of search results in SERP</em><br>            contains types of search results (<code>items</code>) found in SERP.<br>            possible item types:<br>            <span><a href="#answer_box"><code>answer_box</code></a>, <a href="#carousel"><code>carousel</code></a>, <a href="#multi_carousel"><code>multi_carousel</code></a>, <a href="#featured_snippet"><code>featured_snippet</code></a>, <a href="#google_flights"><code>google_flights</code></a>, <a href="#google_reviews"><code>google_reviews</code></a>, <a href="#google_posts"><code>google_posts</code></a>, <a href="#images"><code>images</code></a>, <a href="#jobs"><code>jobs</code></a>, <a href="#knowledge_graph"><code>knowledge_graph</code></a>, <a href="#local_pack"><code>local_pack</code></a>, <a href="#hotels_pack"><code>hotels_pack</code></a>, <a href="#map"><code>map</code></a>, <a href="#organic"><code>organic</code></a>, <a href="#paid"><code>paid</code></a>, <a href="#people_also_ask"><code>people_also_ask</code></a>, <a href="#related_searches"><code>related_searches</code></a>, <a href="#people_also_search"><code>people_also_search</code></a>, <a href="#shopping"><code>shopping</code></a>, <a href="#top_stories"><code>top_stories</code></a>, <a href="#twitter"><code>twitter</code></a>, <a href="#video"><code>video</code></a>, <a href="#events"><code>events</code></a>, <a href="#mention_carousel"><code>mention_carousel</code></a>, <a href="#recipes"><code>recipes</code></a>, <a href="#top_sights"><code>top_sights</code></a>, <a href="#scholarly_articles"><code>scholarly_articles</code></a>, <a href="#popular_products"><code>popular_products</code></a>, <a href="#podcasts"><code>podcasts</code></a>, <a href="#questions_and_answers"><code>questions_and_answers</code></a>, <a href="#find_results_on"><code>find_results_on</code></a>, <a href="#stocks_box"><code>stocks_box</code></a>, <a href="#visual_stories"><code>visual_stories</code></a>, <a href="#commercial_units"><code>commercial_units</code></a>,  <a href="#local_services"><code>local_services</code></a>, <a href="#google_hotels"><code>google_hotels</code></a>, <a href="#math_solver"><code>math_solver</code></a>, <a href="#ai_overview"><code>ai_overview</code></a></span>'
          nullable: true
        se_results_count:
          type: integer
          description: <em> total number of results in SERP</em>
          format: int64
          nullable: true
        items_count:
          type: integer
          description: <em>the number of results returned in the <code>items</code> array</em>
          format: int64
          nullable: true
        items:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/BaseDataforseoLabsApiElementItem'
            nullable: true
          description: <em>historical SERPs and related data found in the database</em>
          nullable: true
    DataforseoLabsGoogleHistoricalSerpsLiveResultInfo:
      type: object
      properties:
        se_type:
          type: string
          description: <em>search engine type in a POST array</em>
          nullable: true
        keyword:
          type: string
          description: <em>keyword received in a POST array</em><br>            <strong>the keyword is returned with decoded %## (plus character ‘+’ will be decoded to a space character)</strong>
          nullable: true
        location_code:
          type: integer
          description: <em>location code in a POST array</em>
          nullable: true
        language_code:
          type: string
          description: <em>language code in a POST array</em>
          nullable: true
        total_count:
          type: integer
          description: <em>the total amount of results in our database relevant to your request</em>
          format: int64
          nullable: true
        items_count:
          type: integer
          description: <em>the number of results returned in the <code>items</code> array</em>
          format: int64
          nullable: true
        items:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/DataforseoLabsGoogleHistoricalSerpsLiveItem'
            nullable: true
          description: <em>historical SERPs and related data found in the database</em>
          nullable: true
    DataforseoLabsGoogleHistoricalSerpsLiveTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/DataforseoLabsGoogleHistoricalSerpsLiveResultInfo'
                nullable: true
              description: <em>array of results</em><br>            the array includes objects with SERPs for each month within the specified time frame
              nullable: true
    DataforseoLabsGoogleHistoricalSerpsLiveResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/DataforseoLabsGoogleHistoricalSerpsLiveTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    DataforseoLabsGoogleHistoricalRankOverviewLiveRequestInfo:
      type: object
      properties:
        target:
          type: string
          description: <em>domain</em><br><strong>required field</strong><br>the domain name of the target website<br>the domain should be specified without <code>https://</code> and <code>www.</code>
        location_name:
          type: string
          description: <em>full name of the location</em><br><strong>required field if you don't specify</strong> <code>location_code</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_name</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class="long-string">United Kingdom</code>
        location_code:
          type: integer
          description: <em>location code</em><br><strong>required field if you don't specify</strong> <code>location_name</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_code</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class="long-string">2840</code>
        language_name:
          type: string
          description: <em>full name of the language</em><br><strong>required field if you don't specify</strong> <code>language_code</code><br><strong>Note:</strong> it is required to specify either <code>language_name</code> or <code>language_code</code><br>you can receive the list of available locations with their <code>language_name</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class="long-string">English</code>
        language_code:
          type: string
          description: <em>language code</em><br><strong>required field if you don't specify</strong> <code>language_name</code><br><strong>Note:</strong> it is required to specify either <code>language_name</code> or <code>language_code</code><br>you can receive the list of available locations with their <code>language_code</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class="long-string">en</code>
          nullable: true
        date_from:
          type: string
          description: '<em>starting date of the time range</em><br>optional field<br>if you don''t specify this field, the data will be provided for the previous 6 months<br>minimal possible value: <code>2020-10-01</code><br>date format: <code>"yyyy-mm-dd"</code>'
          nullable: true
        date_to:
          type: string
          description: '<em>ending date of the time range</em><br>optional field<br>if you don''t specify this field, the today''s date will be used by default<br>date format: <code>"yyyy-mm-dd"</code><br>example:<br><code>"2021-04-01"</code>'
          nullable: true
        correlate:
          type: boolean
          description: '<em>correlate data with previously obtained datasets</em><br>optional field<br>default value: <code>true</code><br>if you use this parameter, our system will correlate data you obtain now with previously obtained datasets<br>this parameter is intended to mitigate any inconsistencies that may result from changes to our database<br>we recommend always setting <code>correlate</code> to <code>true</code>'
          nullable: true
        ignore_synonyms:
          type: boolean
          description: '<em>ignore highly similar keywords</em><br>optional field<br>if set to <code class="prettyprint">true</code>, only data based on core keywords will be returned, data for all highly similar keywords will be excluded;  <br>default value: <code>false</code>'
          nullable: true
        include_clickstream_data:
          type: boolean
          description: '<em>include or exclude data from clickstream-based metrics in the result</em><br>optional field<br>if the parameter is set to <code>true</code>, you will receive <code>clickstream_etv</code>, <code>clickstream_gender_distribution</code>, and <code>clickstream_age_distribution</code> fields with clickstream data in the response;<br>default value: <code>false</code>;<p><strong>Note:</strong> historical clickstream data is available from 2024/05 (May, 2024);<br><strong>with this parameter enabled, you will be charged double the price for the request;</strong><br>learn more about how clickstream-based metrics are calculated in this <a href="https://dataforseo.com/help-center/what-are-clickstream-based-metrics-and-how-do-we-calculate-them" rel="noopener noreferrer" target="_blank">help center article</a>'
          nullable: true
        tag:
          type: string
          description: <em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response
          nullable: true
      example:
        - target: dataforseo.com
          location_code: 2840
          language_code: en
          date_from: '2021-01-01'
          date_to: '2021-03-29'
    DataforseoLabsGoogleHistoricalRankOverviewLiveItem:
      type: object
      properties:
        se_type:
          type: string
          description: <em>search engine type</em>
          nullable: true
        year:
          type: integer
          description: <em>year for which the data is provided</em>
          nullable: true
        month:
          type: integer
          description: <em>month for which the data is provided</em>
          nullable: true
        metrics:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/DataforseoLabsMetricsInfo'
          description: <em>ranking data relevant to the specified domain</em>
          nullable: true
    DataforseoLabsGoogleHistoricalRankOverviewLiveResultInfo:
      type: object
      properties:
        se_type:
          type: string
          description: <em>search engine type</em>
          nullable: true
        target:
          type: string
          description: <em>target domain in a POST array</em>
          nullable: true
        location_code:
          type: integer
          description: <em>location code in a POST array</em>
          nullable: true
        language_code:
          type: string
          description: <em>language code in a POST array</em>
          nullable: true
        total_count:
          type: integer
          description: <em>total amount of results in our database relevant to your request</em>
          format: int64
          nullable: true
        items_count:
          type: integer
          description: <em>the number of results returned in the <code>items</code> array</em>
          format: int64
          nullable: true
        items:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/DataforseoLabsGoogleHistoricalRankOverviewLiveItem'
            nullable: true
          description: <em>contains historical ranking and traffic data</em>
          nullable: true
    DataforseoLabsGoogleHistoricalRankOverviewLiveTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/DataforseoLabsGoogleHistoricalRankOverviewLiveResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    DataforseoLabsGoogleHistoricalRankOverviewLiveResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/DataforseoLabsGoogleHistoricalRankOverviewLiveTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    DataforseoLabsGooglePageIntersectionLiveRequestInfo:
      type: object
      properties:
        pages:
          type: object
          additionalProperties:
            type: string
            nullable: true
          description: 'target URLs of pagesrequired fieldyou can set up to 20 pages in this objectthe pages should be specified with absolute URLs (including http:// or https://)example:"pages": {"1":"https://www.apple.com/mac/*","2":"https://dataforseo.com/*","3":"https://support.microsoft.com/"}if you specify a single page here, we will return results only for this page;you can also use a wildcard ('''') character to specify the search patternexample:"example.com"search for the exact URL"example.com/eng/"search for the example.com page and all its related URLs which start with ''/eng/'', such as "example.com/eng/index.html" and "example.com/eng/help/", etc.note: a wilcard should be placed after the slash (''/'') character in the end of the URL, it is not possible to place it after the domain in the following way:https://dataforseo.comuse https://dataforseo.com/ insteadNote: this endpoint will not provide results if the number of intersecting keywords exceeds 10 million'
          nullable: true
        exclude_pages:
          type: array
          items:
            type: string
          description: 'URLs of pages you want to excludeoptional fieldyou can set up to 10 pages in this arrayif you use this array, results will contain the keywords for which URLs from the pages object rank, but URLs from exclude_pages array do not;note that if you specify this field, the results will be based on the keywords any URL from pages ranks for regardless of intersections between them. However, you can set intersection_mode to intersect and results will contain the keywords all URLs from pages rank for in the same SERP and URLs from exclude_pages do not. use a wildcard (''*'') character to specify the search patternexample:"exclude_pages":["https://www.apple.com/iphone/*","https://dataforseo.com/apis/*","https://www.microsoft.com/en-us/industry/services/"]'
          nullable: true
        location_name:
          type: string
          description: 'full name of the locationrequired field if you don''t specify location_codeNote: it is required to specify either location_name or location_codeyou can receive the list of available locations with their location_name by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languagesexample:United Kingdom'
          nullable: true
        location_code:
          type: integer
          description: 'location coderequired field if you don''t specify location_nameNote: it is required to specify either location_name or location_codeyou can receive the list of available locations with their location_code by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languagesexample:2840'
          nullable: true
        language_name:
          type: string
          description: 'full name of the languagerequired field if you don''t specify language_codeNote: it is required to specify either language_name or language_codeyou can receive the list of available languages with their language_name by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languagesexample:English'
          nullable: true
        language_code:
          type: string
          description: 'language coderequired field if you don''t specify language_nameNote: it is required to specify either language_name or language_codeyou can receive the list of available languages with their language_code by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languagesexample:en'
          nullable: true
        item_types:
          type: array
          items:
            type: string
          description: 'search results typeindicates type of search results included in the responseoptional fieldpossible values: ["organic", "paid", "featured_snippet", "local_pack"]default value: ["organic", "paid"]'
          nullable: true
        limit:
          type: integer
          description: 'the maximum number of returned keywordsoptional fielddefault value: 100maximum value: 1000'
          nullable: true
        offset:
          type: integer
          description: 'offset in the items array of returned keywordsoptional fielddefault value: 0if you specify 10 here, the first ten keywords in the results array will be omitted and the data will be provided for the successive keywords'
          nullable: true
        include_subdomains:
          type: boolean
          description: 'indicates if the subdomains will be included in the searchoptional fieldif set to false, the subdomains will be ignoreddefault value: true'
          nullable: true
        intersection_mode:
          type: string
          description: 'indicates whether to intersect keywordsoptional fielduse this field to intersect or merge results for the specified URLspossible values: union, intersectunion - results are based on all keywords any URL from pages rank for;intersect - results are based on the keywords all URLs from pages rank for in the same SERP:by default, results are based on the intersect mode if you specify only pages array. If you specify exclude_pages as well, results are based on the union mode'
          nullable: true
        include_serp_info:
          type: boolean
          description: 'include data from SERP for each keywordoptional fieldif set to true, we will return a serp_info array containing SERP data (number of search results, relevant URL, and SERP features) for every keyword in the responsedefault value: false'
          nullable: true
        include_clickstream_data:
          type: boolean
          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, 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 calculated in this help center article'
          nullable: true
        ignore_synonyms:
          type: boolean
          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'
          nullable: true
        filters:
          type: array
          items:
            type: object
            nullable: true
          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, ilike, not_ilike, like, not_like, match, not_matchyou can use the % operator with like and not_like, as well as ilike and not_ilike to match any string of zero or more charactersnote that if you want to filter by any field in the intersection_result array you need to specify the number of corresponding pagefor instance, if you want to filter results by the ranking of the first specified URL, you should set the following filter:[intersection_result.1.rank_absolute,"=",1]if you want to filter results and receive only organic listings for the third specified URL, you should set the following filter:[intersection_result.3.type,"=","organic"] , etc.example:["keyword_data.keyword_info.search_volume","in",[100,1000]][["intersection_result.1.etv",">",0],"and",["intersection_result.1.description","like","%goat%"]][["keyword_data.keyword_info.search_volume",">",100],"and",[["intersection_result.2.description","like","%goat%"],"or",["intersection_result.2.type","=","organic"]]]for more information about filters, please refer to Dataforseo Labs - Filters or this help center guide'
          nullable: true
        order_by:
          type: array
          items:
            type: string
          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 parameterexample:["keyword_data.keyword_info.competition,desc"]default rule:["keyword_data.keyword_info.search_volume,desc"]note that you can set no more than three sorting rules in a single requestyou should use a comma to separate several sorting rulesexample:["intersection_result.1.rank_group,asc","intersection_result.2.rank_absolute,asc"]'
          nullable: true
        tag:
          type: string
          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
          nullable: true
      example:
        - pages:
            '1': https://forbes.com
            '2': https://cnn.com/*
          language_name: English
          location_code: 2840
          include_serp_info: true
          limit: 3
    DataforseoLabsGooglePageIntersectionLiveItem:
      type: object
      properties:
        se_type:
          type: string
          description: search engine type
          nullable: true
        keyword_data:
          type: object
          oneOf:
            - $ref: '#/components/schemas/KeywordDataInfo'
          description: keyword data for the returned keyword
          nullable: true
        intersection_result:
          type: object
          additionalProperties:
            type: object
            oneOf:
              - $ref: '#/components/schemas/BaseDataforseoLabsApiElementItem'
            nullable: true
          description: 'contains data on the SERP elements found for the returned keyworddata will be provided in separate arrays for each URL you specified in the pages object when setting a task;depending on the number of specified URLs, it can contain from 1 to 20 arrays named respectively'
          nullable: true
    DataforseoLabsGooglePageIntersectionLiveResultInfo:
      type: object
      properties:
        se_type:
          type: string
          description: search engine type
          nullable: true
        pages:
          type: object
          additionalProperties:
            type: string
            nullable: true
          description: URLs you specified a POST array
          nullable: true
        exclude_pages:
          type: array
          items:
            type: string
            nullable: true
          description: URLs you specified in a POST array that will be excluded from the results
          nullable: true
        location_code:
          type: integer
          description: location code in a POST array
          nullable: true
        language_code:
          type: string
          description: language code in a POST array
          nullable: true
        total_count:
          type: integer
          description: total amount of results in our database relevant to your request
          format: int64
          nullable: true
        items_count:
          type: integer
          description: the number of results returned in the items array
          format: int64
          nullable: true
        items:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/DataforseoLabsGooglePageIntersectionLiveItem'
            nullable: true
          description: 'contains keywords, relevant SERP elements and related data'
          nullable: true
    DataforseoLabsGooglePageIntersectionLiveTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/DataforseoLabsGooglePageIntersectionLiveResultInfo'
                nullable: true
              description: array of results
              nullable: true
    DataforseoLabsGooglePageIntersectionLiveResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/DataforseoLabsGooglePageIntersectionLiveTaskInfo'
                nullable: true
              description: array of tasks
              nullable: true
    DataforseoLabsGoogleBulkTrafficEstimationLiveRequestInfo:
      type: object
      properties:
        targets:
          type: array
          items:
            type: string
          description: '<em>target domains, subdomains, and webpages</em><br><strong>required field</strong><br>you can specify domains, subdomains, and webpages in this field;<br>domains and subdomains should be specified without <code>https://</code> and <code>www.</code>;<br>pages should be specified with absolute URL, including <code>https://</code> and <code>www.</code>;<br>you can set up to 1000 domains, subdomains or webpages'
        location_name:
          type: string
          description: '<em>full name of the location</em><br>if you use this field, you don''t have to specify <code>location_code</code><br>you can receive the list of available locations with their <code>location_name</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>ignore this field to get the results for all available locations<br>example:<br><code class="long-string">United Kingdom</code>'
          nullable: true
        location_code:
          type: integer
          description: '<em>location code</em><br>if you use this field, you don''t have to specify <code>location_name</code><br>you can receive the list of available locations with their <code>location_code</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>ignore this field to get the results for all available locations<br>example:<br><code class="long-string">2840</code>'
          nullable: true
        language_name:
          type: string
          description: '<em>full name of the language</em><br>if you use this field, you don’t need to specify <code>language_code</code><br>you can receive the list of available languages with their <code>language_name</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>ignore this field to get the results for all available languages<br>example:<br><code class="long-string">English</code>'
          nullable: true
        language_code:
          type: string
          description: '<em>language code</em><br>if you use this field, you don’t need to specify <code>language_name</code><br>you can receive the list of available languages with their <code>language_code</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>ignore this field to get the results for all available languages<br>example:<br><code class="long-string">en</code>'
          nullable: true
        item_types:
          type: array
          items:
            type: string
          description: '<em>display results by item type</em><br>optional field<br>indicates the type of search results included in the response<p><strong>Note:</strong> if the <code>item_types</code> array contains item types that are different from <code>organic</code>, the results will be ordered by the first item type in the array<p>possible values: <br><code>["organic", "paid", "featured_snippet", "local_pack"]</code><br>default value: <br><code>["organic", "paid"]</code>'
          nullable: true
        ignore_synonyms:
          type: boolean
          description: '<em>ignore highly similar keywords</em><br>optional field<br>if set to_<code class="prettyprint">true</code>, only core keywords will be returned, all highly similar keywords will be excluded;  <br>default value: <code>false</code>'
          nullable: true
        tag:
          type: string
          description: <em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response
          nullable: true
      example:
        - targets:
            - dataforseo.com
            - cnn.com
            - forbes.com
          location_code: 2840
          language_code: en
          item_types:
            - organic
            - paid
    BulkMetricsInfo:
      type: object
      properties:
        etv:
          type: number
          description: <em>estimated traffic volume</em><br>estimated organic monthly traffic to the domain<br>calculated as the product of CTR (click-through-rate) and search volume values of all keywords the domain ranks for<br>learn more about how the metric is calculated in <a href="https://dataforseo.com/help-center/how-is-etv-calculated" rel="noopener noreferrer" target="_blank">this help center article</a>
          nullable: true
        count:
          type: integer
          description: <em>total count of organic SERPs that contain the domain</em>
          format: int64
          nullable: true
    BulkMetricsBundleInfo:
      type: object
      properties:
        organic:
          type: object
          oneOf:
            - $ref: '#/components/schemas/BulkMetricsInfo'
          description: <em>traffic data from organic search</em>
          nullable: true
        paid:
          type: object
          oneOf:
            - $ref: '#/components/schemas/BulkMetricsInfo'
          description: <em>traffic data from paid search</em>
          nullable: true
        local_pack:
          type: object
          oneOf:
            - $ref: '#/components/schemas/BulkMetricsInfo'
          description: <em>traffic data from the local pack results in SERP</em>
          nullable: true
        featured_snippet:
          type: object
          oneOf:
            - $ref: '#/components/schemas/BulkMetricsInfo'
          description: <em>traffic data from the featured snippet results in Google SERP</em>
          nullable: true
    DataforseoLabsGoogleBulkTrafficEstimationLiveItem:
      type: object
      properties:
        se_type:
          type: string
          description: <em>search engine type</em>
          nullable: true
        target:
          type: string
          description: <em>target domain in a POST array</em>
          nullable: true
        metrics:
          type: object
          oneOf:
            - $ref: '#/components/schemas/BulkMetricsBundleInfo'
          description: <em>traffic data relevant to the specified domain</em>
          nullable: true
    DataforseoLabsGoogleBulkTrafficEstimationLiveResultInfo:
      type: object
      properties:
        se_type:
          type: string
          description: <em>search engine type</em>
          nullable: true
        location_code:
          type: integer
          description: '<em>location code in a POST array</em><br>if there is no data, then the value is <code>null</code>'
          nullable: true
        language_code:
          type: string
          description: '<em>language code in a POST array</em><br>if there is no data, then the value is <code>null</code>'
          nullable: true
        total_count:
          type: integer
          description: <em>total amount of results in our database relevant to your request</em>
          format: int64
          nullable: true
        items_count:
          type: integer
          description: <em>the number of results returned in the <code>items</code> array</em>
          format: int64
          nullable: true
        items:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/DataforseoLabsGoogleBulkTrafficEstimationLiveItem'
            nullable: true
          description: <em>array of items with relevant traffic estimation data</em>
          nullable: true
    DataforseoLabsGoogleBulkTrafficEstimationLiveTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/DataforseoLabsGoogleBulkTrafficEstimationLiveResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    DataforseoLabsGoogleBulkTrafficEstimationLiveResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/DataforseoLabsGoogleBulkTrafficEstimationLiveTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    DataforseoLabsGoogleHistoricalBulkTrafficEstimationLiveRequestInfo:
      type: object
      properties:
        targets:
          type: array
          items:
            type: string
          description: <em>target domains and subdomains</em><br><strong>required field</strong><br>you can specify domains and subdomains in this field;<br>domains and subdomains should be specified without <code>https://</code> and <code>www.</code>;<br>you can set up to 1000 domains or subdomains
        location_name:
          type: string
          description: '<em>full name of the location</em><br>if you use this field, you don''t have to specify <code>location_code</code><br>you can receive the list of available locations with their <code>location_name</code> by making a separate request to the<br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>ignore this field to get the results for all available locations<br>example:<br><code class="long-string">United Kingdom</code>'
          nullable: true
        location_code:
          type: integer
          description: '<em>location code</em><br>if you use this field, you don''t have to specify <code>location_name</code><br>you can receive the list of available locations with their <code>location_code</code> by making a separate request to the<br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>ignore this field to get the results for all available locations<br>example:<br><code class="long-string">2840</code>'
          nullable: true
        language_name:
          type: string
          description: '<em>full name of the language</em><br>if you use this field, you don’t need to specify <code>language_code</code><br>you can receive the list of available languages with their <code>language_name</code> by making a separate request to the<br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>ignore this field to get the results for all available languages<br>example:<br><code class="long-string">English</code>'
          nullable: true
        language_code:
          type: string
          description: '<em>language code</em><br>if you use this field, you don’t need to specify <code>language_name</code><br>you can receive the list of available languages with their <code>language_code</code> by making a separate request to the<br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>ignore this field to get the results for all available languages<br>example:<br><code class="long-string">en</code>'
          nullable: true
        date_from:
          type: string
          description: '<em>starting date of the time range</em><br>optional field<br>if you don''t specify this field, the data will be provided for the previous 12 months<br>minimal possible value: <code>2020-10-01</code><br>date format: <code>"yyyy-mm-dd"</code>'
          nullable: true
        date_to:
          type: string
          description: '<em>ending date of the time range</em><br>optional field<br>if you don''t specify this field, the today''s date will be used by default;<br>date format: <code>"yyyy-mm-dd"</code><br>example:<br><code>"2021-04-01"</code>'
          nullable: true
        ignore_synonyms:
          type: boolean
          description: '<em>ignore highly similar keywords</em><br>optional field<br>if set to_<code class="prettyprint">true</code> only core keywords will be returned, all highly similar keywords will be excluded;<br>default value: <code>false</code>n'
          nullable: true
        item_types:
          type: array
          items:
            type: string
          description: '<em>display results by item type</em><br>optional field<br>indicates the type of search results included in the response;<br><strong>Note:</strong> if the <code>item_types</code> array contains item types that are different from <code>organic</code>, the results will be ordered by the first item type in the array;<br>possible values:<br><code>["organic", "paid", "featured_snippet", "local_pack"]</code><br>default value:<br><code>["organic", "paid"]</code>'
          nullable: true
        tag:
          type: string
          description: <em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response
          nullable: true
      example:
        - targets:
            - dataforseo.com
            - cnn.com
            - forbes.com
          location_code: 2840
          language_code: en
          date_from: '2021-01-01'
          date_to: '2021-03-29'
          item_types:
            - organic
            - paid
    HistoricalMetricsInfo:
      type: object
      properties:
        year:
          type: integer
          description: <em>year for which the data is provided</em>
          nullable: true
        month:
          type: integer
          description: <em>month for which the data is provided</em>
          nullable: true
        etv:
          type: number
          description: <em>estimated traffic volume</em><br>estimated organic monthly traffic to the domain<br>calculated as the product of CTR (click-through-rate) and search volume values of all keywords the domain ranks for<br>learn more about how the metric is calculated in <a href="https://dataforseo.com/help-center/how-is-etv-calculated" target="_blank" rel="noopener noreferrer">this help center article</a>
          nullable: true
        count:
          type: integer
          description: <em>total count of organic SERPs that contain the domain</em>
          format: int64
          nullable: true
    HistoricalMetricsBundleInfo:
      type: object
      properties:
        organic:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/HistoricalMetricsInfo'
            nullable: true
          description: <em>traffic data from organic search</em>
          nullable: true
        paid:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/HistoricalMetricsInfo'
            nullable: true
          description: <em>traffic data from paid search</em>
          nullable: true
        local_pack:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/HistoricalMetricsInfo'
            nullable: true
          description: <em>traffic data from the local pack results in SERP</em>
          nullable: true
        featured_snippet:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/HistoricalMetricsInfo'
            nullable: true
          description: <em>traffic data from the featured snippet results in Google SERP</em>
          nullable: true
    DataforseoLabsGoogleHistoricalBulkTrafficEstimationLiveItem:
      type: object
      properties:
        se_type:
          type: string
          description: <em>search engine type</em>
          nullable: true
        target:
          type: string
          description: <em>target domain in a POST array</em>
          nullable: true
        metrics:
          type: object
          oneOf:
            - $ref: '#/components/schemas/HistoricalMetricsBundleInfo'
          description: <em>traffic data relevant to the specified domain</em>
          nullable: true
    DataforseoLabsGoogleHistoricalBulkTrafficEstimationLiveResultInfo:
      type: object
      properties:
        se_type:
          type: string
          description: <em>search engine type</em>
          nullable: true
        location_code:
          type: integer
          description: '<em>location code in a POST array</em><br>if there is no data, then the value is <code>null</code>'
          nullable: true
        language_code:
          type: string
          description: '<em>language code in a POST array</em><br>if there is no data, then the value is <code>null</code>'
          nullable: true
        total_count:
          type: integer
          description: <em>total amount of results in our database relevant to your request</em>
          format: int64
          nullable: true
        items_count:
          type: integer
          description: <em>the number of results returned in the <code>items</code> array</em>
          format: int64
          nullable: true
        items:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/DataforseoLabsGoogleHistoricalBulkTrafficEstimationLiveItem'
            nullable: true
          description: <em>array of items with relevant traffic estimation data</em>
          nullable: true
    DataforseoLabsGoogleHistoricalBulkTrafficEstimationLiveTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/DataforseoLabsGoogleHistoricalBulkTrafficEstimationLiveResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    DataforseoLabsGoogleHistoricalBulkTrafficEstimationLiveResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/DataforseoLabsGoogleHistoricalBulkTrafficEstimationLiveTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    DataforseoLabsGoogleHistoricalKeywordDataLiveRequestInfo:
      type: object
      properties:
        keywords:
          type: array
          items:
            type: string
          description: '<em>keywords</em><br><strong>required field</strong><br>The maximum number of keywords you can specify: 700<br>The maximum number of characters for each keyword: 80<br>The maximum number of words for each keyword phrase: 10<br>the specified keywords will be converted to lowercase format, data will be provided in a separate array<p><strong>note</strong> that if some of the keywords specified in this array are omitted in the results you receive, then our database doesn''t contain such keywords and cannot return data on them<br>you will not be charged for the keywords omitted in the results<p>learn more about rules and limitations of <code>keyword</code> and <code>keywords</code> fields in DataForSEO APIs in this <a href="https://dataforseo.com/help-center/rules-and-limitations-of-keyword-and-keywords-fields-in-dataforseo-apis" rel="noopener noreferrer" target="_blank">Help Center article</a>'
        location_name:
          type: string
          description: <em>full name of the location</em><br><strong>required field if you don't specify</strong> <code>location_code</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_name</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class="long-string">United Kingdom</code>
        location_code:
          type: integer
          description: <em>location code</em><br><strong>required field if you don't specify</strong> <code>location_name</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_code</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class="long-string">2840</code>
        language_name:
          type: string
          description: <em>full name of the language</em><br><strong>required field if you don't specify</strong> <code>language_code</code><br><strong>Note:</strong> it is required to specify either <code>language_name</code> or <code>language_code</code><br>you can receive the list of available locations with their <code>language_name</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class="long-string">English</code>
        language_code:
          type: string
          description: <em>language code</em><br><strong>required field if you don't specify</strong> <code>language_name</code><br><strong>Note:</strong> it is required to specify either <code>language_name</code> or <code>language_code</code><br>you can receive the list of available locations with their <code>language_code</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class="long-string">en</code>
          nullable: true
        tag:
          type: string
          description: <em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response
          nullable: true
      example:
        - language_code: en
          location_code: 2840
          keywords:
            - iphone
    History:
      type: object
      properties:
        year:
          type: integer
          description: <em>year</em>
          nullable: true
        month:
          type: integer
          description: <em>month</em>
          nullable: true
        keyword_info:
          type: object
          oneOf:
            - $ref: '#/components/schemas/KeywordInfo'
          description: <em>historical data for the keyword</em>
          nullable: true
    DataforseoLabsGoogleHistoricalKeywordDataLiveItem:
      type: object
      properties:
        se_type:
          type: string
          description: <em>search engine type</em>
          nullable: true
        keyword:
          type: string
          description: <em>keyword</em><br><strong>keyword is returned with decoded %## (plus character '+' will be decoded to a space character)</strong>
          nullable: true
        location_code:
          type: integer
          description: <em>location code in a POST array</em>
          nullable: true
        language_code:
          type: string
          description: <em>language code in a POST array</em>
          nullable: true
        history:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/History'
            nullable: true
          description: <em>array of objects with historical data for the keyword</em>
          nullable: true
    DataforseoLabsGoogleHistoricalKeywordDataLiveResultInfo:
      type: object
      properties:
        se_type:
          type: string
          description: <em>search engine type</em>
          nullable: true
        location_code:
          type: integer
          description: <em>location code in a POST array</em>
          nullable: true
        language_code:
          type: string
          description: <em>language code in a POST array</em>
          nullable: true
        items_count:
          type: integer
          description: <em>the number of results returned in the <code>items</code> array</em>
          format: int64
          nullable: true
        items:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/DataforseoLabsGoogleHistoricalKeywordDataLiveItem'
            nullable: true
          description: <em>contains keywords and related data</em>
          nullable: true
    DataforseoLabsGoogleHistoricalKeywordDataLiveTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/DataforseoLabsGoogleHistoricalKeywordDataLiveResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    DataforseoLabsGoogleHistoricalKeywordDataLiveResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/DataforseoLabsGoogleHistoricalKeywordDataLiveTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    DataforseoLabsGoogleKeywordOverviewLiveRequestInfo:
      type: object
      properties:
        keywords:
          type: array
          items:
            type: string
          description: '<em>keywords</em><br><strong>required field</strong><br>The maximum number of keywords you can specify: 700<br>The maximum number of characters for each keyword: 80<br>The maximum number of words for each keyword phrase: 10<br>the specified keywords will be converted to lowercase format, data will be provided in a separate array<p><strong>note</strong> that if some of the keywords specified in this array are omitted in the results you receive, then our database doesn''t contain such keywords and cannot return data on them<br>you will not be charged for the keywords omitted in the results<p>learn more about rules and limitations of <code>keyword</code> and <code>keywords</code> fields in DataForSEO APIs in this <a href="https://dataforseo.com/help-center/rules-and-limitations-of-keyword-and-keywords-fields-in-dataforseo-apis" rel="noopener noreferrer" target="_blank">Help Center article</a>'
        location_name:
          type: string
          description: <em>full name of the location</em><br><strong>required field if you don't specify</strong> <code>location_code</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_name</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class="long-string">United Kingdom</code>
        location_code:
          type: integer
          description: <em>location code</em><br><strong>required field if you don't specify</strong> <code>location_name</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_code</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class="long-string">2840</code>
        language_name:
          type: string
          description: <em>full name of the language</em><br><strong>required field if you don't specify</strong> <code>language_code</code><br><strong>Note:</strong> it is required to specify either <code>language_name</code> or <code>language_code</code><br>you can receive the list of available locations with their <code>language_name</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class="long-string">English</code>
        language_code:
          type: string
          description: <em>language code</em><br><strong>required field if you don't specify</strong> <code>language_name</code><br><strong>Note:</strong> it is required to specify either <code>language_name</code> or <code>language_code</code><br>you can receive the list of available locations with their <code>language_code</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class="long-string">en</code>
          nullable: true
        include_serp_info:
          type: boolean
          description: '<em>include data from SERP for each keyword</em><br>optional field<br>if set to <code>true</code>, we will return a <code>serp_info</code> array containing SERP data (number of search results, relevant URL, and SERP features) for every keyword in the response<br>default value: <code>false</code>'
          nullable: true
        include_clickstream_data:
          type: boolean
          description: '<em>include or exclude data from clickstream-based metrics in the result</em><br>optional field<br>if the parameter is set to <code>true</code>, you will receive <code>clickstream_keyword_info</code>, <code>keyword_info_normalized_with_clickstream</code>, and <code>keyword_info_normalized_with_bing</code> fields in the response<br>default value: <code>false</code><br>with this parameter enabled, you will be charged double the price for the request<p>learn more about how clickstream-based metrics are calculated in this <a href="https://dataforseo.com/help-center/what-are-clickstream-based-metrics-and-how-do-we-calculate-them" rel="noopener noreferrer" target="_blank">help center article</a>'
          nullable: true
        tag:
          type: string
          description: <em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response
          nullable: true
      example:
        - language_code: en
          location_code: 2840
          include_clickstream_data: true
          include_serp_info: true
          keywords:
            - iphone
    DataforseoLabsGoogleKeywordOverviewLiveItem:
      type: object
      properties:
        se_type:
          type: string
          description: <em>search engine type</em>
          nullable: true
        keyword:
          type: string
          description: <em>keyword</em><br><strong>keyword is returned with decoded %## (plus character '+' will be decoded to a space character)</strong>
          nullable: true
        location_code:
          type: integer
          description: <em>location code in a POST array</em>
          nullable: true
        language_code:
          type: string
          description: <em>language code in a POST array</em>
          nullable: true
        search_partners:
          type: boolean
          description: '<em>indicates data for Google and partner sites</em><br>if <code class="prettyprint">true</code>, the results are returned for owned, operated, and syndicated networks across Google and partner sites that host Google search;<br>if <code>false</code>, the results are returned for Google search sites only'
          nullable: true
        keyword_info:
          type: object
          oneOf:
            - $ref: '#/components/schemas/KeywordInfo'
          description: <em>keyword data for the returned keyword</em>
          nullable: true
        keyword_info_normalized_with_bing:
          type: object
          oneOf:
            - $ref: '#/components/schemas/KeywordInfoNormalizedWithInfo'
          description: <em>contains keyword search volume normalized with Bing search volume</em>
          nullable: true
        keyword_info_normalized_with_clickstream:
          type: object
          oneOf:
            - $ref: '#/components/schemas/KeywordInfoNormalizedWithInfo'
          description: <em>contains keyword search volume normalized with clickstream data<br></em>
          nullable: true
        clickstream_keyword_info:
          type: object
          oneOf:
            - $ref: '#/components/schemas/ClickstreamKeywordInfo'
          description: '<em>clickstream data for the returned keyword</em><br>to retrieve results for this field, the parameter <code>include_clickstream_data</code> must be set to <code>true</code>'
          nullable: true
        keyword_properties:
          type: object
          oneOf:
            - $ref: '#/components/schemas/KeywordProperties'
          description: <em>additional information about the keyword</em>
          nullable: true
        serp_info:
          type: object
          oneOf:
            - $ref: '#/components/schemas/SerpInfo'
          description: <em>SERP data</em><br>the value will be <code>null</code> if you didn't set the field <code>include_serp_info</code> to <code>true</code> in the POST array or if there is no SERP data for this keyword in our database
          nullable: true
        avg_backlinks_info:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AvgBacklinksInfo'
          description: '<em>backlink data for the returned keyword</em><br>this object provides the average number of backlinks, referring pages and domains, as well as the average rank values among the top-10 websites ranking organically for the keyword'
          nullable: true
        search_intent_info:
          type: object
          oneOf:
            - $ref: '#/components/schemas/SearchIntentInfo'
          description: <em>search intent info for the returned keyword</em><br>learn about search intent in this <a href="https://dataforseo.com/help-center/search-intent-and-its-types" rel="noopener noreferrer" target="_blank">help center article</a>
          nullable: true
    DataforseoLabsGoogleKeywordOverviewLiveResultInfo:
      type: object
      properties:
        se_type:
          type: string
          description: <em>search engine type</em>
          nullable: true
        location_code:
          type: integer
          description: <em>location code in a POST array</em>
          nullable: true
        language_code:
          type: string
          description: <em>language code in a POST array</em>
          nullable: true
        items_count:
          type: integer
          description: <em>the number of results returned in the <code>items</code> array</em>
          format: int64
          nullable: true
        items:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/DataforseoLabsGoogleKeywordOverviewLiveItem'
            nullable: true
          description: <em>contains keywords and related data</em>
          nullable: true
    DataforseoLabsGoogleKeywordOverviewLiveTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/DataforseoLabsGoogleKeywordOverviewLiveResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    DataforseoLabsGoogleKeywordOverviewLiveResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/DataforseoLabsGoogleKeywordOverviewLiveTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    DataforseoLabsAmazonBulkSearchVolumeLiveRequestInfo:
      type: object
      properties:
        keywords:
          type: array
          items:
            type: string
          description: '<em>target keywords</em><br><strong>required field</strong><br>UTF-8 encoding<br>maximum number of keywords you can specify in this array: 1000;<br>the keywords will be converted to lowercase format<p>learn more about rules and limitations of <code>keyword</code> and <code>keywords</code> fields in DataForSEO APIs in this <a href="https://dataforseo.com/help-center/rules-and-limitations-of-keyword-and-keywords-fields-in-dataforseo-apis" rel="noopener noreferrer" target="_blank">Help Center article</a>'
        location_name:
          type: string
          description: '<em>full name of the location</em><br><strong>required field if don''t specify <code>location_code</code></strong><br>you can receive the list of available locations with their <code>location_name</code> by making a separate request to <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><a name="loc"></a><br><strong>Note:</strong> this endpoint currently supports the following locations and languages only:<p><code>Australia</code> - <code>2036</code>, <code>en</code><br><code>Austria</code> - <code>2040</code>, <code>de</code><br><code>Canada</code> - <code>2124</code>, <code>en</code><br><code>Egypt</code> - <code>2818</code>, <code>ar</code><br><code>France</code> - <code>2250</code>, <code>fr</code><br><code>Germany</code> - <code>2276</code>, <code>de</code><br><code>India</code> - <code>2356</code>, <code>en</code><br><code>Italy</code> - <code>2380</code>, <code>it</code><br><code>Mexico</code> - <code>2484</code>, <code>es</code><br><code>Netherlands</code> - <code>2528</code>, <code>nl</code><br><code>Saudi Arabia</code> - <code>2682</code>, <code>ar</code><br><code>Singapore</code> - <code>2702</code>, <code>en</code><br><code>Spain</code> - <code>2724</code>, <code>es</code><br><code>United Arab Emirates</code> - <code>2784</code>, <code>ar</code><br><code>United Kingdom</code> - <code>2826</code>, <code>en</code><br><code>United States</code> - <code>2840</code>, <code>en</code><br>example:<br><code class="long-string">United States</code>'
        location_code:
          type: integer
          description: <em>location code</em><br><strong>required field if don't specify <code>location_name</code></strong><br>you can receive the list of available locations with their <code>location_code</code> by making a separate request to <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports <a href="#loc">these locations and languages only;</a><br>example:<br><code class="long-string">2840</code>
        language_name:
          type: string
          description: <em>full name of the language</em><br><strong>required field if don't specify <code>language_code</code></strong><br>you can receive the list of available languages with their <code>language_name</code> by making a separate request to <code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br><strong>Note:</strong> this endpoint currently supports <a href="#loc">these locations and languages only;</a><br>example:<br><code class="long-string">English</code>
        language_code:
          type: string
          description: <em>language code</em><br><strong>required field if don't specify <code>language_name</code></strong><br>you can receive the list of available languages with their <code>language_code</code> by making a separate request to <code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br><strong>Note:</strong> this endpoint currently supports <a href="#loc">these locations and languages only;</a><br>example:<br><code class="long-string">en</code>
          nullable: true
        tag:
          type: string
          description: <em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response
          nullable: true
      example:
        - keywords:
            - buy laptop
            - cheap laptops for sale
            - purchase laptop
          location_code: 2840
          language_code: en
    DataforseoLabsAmazonBulkSearchVolumeLiveItem:
      type: object
      properties:
        se_type:
          type: string
          description: <em>search engine type</em>
          nullable: true
        keyword:
          type: string
          description: <em>keyword in a POST array</em>
          nullable: true
        search_volume:
          type: integer
          description: <em>average monthly search volume rate</em><br>represents the (approximate) number of searches for the returned keyword on Amazon
          format: int64
          nullable: true
    DataforseoLabsAmazonBulkSearchVolumeLiveResultInfo:
      type: object
      properties:
        se_type:
          type: string
          description: <em>search engine type</em>
          nullable: true
        location_code:
          type: integer
          description: '<em>location code in a POST array</em><br>if there is no data, then the value is <code>null</code>'
          nullable: true
        language_code:
          type: string
          description: '<em>language code in a POST array</em><br>if there is no data, then the value is <code>null</code>'
          nullable: true
        total_count:
          type: integer
          description: <em>total amount of results in our database relevant to your request</em>
          format: int64
          nullable: true
        items_count:
          type: integer
          description: <em>the number of results returned in the <code>items</code> array</em>
          format: int64
          nullable: true
        items:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/DataforseoLabsAmazonBulkSearchVolumeLiveItem'
            nullable: true
          description: <em>contains keyword search volume data data</em>
          nullable: true
    DataforseoLabsAmazonBulkSearchVolumeLiveTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/DataforseoLabsAmazonBulkSearchVolumeLiveResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    DataforseoLabsAmazonBulkSearchVolumeLiveResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/DataforseoLabsAmazonBulkSearchVolumeLiveTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    DataforseoLabsAmazonRelatedKeywordsLiveRequestInfo:
      type: object
      properties:
        keyword:
          type: string
          description: <em>keyword</em><br><strong>required field</strong><br>UTF-8 encoding<br>the keywords should be specified in the lowercase format<p>learn more about rules and limitations of <code>keyword</code> and <code>keywords</code> fields in DataForSEO APIs in this <a href="https://dataforseo.com/help-center/rules-and-limitations-of-keyword-and-keywords-fields-in-dataforseo-apis" rel="noopener noreferrer" target="_blank">Help Center article</a>
        location_name:
          type: string
          description: '<em>full name of the location</em><br><strong>required field if you don''t specify</strong> <code>location_code</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_name</code> by making a separate request to <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the US, Egypt, Saudi Arabia, and the United Arab Emirates locations only;<br>example:<br><code class="long-string">United States</code>'
        location_code:
          type: integer
          description: '<em>location code</em><br><strong>required field if you don''t specify</strong> <code>location_name</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_code</code> by making a separate request to <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the US, Egypt, Saudi Arabia, and the United Arab Emirates locations only;<br>example:<br><code class="long-string">2840</code>'
        language_name:
          type: string
          description: <em>full name of the language</em><br><strong>required field if you don't specify</strong> <code>language_code</code><br><strong>Note:</strong> it is required to specify either <code>language_name</code> or <code>language_code</code><br>you can receive the list of available locations with their <code>language_name</code> by making a separate request to <code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class="long-string">English</code>
        language_code:
          type: string
          description: <em>language code</em><br><strong>required field if you don't specify</strong> <code>language_name</code><br><strong>Note:</strong> it is required to specify either <code>language_name</code> or <code>language_code</code><br>you can receive the list of available locations with their <code>language_code</code> by making a separate request to <code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class="long-string">en</code>
          nullable: true
        depth:
          type: integer
          description: '<em>keyword search depth</em><br>optional field<br>default value: <code>1</code>;<br>number of the returned results depends on the value you set in this field;<br>you can specify a level from 0 to 4;<br>estimated number of keywords for each level (maximum):<br>0 - the keyword set in the <code>keyword</code> field<br>1 – 6 keywords<br>2 – 42 keywords<br>3 – 258 keywords<br>4 – 1554 keywords'
          nullable: true
        include_seed_keyword:
          type: boolean
          description: '<em>include data for the seed keyword</em><br>optional field<br>if set to <code>true</code>, data for the seed keyword specified in the <code>keyword</code> field will be provided in the <code>seed_keyword_data</code> array of the response<br>default value: <code>false</code>'
          nullable: true
        ignore_synonyms:
          type: boolean
          description: '<em>ignore highly similar keywords</em><br>optional field<br>if set to_<code class="prettyprint">true</code> only core keywords will be returned, all highly similar keywords will be excluded;  <br>default value: <code>false</code>n'
          nullable: true
        limit:
          type: integer
          description: '<em>the maximum number of returned keywords</em><br>optional field<br>default value: <code>100</code><br>maximum value: <code>1000</code>'
          nullable: true
        offset:
          type: integer
          description: '<em>offset in the results array of returned keywords</em><br>optional field<br>default value: <code>0</code><br>if you specify the <code>10</code> value, the first ten keywords in the results array will be omitted and the data will be provided for the successive keywords'
          nullable: true
        tag:
          type: string
          description: <em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response
          nullable: true
      example:
        - keyword: computer mouse
          language_name: English
          location_code: 2840
          limit: 5
          include_seed_keyword: true
    MentionCarouselSerpElementItem:
      type: object
      allOf:
        - type: object
          oneOf:
            - $ref: '#/components/schemas/BaseSerpApiElementItem'
          nullable: true
        - type: object
          properties:
            rank_group:
              type: integer
              description: "group rank in SERP\nposition within a group of elements with identical type values;\npositions of elements with different type values are omitted from rank_group;\nalways equals 0 for desktop"
              nullable: true
            rank_absolute:
              type: integer
              description: "absolute rank in SERP\nabsolute position among all the elements in SERP\nalways equals 0 for desktop"
              nullable: true
            title:
              type: string
              description: title of a given link element
              nullable: true
            items:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/MentionCarouselElement'
                nullable: true
              description: contains arrays of elements available in the list
              nullable: true
      deprecated: true
    DataforseoLabsAmazonRelatedKeywordsLiveItem:
      type: object
      properties:
        se_type:
          type: string
          description: <em>search engine type</em>
          nullable: true
        keyword_data:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AmazonKeywordData'
          description: <em>keyword data for the returned keyword</em>
          nullable: true
        depth:
          type: integer
          description: <em>keyword search depth</em>
          nullable: true
        related_keywords:
          type: array
          items:
            type: string
          description: <em>list of related keywords</em><br>represents the list of search queries which are related to the keyword returned in the array above
          nullable: true
    DataforseoLabsAmazonRelatedKeywordsLiveResultInfo:
      type: object
      properties:
        se_type:
          type: string
          description: <em>search engine type</em>
          nullable: true
        seed_keyword:
          type: string
          description: <em>keyword in a POST array</em>
          nullable: true
        seed_keyword_data:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AmazonKeywordData'
          description: <em>keyword data for the seed keyword</em><br>fields in the object are identical to that of <code>keyword_data</code>
          nullable: true
        location_code:
          type: integer
          description: <em>location code in a POST array</em>
          nullable: true
        language_code:
          type: string
          description: <em>language code in a POST array</em>
          nullable: true
        total_count:
          type: integer
          description: <em>total amount of results in our database relevant to your request</em>
          format: int64
          nullable: true
        items_count:
          type: integer
          description: <em>the number of results returned in the <code>items</code> array</em>
          format: int64
          nullable: true
        items:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/DataforseoLabsAmazonRelatedKeywordsLiveItem'
            nullable: true
          description: <em>contains objects with keywords and related data</em>
          nullable: true
    DataforseoLabsAmazonRelatedKeywordsLiveTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/DataforseoLabsAmazonRelatedKeywordsLiveResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    DataforseoLabsAmazonRelatedKeywordsLiveResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/DataforseoLabsAmazonRelatedKeywordsLiveTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    DataforseoLabsAmazonRankedKeywordsLiveRequestInfo:
      type: object
      properties:
        asin:
          type: string
          description: <em>product ID</em><br><strong>required field</strong><br><a href="https://dataforseo.com/help-center/asin-in-amazon-api" target="_blank" rel="noopener noreferrer">unique product identifier (ASIN)</a> on Amazon;<br>you can receive the <code>asin</code> parameter by making a separate request to the <a href="/v3/merchant/amazon/products/task_post/" target="_blank" rel="noopener noreferrer">Amazon Products endpoint</a>
        location_name:
          type: string
          description: '<em>full name of the location</em><br><strong>required field if don''t specify <code>location_code</code></strong><br>you can receive the list of available locations with their <code>location_name</code> by making a separate request to<br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the US, Egypt, Saudi Arabia, and the United Arab Emirates locations only;<br>example:<br><code class="long-string">United States</code>'
        location_code:
          type: integer
          description: '<em>location code</em><br><strong>required field if don''t specify <code>location_name</code></strong><br>you can receive the list of available locations with their <code>location_code</code> by making a separate request to <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the US, Egypt, Saudi Arabia, and the United Arab Emirates locations only;<br>example:<br><code class="long-string">2840</code>'
        language_name:
          type: string
          description: <em>full name of the language</em><br><strong>required field if don't specify <code>language_code</code></strong><br>you can receive the list of available languages with their <code>language_name</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class="long-string">English</code>
        language_code:
          type: string
          description: <em>language code</em><br><strong>required field if don't specify <code>language_name</code></strong><br>you can receive the list of available languages with their <code>language_code</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class="long-string">en</code>
          nullable: true
        limit:
          type: integer
          description: '<em>the maximum number of products in the results array</em><br>optional field<br>default value: <code>100</code>;<br>maximum value: <code>1000</code>'
          nullable: true
        ignore_synonyms:
          type: boolean
          description: '<em>ignore highly similar keywords</em><br>optional field<br>if set to <code class="prettyprint">true</code> only core keywords will be returned, all highly similar keywords will be excluded;  <br>default value: <code>false</code>'
          nullable: true
        filters:
          type: array
          items:
            type: object
            nullable: true
          description: '<em>array of results filtering parameters</em><br>optional field<br><strong>you can add several filters at once (8 filters maximum)</strong><br>you should set a logical operator <code>and</code>, <code>or</code> between the conditions<br>the following operators are supported:<br><code>regex</code>, <code>not_regex</code>, <code>&lt;</code>, <code>&lt;=</code>, <code>&gt;</code>, <code>&gt;=</code>, <code>=</code>, <code>&lt;&gt;</code>, <code>in</code>, <code>not_in</code>, <code>like</code>, <code>not_like</code>, <code>match</code>, <code>not_match</code><br>you can use the <code>%</code> operator with <code>like</code> and <code>not_like</code> to match any string of zero or more characters<br>example:<br><code>["keyword_data.keyword_info.search_volume","in",[100,1000]]</code>;<p>for more information about filters, please refer to <a href="/v3/dataforseo_labs/filters" target="_blank" rel="noopener noreferrer">Dataforseo Labs - Filters</a> or this <a href="https://dataforseo.com/help-center/how-to-use-filters-in-dataforseo-labs-api" rel="noopener noreferrer" target="_blank">help center guide</a>'
          nullable: true
        order_by:
          type: array
          items:
            type: string
          description: '<em>results sorting rules</em><br>optional field<br>you can use the same values as in the <code>filters</code> array to sort the results<br>possible sorting types:<br><code>asc</code> - results will be sorted in the ascending order<br><code>desc</code> - results will be sorted in the descending order<br>you should use a comma to set up a sorting parameter<br>example:<br><code>["keyword_data.keyword_info.competition,desc"]</code><br>default rule:<br><code>["ranked_serp_element.serp_item.rank_group,asc"]</code><br><strong>note that you can set no more than three sorting rules in a single request</strong><br>you should use a comma to separate several sorting rules<br>example:<br><code>["keyword_data.keyword_info.search_volume,desc","keyword_data.keyword_info.cpc,desc"]</code>'
          nullable: true
        offset:
          type: integer
          description: '<em>offset in the results array of returned keywords</em><br>optional field<br>default value: <code>0</code><br>if you specify the <code>10</code> value, the first ten keywords in the results array will be omitted and the data will be provided for the successive keywords'
          nullable: true
        tag:
          type: string
          description: <em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response
          nullable: true
      example:
        - asin: B00R92CL5E
          location_code: 2840
          language_code: en
    AmazonInfo:
      type: object
      properties:
        se_type:
          type: string
          description: <em>search engine type</em>
          nullable: true
        type:
          type: string
          description: type of element
          nullable: true
        rank_group:
          type: integer
          description: <em>position within a group of elements with identical <code>type</code> values</em><br>positions of elements with different <code>type</code> values are omitted from <code>rank_group</code>
          nullable: true
        rank_absolute:
          type: integer
          description: <em>absolute rank in Amazon SERP</em><br>absolute position among all the elements in SERP
          nullable: true
        position:
          type: string
          description: '<em>the alignment of the element in Amazon SERP</em><br>can take the following values:<br><code>left</code>, <code>right</code>'
          nullable: true
        xpath:
          type: string
          description: <em>the <a href="https://en.wikipedia.org/wiki/XPath">XPath</a> of the element</em>
          nullable: true
        domain:
          type: string
          description: <em>Amazon domain</em>
          nullable: true
        title:
          type: string
          description: <em>product title</em>
          nullable: true
        url:
          type: string
          description: <em>URL of the product page</em>
          nullable: true
        asin:
          type: string
          description: <em>ASIN in a POST array</em>
          nullable: true
        image_url:
          type: string
          description: <em>URL of the product image featured in the results</em>
          nullable: true
        price_from:
          type: number
          description: <em>the regular price of a product</em><br>example:<br><code>49.98</code>
          nullable: true
        price_to:
          type: number
          description: <em>the upper limit of the product price range</em><br>example:<br><code>384.99</code>
          nullable: true
        currency:
          type: string
          description: <em>currency in the <a href="https://en.wikipedia.org/wiki/ISO_4217">ISO</a> format</em><br>example:<br><code>USD</code>
          nullable: true
        special_offers:
          type: array
          items:
            type: string
            nullable: true
          description: '<em>special offer details</em><br>contains special offer details, including coupon and Subscribe & Save discounts'
          nullable: true
        is_best_seller:
          type: boolean
          description: '<em>"Best Seller" label</em><br>if the value is <code>true</code>, the product is marked with the "Best Seller" label'
          nullable: true
        is_amazon_choice:
          type: boolean
          description: '<em>"Amazon''s choice" label</em><br>if the value is <code>true</code>, the product is marked with the "Amazon''s choice" label'
          nullable: true
        rating:
          type: object
          oneOf:
            - $ref: '#/components/schemas/RatingInfo'
          properties:
            value:
              type: number
              description: the value of the rating
              format: float
              nullable: true
          description: <em>the item's rating </em><br>the popularity rate based on reviews and displayed in SERP
          nullable: true
        delivery_info:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AmazonDeliveryInfo'
          description: <em>delivery information</em><br>delivery information including free and fast delivery date ranges
          nullable: true
        bought_past_month:
          type: integer
          nullable: true
    AmazonRankedSerpElement:
      type: object
      properties:
        se_type:
          type: string
          description: <em>search engine type</em>
          nullable: true
        serp_item:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AmazonInfo'
          description: <em>contains data on the SERP element</em><br>the list of supported SERP elements can be found below
          nullable: true
        check_url:
          type: string
          description: <em>direct URL to Amazon results</em><br>you can use it to make sure that we provided accurate results
          nullable: true
        serp_item_types:
          type: array
          items:
            type: string
            nullable: true
          description: '<em>direct URL to Amazon results</em><br>contains types of all search results (<code>items</code>) found in the returned SERP;<br>possible item types:<br><code>amazon_serp</code>, <code>amazon_paid</code>, <code>editorial_recommendations</code>, <code>top_rated_from_our_brands</code>, <code>related_searches</code>'
          nullable: true
        se_results_count:
          type: integer
          description: <em>total number of results in Amazon SERP</em>
          format: int64
          nullable: true
        last_updated_time:
          type: string
          description: '<em>date and time when keyword data was updated</em><br>in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”;<br>example:<br><code class="long-string">2019-11-15 12:57:46 +00:00</code>'
          nullable: true
        previous_updated_time:
          type: string
          description: '<em>previous to the most recent update of SERP data</em><br>in the <a href="https://en.wikipedia.org/wiki/ISO_8601">ISO 860</a>1 format: “YYYY-MM-DDThh:mm:ss.sssssssZ”<br>example:<br><code class="long-string">2020-09-12T00:07:43.0733218Z</code>'
          nullable: true
    DataforseoLabsAmazonRankedKeywordsLiveItem:
      type: object
      properties:
        se_type:
          type: string
          description: <em>search engine type</em>
          nullable: true
        keyword_data:
          type: object
          oneOf:
            - $ref: '#/components/schemas/KeywordDataInfo'
          description: <em>keyword data for the returned keyword</em>
          nullable: true
        ranked_serp_element:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AmazonRankedSerpElement'
          description: <em>contains data on the products's SERP element found for the returned <code>keyword</code></em>
          nullable: true
    DataforseoLabsAmazonRankedKeywordsLiveResultInfo:
      type: object
      properties:
        se_type:
          type: string
          description: <em>search engine type</em>
          nullable: true
        asin:
          type: string
          description: <em>ASIN in a POST array</em>
          nullable: true
        location_code:
          type: integer
          description: '<em>location code in a POST array</em><br>if there is no data, then the value is <code>null</code>'
          nullable: true
        language_code:
          type: string
          description: '<em>language code in a POST array</em><br>if there is no data, then the value is <code>null</code>'
          nullable: true
        total_count:
          type: integer
          description: <em>total amount of results in our database relevant to your request</em>
          format: int64
          nullable: true
        items_count:
          type: integer
          description: <em>the number of results returned in the <code>items</code> array</em>
          format: int64
          nullable: true
        items:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/DataforseoLabsAmazonRankedKeywordsLiveItem'
            nullable: true
          description: <em>contains detected Amazon product competitors and related data</em>
          nullable: true
    DataforseoLabsAmazonRankedKeywordsLiveTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/DataforseoLabsAmazonRankedKeywordsLiveResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    DataforseoLabsAmazonRankedKeywordsLiveResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/DataforseoLabsAmazonRankedKeywordsLiveTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    DataforseoLabsAmazonProductRankOverviewLiveRequestInfo:
      type: object
      properties:
        asins:
          type: array
          items:
            type: string
          description: <em>product IDs to compare</em><br><strong>required field</strong><br>product IDs to receive ranking data for;<br><strong>the maximum number of ASINs you can specify in this array is 1000;</strong><br>you can receive the <code>asin</code> parameter by making a separate request to the <a href="/v3/merchant/amazon/products/task_post/" target="_blank" rel="noopener noreferrer">Amazon Products endpoint</a><p><strong>Note:</strong> all letters in ASIN code must be specified in uppercase format;<br>example:<br><code>B01LW2SL7R</code>
        location_name:
          type: string
          description: '<em>full name of the location</em><br><strong>required field if don''t specify <code>location_code</code></strong><br>you can receive the list of available locations with their <code>location_name</code> by making a separate request to <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the US, Egypt, Saudi Arabia, and the United Arab Emirates locations only;<br>example:<br><code class="long-string">United States</code>'
        location_code:
          type: integer
          description: '<em>location code</em><br><strong>required field if don''t specify <code>location_name</code></strong><br>you can receive the list of available locations with their <code>location_code</code> by making a separate request to <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the US, Egypt, Saudi Arabia, and the United Arab Emirates locations only;<br>example:<br><code class="long-string">2840</code>'
        language_name:
          type: string
          description: <em>full name of the language</em><br><strong>required field if don't specify <code>language_code</code></strong><br>you can receive the list of available languages with their <code>language_name</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class="long-string">English</code>
        language_code:
          type: string
          description: <em>language code</em><br><strong>required field if don't specify <code>language_name</code></strong><br>you can receive the list of available languages with their <code>language_code</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class="long-string">en</code>
          nullable: true
        tag:
          type: string
          description: <em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response
          nullable: true
      example:
        - asins:
            - B001TJ3HUG
            - B01LW2SL7R
          language_name: English
          location_code: 2840
    AppMetricsInfo:
      type: object
      properties:
        pos_1:
          type: integer
          description: '<em>number of organic SERPs where the product ranks #1</em>'
          nullable: true
        pos_2_3:
          type: integer
          description: '<em>number of organic SERPs where the product ranks #2-3</em>'
          nullable: true
        pos_4_10:
          type: integer
          description: '<em>number of organic SERPs where the product ranks #4-10</em>'
          nullable: true
        pos_11_100:
          type: integer
          description: '<em>number of organic SERPs where the product ranks #11-100</em>'
          nullable: true
        count:
          type: integer
          description: <em>total count of Amazon organic SERPs that contain the product</em>
          format: int64
          nullable: true
        search_volume:
          type: integer
          description: <em>total search volume of the product's ranking keywords in organic SERP</em>
          format: int64
          nullable: true
    AmazonMetricsBundleInfo:
      type: object
      properties:
        amazon_serp:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppMetricsInfo'
          description: <em>ranking data from Amazon organic SERP</em>
          nullable: true
        amazon_paid:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppMetricsInfo'
          description: <em>ranking data from Amazon paid SERP</em>
          nullable: true
    DataforseoLabsAmazonProductRankOverviewLiveItem:
      type: object
      properties:
        se_type:
          type: string
          description: <em>search engine type</em>
          nullable: true
        asin:
          type: string
          description: '<em>ASIN of the product</em><br>unique product identifier on Amazon;<br>for more information, refer to <a href="https://dataforseo.com/help-center/asin-in-amazon-api" rel="noopener noreferrer" target="_blank">this help center guide</a>'
          nullable: true
        metrics:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AmazonMetricsBundleInfo'
          description: <em>average keyword position of the product</em>
          nullable: true
    DataforseoLabsAmazonProductRankOverviewLiveResultInfo:
      type: object
      properties:
        se_type:
          type: string
          description: <em>search engine type</em>
          nullable: true
        location_code:
          type: integer
          description: '<em>location code in a POST array</em><br>if there is no data, then the value is_<code>null</code>n'
          nullable: true
        language_code:
          type: string
          description: '<em>language code in a POST array</em><br>if there is no data, then the value is_<code>null</code>n'
          nullable: true
        total_count:
          type: integer
          description: <em>total amount of results in our database relevant to your request</em>
          format: int64
          nullable: true
        items_count:
          type: integer
          description: <em>the number of results returned in the <code>items</code> array</em>
          format: int64
          nullable: true
        items:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/DataforseoLabsAmazonProductRankOverviewLiveItem'
            nullable: true
          description: <em>contains detected Amazon product competitors and related data</em>
          nullable: true
    DataforseoLabsAmazonProductRankOverviewLiveTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/DataforseoLabsAmazonProductRankOverviewLiveResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    DataforseoLabsAmazonProductRankOverviewLiveResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/DataforseoLabsAmazonProductRankOverviewLiveTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    DataforseoLabsAmazonProductCompetitorsLiveRequestInfo:
      type: object
      properties:
        asin:
          type: string
          description: <em>product ID</em><br><strong>required field</strong><br><a href="https://dataforseo.com/help-center/asin-in-amazon-api" target="_blank" rel="noopener noreferrer">unique product identifier (ASIN)</a> on Amazon;<br>you can receive the <code>asin</code> parameter by making a separate request to the <a href="/v3/merchant/amazon/products/task_post/" target="_blank" rel="noopener noreferrer">Amazon Products endpoint</a>
        location_name:
          type: string
          description: '<em>full name of the location</em><br><strong>required field if don''t specify <code>location_code</code></strong><br>you can receive the list of available locations with their <code>location_name</code> by making a separate request to <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the US, Egypt, Saudi Arabia, and the United Arab Emirates locations only;<br>example:<br><code class="long-string">United States</code>'
        location_code:
          type: integer
          description: '<em>location code</em><br><strong>required field if don''t specify <code>location_name</code></strong><br>you can receive the list of available locations with their <code>location_code</code> by making a separate request to <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the US, Egypt, Saudi Arabia, and the United Arab Emirates locations only;<br>example:<br><code class="long-string">2840</code>'
        language_name:
          type: string
          description: <em>full name of the language</em><br><strong>required field if don't specify <code>language_code</code></strong><br>you can receive the list of available languages with their <code>language_name</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class="long-string">English</code>
        language_code:
          type: string
          description: <em>language code</em><br><strong>required field if don't specify <code>language_name</code></strong><br>you can receive the list of available languages with their <code>language_code</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class="long-string">en</code>
          nullable: true
        limit:
          type: integer
          description: '<em>the maximum number of products in the results array</em><br>optional field<br>default value: <code>100</code>;<br>maximum value: <code>1000</code>'
          nullable: true
        filters:
          type: array
          items:
            type: object
            nullable: true
          description: '<em>array of results filtering parameters</em><br>optional field<br><strong>you can add several filters at once (8 filters maximum)</strong><br>you should set a logical operator <code>and</code>, <code>or</code> between the conditions<br>the following operators are supported:<br><code>regex</code>, <code>not_regex</code>, <code>&lt;</code>, <code>&lt;=</code>, <code>&gt;</code>, <code>&gt;=</code>, <code>=</code>, <code>&lt;&gt;</code>, <code>in</code>, <code>not_in</code>, <code>ilike</code>, <code>not_ilike</code>, <code>like</code>, <code>not_like</code>, <code>match</code>, <code>not_match</code><br>you can use the <code>%</code> operator with <code>like</code> and <code>not_like</code>, as well as <code>ilike</code> and <code>not_ilike</code> to match any string of zero or more characters<br>example:<br><code>["full_metrics.amazon_serp.pos_1","&gt;", 20]</code><p>for more information about filters, please refer to <a href="/v3/dataforseo_labs/filters" target="_blank" rel="noopener noreferrer">Dataforseo Labs - Filters</a> or this <a href="https://dataforseo.com/help-center/how-to-use-filters-in-dataforseo-labs-api" rel="noopener noreferrer" target="_blank">help center guide</a>'
          nullable: true
        order_by:
          type: array
          items:
            type: string
          description: '<em>results sorting rules</em><br>optional field<br>you can use the same values as in the <code>filters</code> array to sort the results<br>possible sorting types:<br><code>asc</code> - results will be sorted in the ascending order<br><code>desc</code> - results will be sorted in the descending order<br>you should use a comma to set up a sorting parameter<br>example:<br><code>["full_metrics.amazon_serp.pos_1,desc"]</code><br><strong>note that you can set no more than three sorting rules in a single request</strong><br>you should use a comma to separate several sorting rules<br>example:<br><code>["full_metrics.amazon_serp.pos_1,desc","avg_position,desc"]</code><br>default rule:<br><code>["ranked_serp_element.serp_item.rank_group,asc"]</code>'
          nullable: true
        offset:
          type: integer
          description: '<em>offset in the results array of returned product competitors</em><br>optional field<br>default value: <code>0</code><br>if you specify the <code>10</code> value, the first ten product competitors in the results array will be omitted and the data will be provided for the successive product competitors'
          nullable: true
        tag:
          type: string
          description: <em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response
          nullable: true
      example:
        - asin: 019005476X
          location_code: 2840
          language_code: en
    DataforseoLabsAmazonProductCompetitorsLiveItem:
      type: object
      properties:
        se_type:
          type: string
          description: <em>search engine type</em>
          nullable: true
        asin:
          type: string
          description: <em>ASIN in a POST array</em>
          nullable: true
        avg_position:
          type: number
          description: <em>average position of the product in Amazon SERP</em><br><strong>Note:</strong> average position is calculated for intersected keywords only;<br>the value for a given product may differ when combined with different target products
          format: float
          nullable: true
        sum_position:
          type: integer
          description: <em>sum of all product positions in Amazon SERP</em><br><strong>Note:</strong> average position is calculated for intersected keywords only;<br>the value for a given product may differ when combined with different target products
          nullable: true
        intersections:
          type: integer
          description: <em>number of intersecting keywords</em>
          nullable: true
        competitor_metrics:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AmazonMetricsBundleInfo'
          description: <em>metrics for intersecting keywords</em><br>ranking data relevant to the keywords that the provided <code>asin</code> shares with the target <code>asin</code>;<br><strong>Note:</strong> in this object ranking data is provided for the returned competitor's <code>asin</code>
          nullable: true
        full_metrics:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AmazonMetricsBundleInfo'
          description: <em>metrics for all keywords of the product</em><br>full overview of ranking data relevant to all keywords that the provided <code>asin</code> is ranking for
          nullable: true
    DataforseoLabsAmazonProductCompetitorsLiveResultInfo:
      type: object
      properties:
        se_type:
          type: string
          description: <em>search engine type</em>
          nullable: true
        asin:
          type: string
          description: <em>ASIN in a POST array</em>
          nullable: true
        location_code:
          type: integer
          description: '<em>location code in a POST array</em><br>if there is no data, then the value is_<code>null</code>'
          nullable: true
        language_code:
          type: string
          description: '<em>language code in a POST array</em><br>if there is no data, then the value is_<code>null</code>'
          nullable: true
        total_count:
          type: integer
          description: <em>total amount of results in our database relevant to your request</em>
          format: int64
          nullable: true
        items_count:
          type: integer
          description: <em>the number of results returned in the <code>items</code> array</em>
          format: int64
          nullable: true
        items:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/DataforseoLabsAmazonProductCompetitorsLiveItem'
            nullable: true
          description: <em>contains detected Amazon product competitors and related data</em>
          nullable: true
    DataforseoLabsAmazonProductCompetitorsLiveTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/DataforseoLabsAmazonProductCompetitorsLiveResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    DataforseoLabsAmazonProductCompetitorsLiveResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/DataforseoLabsAmazonProductCompetitorsLiveTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    DataforseoLabsAmazonProductKeywordIntersectionsLiveRequestInfo:
      type: object
      properties:
        asins:
          type: object
          additionalProperties:
            type: string
            nullable: true
          description: '<em>asins of target products</em><br><strong>required field</strong><br>product IDs of the products for which you need to find keyword intersections;<br>specify the ASINs as in the following example:<br><code>"asins": {<br>"1": "019005476X",<br>"2": "0190074442"<br>}</code><br><strong>the maximum number of ASINs you can specify in this object is 20;</strong><br>learn more about the parameter on <a href="https://dataforseo.com/help-center/how-to-get-amazon-product-data-using-asin" rel="noopener noreferrer" target="_blank">this help center page</a>'
          nullable: true
        location_name:
          type: string
          description: '<em>full name of the location</em><br><strong>required field if don''t specify <code>location_code</code></strong><br>you can receive the list of available locations with their <code>location_name</code> by making a separate request to <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the US, Egypt, Saudi Arabia, and the United Arab Emirates locations only;<br>example:<br><code class="long-string">United Kingdom</code>'
        location_code:
          type: integer
          description: '<em>location code</em><br><strong>required field if don''t specify <code>location_name</code></strong><br>you can receive the list of available locations with their <code>location_code</code> by making a separate request to<br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the US, Egypt, Saudi Arabia, and the United Arab Emirates locations only;<br>example:<br><code class="long-string">2840</code>'
        language_name:
          type: string
          description: <em>full name of the language</em><br><strong>required field if don't specify <code>language_code</code></strong><br>you can receive the list of available languages with their <code>language_name</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class="long-string">English</code>
        language_code:
          type: string
          description: <em>language code</em><br><strong>required field if don't specify <code>language_name</code></strong><br>you can receive the list of available languages with their <code>language_code</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class="long-string">en</code>
          nullable: true
        limit:
          type: integer
          description: '<em>the maximum number of products in the results array</em><br>optional field<br>default value: <code>100</code>;<br>maximum value: <code>1000</code>'
          nullable: true
        intersection_mode:
          type: string
          description: '<em>mode for finding asin intersections</em><br>optional field<br>possible values: <code>union</code>, <code>intersect</code>;<br>default value: <code>intersect</code>;<br>learn more about the parameter in <a href="https://dataforseo.com/help-center/what-is-intersection-mode-in-amazon-keyword-intersections-endpoint" rel="noopener noreferrer" target="_blank">this help center guide</a>'
          nullable: true
        filters:
          type: array
          items:
            type: object
            nullable: true
          description: '<em>array of results filtering parameters</em><br>optional field<br><strong>you can add several filters at once (8 filters maximum)</strong><br>you should set a logical operator <code>and</code>, <code>or</code> between the conditions<br>the following operators are supported:<br><code>regex</code>, <code>not_regex</code>, <code>&lt;</code>, <code>&lt;=</code>, <code>&gt;</code>, <code>&gt;=</code>, <code>=</code>, <code>&lt;&gt;</code>, <code>in</code>, <code>not_in</code>, <code>ilike</code>, <code>not_ilike</code>, <code>like</code>, <code>not_like</code>, <code>match</code>, <code>not_match</code><br>you can use the <code>%</code> operator with <code>like</code> and <code>not_like</code>, as well as <code>ilike</code> and <code>not_ilike</code> to match any string of zero or more characters<br>example:<br><code>["avg_position","&lt;", 10]</code><p>for more information about filters, please refer to <a href="/v3/dataforseo_labs/filters" target="_blank" rel="noopener noreferrer">Dataforseo Labs - Filters</a> or this <a href="https://dataforseo.com/help-center/how-to-use-filters-in-dataforseo-labs-api" rel="noopener noreferrer" target="_blank">help center guide</a>'
          nullable: true
        order_by:
          type: array
          items:
            type: string
          description: '<em>results sorting rules</em><br>optional field<br>you can use the same values as in the <code>filters</code> array to sort the results<br>possible sorting types:<br><code>asc</code> - results will be sorted in the ascending order<br><code>desc</code> - results will be sorted in the descending order<br>you should use a comma to set up a sorting parameter<br>example:<br><code>["sum_position,desc"]</code><br><strong>note that you can set no more than three sorting rules in a single request</strong><br>you should use a comma to separate several sorting rules<br>example:<br><code>["intersections,desc","avg_position,asc"]</code><br>default rule:<br><code>["intersections,desc"]</code>'
          nullable: true
        offset:
          type: integer
          description: '<em>offset in the results array of returned keywords</em><br>optional field<br>default value: <code>0</code><br>if you specify the <code>10</code> value, the first ten keywords in the results array will be omitted and the data will be provided for the successive keywords'
          nullable: true
        tag:
          type: string
          description: <em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response
          nullable: true
      example:
        - asins:
            '1': B09172433Z
            '2': B07GBZ4Q68
            '3': B07GCKQD77
          language_name: English
          location_code: 2840
    DataforseoLabsAmazonProductKeywordIntersectionsLiveItem:
      type: object
      properties:
        se_type:
          type: string
          description: <em>search engine type</em>
          nullable: true
        keyword_data:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AmazonKeywordData'
          description: <em>keyword data for the returned keyword</em>
          nullable: true
        intersection_result:
          type: object
          additionalProperties:
            type: object
            oneOf:
              - $ref: '#/components/schemas/AmazonInfo'
            nullable: true
          description: <em>data on the intersection</em>
          nullable: true
    DataforseoLabsAmazonProductKeywordIntersectionsLiveResultInfo:
      type: object
      properties:
        se_type:
          type: string
          description: <em>search engine type</em>
          nullable: true
        asins:
          type: object
          additionalProperties:
            type: string
            nullable: true
          description: <em>ASINs in a POST array</em>
          nullable: true
        location_code:
          type: integer
          description: '<em>location code in a POST array</em><br>if there is no data, then the value is_<code>null</code>'
          nullable: true
        language_code:
          type: string
          description: '<em>language code in a POST array</em><br>if there is no data, then the value is_<code>null</code>'
          nullable: true
        total_count:
          type: integer
          description: <em>total amount of results in our database relevant to your request</em>
          format: int64
          nullable: true
        items_count:
          type: integer
          description: <em>the number of results returned in the <code>items</code> array</em>
          format: int64
          nullable: true
        items:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/DataforseoLabsAmazonProductKeywordIntersectionsLiveItem'
            nullable: true
          description: <em>contains detected Amazon product competitors and related data</em>
          nullable: true
    DataforseoLabsAmazonProductKeywordIntersectionsLiveTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/DataforseoLabsAmazonProductKeywordIntersectionsLiveResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    DataforseoLabsAmazonProductKeywordIntersectionsLiveResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/DataforseoLabsAmazonProductKeywordIntersectionsLiveTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    DataforseoLabsGoogleBulkAppMetricsLiveRequestInfo:
      type: object
      properties:
        app_ids:
          type: array
          items:
            type: string
          description: <em>ids of the app</em><br><strong>required field</strong><br>IDs of the mobile applications on Google Play;<br>you can find the ID in the URL of every app listed on Google Play;<br>example:<br>in the URL <code>https://play.google.com/store/apps/details?id=org.telegram.messenger</code><br>the id is <code>org.telegram.messenger</code>;<br>the maximum number of IDs you can specify in this field is <code>1000</code>
        location_name:
          type: string
          description: <em>full name of the location</em><br><strong>required field if you don't specify</strong> <code>location_code</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_name</code> by making a separate request to <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the US location only;<br>example:<br><code class="long-string">United States</code>
        location_code:
          type: integer
          description: <em>location code</em><br><strong>required field if you don't specify</strong> <code>location_name</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_code</code> by making a separate request to <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the US location only;<br>example:<br><code class="long-string">2840</code>
        language_name:
          type: string
          description: <em>full name of the language</em><br><strong>required field if you don't specify</strong> <code>language_code</code><br><strong>Note:</strong> it is required to specify either <code>language_name</code> or <code>language_code</code><br>you can receive the list of available languages with their <code>language_name</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the English language only;<br>example:<br><code class="long-string">English</code>
        language_code:
          type: string
          description: <em>language code</em><br><strong>required field if you don't specify</strong> <code>language_name</code><br><strong>Note:</strong> it is required to specify either <code>language_name</code> or <code>language_code</code><br>you can receive the list of available languages with their <code>language_code</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the English language only<br>example:<br><code class="long-string">en</code>
          nullable: true
        tag:
          type: string
          description: <em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response
          nullable: true
      example:
        - app_ids:
            - org.telegram.messenger
            - com.zhiliaoapp.musically
          language_name: English
          location_code: 2840
    DataforseoLabsleBulkAppMetricsLiveItem:
      type: object
      properties:
        se_type:
          type: string
          description: <em>search engine type</em>
          nullable: true
        app_id:
          type: string
          description: <em>id of the app in a POST array</em>
          nullable: true
        metrics:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/AppMetricsInfo'
          description: <em>metrics for the ranking keywords of the app</em><br>ranking data relevant to the keywords that the provided application ranks for on Google Play
          nullable: true
    DataforseoLabsGoogleBulkAppMetricsLiveResultInfo:
      type: object
      properties:
        se_type:
          type: string
          description: <em>search engine type</em>
          nullable: true
        location_code:
          type: integer
          description: <em>location code in a POST array</em>
          nullable: true
        language_code:
          type: string
          description: <em>language code in a POST array</em>
          nullable: true
        total_count:
          type: integer
          description: <em>total amount of results in our database relevant to your request</em>
          format: int64
          nullable: true
        items_count:
          type: integer
          description: <em>the number of results returned in the <code>items</code> array</em>
          format: int64
          nullable: true
        items:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/DataforseoLabsleBulkAppMetricsLiveItem'
            nullable: true
          description: <em>contains data related to the ranking app metrics of the specified application
          nullable: true
    DataforseoLabsGoogleBulkAppMetricsLiveTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/DataforseoLabsGoogleBulkAppMetricsLiveResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    DataforseoLabsGoogleBulkAppMetricsLiveResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/DataforseoLabsGoogleBulkAppMetricsLiveTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    DataforseoLabsGoogleKeywordsForAppLiveRequestInfo:
      type: object
      properties:
        app_id:
          type: string
          description: <em>id of the apps</em><br><strong>required field</strong><br>ID of the mobile application on Google Play;<br>you can find the ID in the URL of every app listed on Google Play;<br>example:<br>in the URL <code>https://play.google.com/store/apps/details?id=org.telegram.messenger</code><br>the id is <code>org.telegram.messenger</code>
        location_name:
          type: string
          description: <em>full name of the location</em><br><strong>required field if you don't specify</strong> <code>location_code</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_name</code> by making a separate request to <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the US location only;<br>example:<br><code class="long-string">United States</code>
        location_code:
          type: integer
          description: <em>location code</em><br><strong>required field if you don't specify</strong> <code>location_name</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_code</code> by making a separate request to <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the US location only;<br>example:<br><code class="long-string">2840</code>
        language_name:
          type: string
          description: <em>full name of the language</em><br><strong>required field if you don't specify</strong> <code>language_code</code><br><strong>Note:</strong> it is required to specify either <code>language_name</code> or <code>language_code</code><br>you can receive the list of available languages with their <code>language_name</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the English language only;<br>example:<br><code class="long-string">English</code>
        language_code:
          type: string
          description: <em>language code</em><br><strong>required field if you don't specify</strong> <code>language_name</code><br><strong>Note:</strong> it is required to specify either <code>language_name</code> or <code>language_code</code><br>you can receive the list of available languages with their <code>language_code</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the English language only<br>example:<br><code class="long-string">en</code>
          nullable: true
        filters:
          type: array
          items:
            type: object
            nullable: true
          description: '<em>array of results filtering parameters</em><br>optional field<br><strong>you can add several filters at once (8 filters maximum)</strong><br>you should set a logical operator <code>and</code>, <code>or</code> between the conditions<br>the following operators are supported:<br><code>&lt;</code>, <code>&lt;=</code>, <code>&gt;</code>, <code>&gt;=</code>, <code>=</code>, <code>&lt;&gt;</code>, <code>in</code>, <code>not_in</code><br>example:<br><code>["keyword_data.keyword_info.search_volume","&gt;",500]</code><p><code>[["keyword_data.keyword_info.search_volume","&lt;&gt;",500],"and",["ranked_serp_element.serp_item.rank_group","&gt;=","10"]]</code><p>for more information about filters, please refer to <a href="/v3/dataforseo_labs/filters" target="_blank" rel="noopener noreferrer">Dataforseo Labs - Filters</a> or this <a href="https://dataforseo.com/help-center/how-to-use-filters-in-dataforseo-labs-api" rel="noopener noreferrer" target="_blank">help center guide</a>'
          nullable: true
        order_by:
          type: array
          items:
            type: string
          description: '<em>results sorting rules</em><br>optional field<br>you can use the same values as in the <code>filters</code> array to sort the results;<br>possible sorting types:<br><code>asc</code> - results will be sorted in the ascending order;<br><code>desc</code> - results will be sorted in the descending order;<br>you should use a comma to specify a sorting type;<br>example:<br><code>["ranked_serp_element.serp_item.rank_group,asc"]</code><br><strong>Note:</strong> you can set no more than three sorting rules in a single request;<br>you should use a comma to separate several sorting rules;<br>example:<br><code>["ranked_serp_element.serp_item.rank_group,desc","keyword_data.keyword_info.search_volume,asc"]</code><br>default rule:<br><code>["keyword_data.keyword_info.search_volume,desc"]</code><br><strong>Note:</strong> if the <code>item_types</code> array contains item types that are different from <code>organic</code>, the results will be ordered by the first item type in the array'
          nullable: true
        limit:
          type: integer
          description: '<em>the maximum number of returned keywords</em><br>optional field<br>default value: <code>100</code><br>maximum value: <code>1000</code>'
          nullable: true
        offset:
          type: integer
          description: '<em>offset in the results array of returned keywords</em><br>optional field<br>default value: <code>0</code><br>if you specify the <code>10</code> value, the first ten keywords in the results array will be omitted and the data will be provided for the successive keywords'
          nullable: true
        tag:
          type: string
          description: <em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response
          nullable: true
      example:
        - app_id: org.telegram.messenger
          language_name: English
          location_code: 2840
          limit: 10
    GooglePlaySearchOrganic:
      type: object
      properties:
        type:
          type: string
          description: type of element
          nullable: true
        rank_group:
          type: integer
          description: <em>position within a group of elements with identical <code>type</code> values</em><br>positions of elements with different <code>type</code> values are omitted from <code>rank_group</code>
          nullable: true
        rank_absolute:
          type: integer
          description: <em>absolute rank in SERP</em><br>absolute position among all the elements in SERP
          nullable: true
        position:
          type: string
          description: '<em>the alignment of the element in SERP</em><br>can take the following values:<br><code>left</code>, <code>right</code>'
          nullable: true
        app_id:
          type: string
          description: <em>id of the app in a POST array</em>
          nullable: true
        title:
          type: string
          description: <em>title of the app</em>
          nullable: true
        url:
          type: string
          description: <em>URL to the app page on Google Play</em>
          nullable: true
        icon:
          type: string
          description: <em>URL to the app icon</em>
          nullable: true
        reviews_count:
          type: integer
          description: <em>the total number of reviews of the app</em>
          format: int64
          nullable: true
        rating:
          type: object
          oneOf:
            - $ref: '#/components/schemas/RatingInfo'
          description: <em>average rating of the app</em>
          nullable: true
        is_free:
          type: boolean
          nullable: true
        price:
          type: object
          oneOf:
            - $ref: '#/components/schemas/PriceInfo'
          nullable: true
        developer:
          type: string
          description: <em>name of the app developer</em>
          nullable: true
        developer_url:
          type: string
          description: <em>URL to the developer page on Google Play</em>
          nullable: true
    GooglePlayRankedSerpElementInfo:
      type: object
      properties:
        se_type:
          type: string
          description: <em>search engine type</em>
          nullable: true
        serp_item:
          type: object
          oneOf:
            - $ref: '#/components/schemas/GooglePlaySearchOrganic'
          description: <em>contains data on the SERP element</em><br>the list of supported SERP elements can be found below
          nullable: true
        check_url:
          type: string
          description: <em>direct URL to search engine results</em><br>you can use it to make sure that we provided accurate results
          nullable: true
        se_results_count:
          type: integer
          description: <em>number of search results for the returned keyword</em>
          nullable: true
        last_updated_time:
          type: string
          description: '<em>date and time when keyword data was updated</em><br>in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”;<br>example:<br><code class="long-string">2019-11-15 12:57:46 +00:00</code>'
          nullable: true
        previous_updated_time:
          type: string
          description: '<em>previous to the most recent date and time when SERP data was updated</em><br>in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”<br>example:<br><code class="long-string">2019-10-15 12:57:46 +00:00</code>;<br>in this case, will equal null'
          nullable: true
    DataforseoLabsGoogleKeywordsForAppLiveItem:
      type: object
      properties:
        se_type:
          type: string
          description: <em>search engine type</em>
          nullable: true
        keyword_data:
          type: object
          oneOf:
            - $ref: '#/components/schemas/KeywordDataInfo'
          description: <em>keyword data for the returned keyword</em>
          nullable: true
        ranked_serp_element:
          type: object
          oneOf:
            - $ref: '#/components/schemas/GooglePlayRankedSerpElementInfo'
          description: <em>contains data on the domain's SERP element found for the returned <code>keyword</code></em>
          nullable: true
    DataforseoLabsGoogleKeywordsForAppLiveResultInfo:
      type: object
      properties:
        se_type:
          type: string
          description: <em>search engine type</em>
          nullable: true
        app_id:
          type: string
          description: <em>id of the app in a POST array</em>
          nullable: true
        location_code:
          type: integer
          description: <em>location code in a POST array</em>
          nullable: true
        language_code:
          type: string
          description: <em>language code in a POST array</em>
          nullable: true
        total_count:
          type: integer
          description: <em>total amount of results in our database relevant to your request</em>
          format: int64
          nullable: true
        items_count:
          type: integer
          description: <em>the number of results returned in the <code>items</code> array</em>
          format: int64
          nullable: true
        items:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/DataforseoLabsGoogleKeywordsForAppLiveItem'
            nullable: true
          description: <em>contains data related to the ranking keywords for the app specified in the <code>app_id</code> field</em>
          nullable: true
    DataforseoLabsGoogleKeywordsForAppLiveTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/DataforseoLabsGoogleKeywordsForAppLiveResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    DataforseoLabsGoogleKeywordsForAppLiveResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/DataforseoLabsGoogleKeywordsForAppLiveTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    DataforseoLabsGoogleAppCompetitorsLiveRequestInfo:
      type: object
      properties:
        app_id:
          type: string
          description: <em>id of the app</em><br><strong>required field</strong><br>ID of the mobile application on Google Play;<br>you can find the ID in the URL of every app listed on Google Play;<br>example:<br>in the URL <code>https://play.google.com/store/apps/details?id=org.telegram.messenger</code><br>the id is <code>org.telegram.messenger</code>
        location_name:
          type: string
          description: <em>full name of the location</em><br><strong>required field if you don't specify</strong> <code>location_code</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_name</code> by making a separate request to <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the US location only;<br>example:<br><code class="long-string">United States</code>
        location_code:
          type: integer
          description: <em>location code</em><br><strong>required field if you don't specify</strong> <code>location_name</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_code</code> by making a separate request to <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the US location only;<br>example:<br><code class="long-string">2840</code>
        language_name:
          type: string
          description: <em>full name of the language</em><br><strong>required field if you don't specify</strong> <code>language_code</code><br><strong>Note:</strong> it is required to specify either <code>language_name</code> or <code>language_code</code><br>you can receive the list of available languages with their <code>language_name</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the English language only;<br>example:<br><code class="long-string">English</code>
        language_code:
          type: string
          description: <em>language code</em><br><strong>required field if you don't specify</strong> <code>language_name</code><br><strong>Note:</strong> it is required to specify either <code>language_name</code> or <code>language_code</code><br>you can receive the list of available languages with their <code>language_code</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the English language only<br>example:<br><code class="long-string">en</code>
          nullable: true
        filters:
          type: array
          items:
            type: object
            nullable: true
          description: '<em>array of results filtering parameters</em><br>optional field<br><strong>you can add several filters at once (8 filters maximum)</strong><br>you should set a logical operator <code>and</code>, <code>or</code> between the conditions<br>the following operators are supported:<br><code>&lt;</code>, <code>&lt;=</code>, <code>&gt;</code>, <code>&gt;=</code>, <code>=</code>, <code>&lt;&gt;</code>, <code>in</code>, <code>not_in</code><br>example:<br><code>["intersections","&gt;",500]</code><p><code>[["competitor_metrics.google_play_search_organic.pos_1","&lt;&gt;",10],"and",["avg_position","&gt;=","10"]]</code><p><code>[[["intersections","&gt;=",50],"and",["competitor_metrics.google_play_search_organic.pos_1","in",[1,5]]],<br>"or",<br>["sum_position","&gt;=","10000"]]</code><p>for more information about filters, please refer to <a href="/v3/dataforseo_labs/filters" target="_blank" rel="noopener noreferrer">Dataforseo Labs - Filters</a> or this <a href="https://dataforseo.com/help-center/how-to-use-filters-in-dataforseo-labs-api" rel="noopener noreferrer" target="_blank">help center guide</a>'
          nullable: true
        order_by:
          type: array
          items:
            type: string
          description: '<em>results sorting rules</em><br>optional field<br>you can use the same values as in the <code>filters</code> array to sort the results;<br>possible sorting types:<br><code>asc</code> - results will be sorted in the ascending order;<br><code>desc</code> - results will be sorted in the descending order;<br>you should use a comma to specify a sorting type;<br>example:<br><code>["intersections,asc"]</code><br><strong>Note:</strong> you can set no more than three sorting rules in a single request;<br>you should use a comma to separate several sorting rules;<br>example:<br><code>["intersections,desc","sum_position,asc"]</code><p>default rule:<br><code>["intersections,desc"]</code><br><strong>Note:</strong> if the <code>item_types</code> array contains item types that are different from <code>organic</code>, the results will be ordered by the first item type in the array'
          nullable: true
        limit:
          type: integer
          description: '<em>the maximum number of returned apps</em><br>optional field<br>default value: <code>100</code><br>maximum value: <code>1000</code>'
          nullable: true
        offset:
          type: integer
          description: '<em>offset in the results array of returned apps</em><br>optional field<br>default value: <code>0</code><br>if you specify the <code>10</code> value, the first ten apps in the results array will be omitted and the data will be provided for the successive keywords'
          nullable: true
        tag:
          type: string
          description: <em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response
          nullable: true
      example:
        - app_id: org.telegram.messenger
          language_name: English
          location_code: 2840
          limit: 10
    DataforseoLabsleAppCompetitorsLiveItem:
      type: object
      properties:
        se_type:
          type: string
          description: <em>search engine type</em>
          nullable: true
        app_id:
          type: string
          description: <em>id of the app in a POST array</em>
          nullable: true
        avg_position:
          type: number
          description: <em>average position of the app in Google Play SERP</em><br><strong>Note:</strong> average position is calculated for intersected keywords only;<br>the value for a given application may differ when combined with different target applications
          format: float
          nullable: true
        sum_position:
          type: integer
          description: <em>sum of all app positions in Google Play SERP</em><br><strong>Note:</strong> sum position is calculated for intersected keywords only;<br>the value for a given application may differ when combined with different target applications
          nullable: true
        intersections:
          type: integer
          description: <em>number of intersecting keywords</em>
          nullable: true
        competitor_metrics:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/AppMetricsInfo'
          description: <em>metrics for intersecting keywords</em><br>ranking data relevant to the keywords that the provided competitor application shares with the app in a POST request;<br><strong>note:</strong> in this array ranking data is provided for the returned competitor's <code>app_id</code>
          nullable: true
        full_metrics:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/AppMetricsInfo'
          description: <em>metrics for all keywords of the application</em><br>full overview of ranking data relevant to all keywords that the provided <code>app_id</code> is ranking for
          nullable: true
    DataforseoLabsGoogleAppCompetitorsLiveResultInfo:
      type: object
      properties:
        se_type:
          type: string
          description: <em>search engine type</em>
          nullable: true
        app_id:
          type: string
          description: <em>id of the app in a POST array</em>
          nullable: true
        location_code:
          type: integer
          description: <em>location code in a POST array</em>
          nullable: true
        language_code:
          type: string
          description: <em>language code in a POST array</em>
          nullable: true
        total_count:
          type: integer
          description: <em>total amount of results in our database relevant to your request</em>
          format: int64
          nullable: true
        items_count:
          type: integer
          description: <em>the number of results returned in the <code>items</code> array</em>
          format: int64
          nullable: true
        items:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/DataforseoLabsleAppCompetitorsLiveItem'
            nullable: true
          description: <em>contains data related to the <code>app_id</code> and competitor applications</em>
          nullable: true
    DataforseoLabsGoogleAppCompetitorsLiveTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/DataforseoLabsGoogleAppCompetitorsLiveResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    DataforseoLabsGoogleAppCompetitorsLiveResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/DataforseoLabsGoogleAppCompetitorsLiveTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    DataforseoLabsGoogleAppIntersectionLiveRequestInfo:
      type: object
      properties:
        app_ids:
          type: object
          additionalProperties:
            type: string
            nullable: true
          description: '<em>ids of the target apps</em><br><strong>required field</strong><br>IDs of the target mobile applications on Google Play;<br>you can find the ID in the URL of every app listed on Google Play;<br>example:<br>in the URL <code>https://play.google.com/store/apps/details?id=org.telegram.messenger</code><br>the id is <code>org.telegram.messenger</code>;;<br>the ids should be specified the following way:<br><code>"app_ids": {<br>"1": "org.telegram.messenger",<br>"2": "com.zhiliaoapp.musically"<br>}</code><br>if you specify a single ID here, the API will return results only for one application;<br>the maximum number of app IDs you can specify in this object is <code>20</code>'
          nullable: true
        location_name:
          type: string
          description: <em>full name of the location</em><br><strong>required field if you don't specify</strong> <code>location_code</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_name</code> by making a separate request to <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the US location only;<br>example:<br><code class="long-string">United States</code>
        location_code:
          type: integer
          description: <em>location code</em><br><strong>required field if you don't specify</strong> <code>location_name</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_code</code> by making a separate request to <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the US location only;<br>example:<br><code class="long-string">2840</code>
        language_name:
          type: string
          description: <em>full name of the language</em><br><strong>required field if you don't specify</strong> <code>language_code</code><br><strong>Note:</strong> it is required to specify either <code>language_name</code> or <code>language_code</code><br>you can receive the list of available languages with their <code>language_name</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the English language only;<br>example:<br><code class="long-string">English</code>
        language_code:
          type: string
          description: <em>language code</em><br><strong>required field if you don't specify</strong> <code>language_name</code><br><strong>Note:</strong> it is required to specify either <code>language_name</code> or <code>language_code</code><br>you can receive the list of available languages with their <code>language_code</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the English language only<br>example:<br><code class="long-string">en</code>
          nullable: true
        filters:
          type: array
          items:
            type: object
            nullable: true
          description: '<em>array of results filtering parameters</em><br>optional field<br><strong>you can add several filters at once (8 filters maximum)</strong><br>you should set a logical operator <code>and</code>, <code>or</code> between the conditions<br>the following operators are supported:<br><code>&lt;</code>, <code>&lt;=</code>, <code>&gt;</code>, <code>&gt;=</code>, <code>=</code>, <code>&lt;&gt;</code>, <code>in</code>, <code>not_in</code><br>example:<br><code>["keyword_data.keyword_info.search_volume","&gt;",500]</code><p><code>[["keyword_data.keyword_info.search_volume","&lt;&gt;",500],"and",[intersection_result.382617920.rank_group","&gt;=","10"]]</code><p>for more information about filters, please refer to <a href="/v3/dataforseo_labs/filters" target="_blank" rel="noopener noreferrer">Dataforseo Labs - Filters</a> or this <a href="https://dataforseo.com/help-center/how-to-use-filters-in-dataforseo-labs-api" rel="noopener noreferrer" target="_blank">help center guide</a>'
          nullable: true
        order_by:
          type: array
          items:
            type: string
          description: '<em>results sorting rules</em><br>optional field<br>you can use the same values as in the <code>filters</code> array to sort the results;<br>possible sorting types:<br><code>asc</code> - results will be sorted in the ascending order;<br><code>desc</code> - results will be sorted in the descending order;<br>you should use a comma to specify a sorting type;<br>example:<br><code>["intersection_result.382617920.rank_absolute,asc"]</code><br><strong>Note:</strong> you can set no more than three sorting rules in a single request;<br>you should use a comma to separate several sorting rules;<br>example:<br><code>["intersection_result.382617920.rank_absolute,desc","keyword_data.keyword_info.search_volume,asc"]</code><br>default rule:<br><code>["keyword_data.keyword_info.search_volume,desc"]</code><br><strong>Note:</strong> if the <code>item_types</code> array contains item types that are different from <code>organic</code>, the results will be ordered by the first item type in the array'
          nullable: true
        limit:
          type: integer
          description: '<em>the maximum number of returned keywords</em><br>optional field<br>default value: <code>100</code><br>maximum value: <code>1000</code>'
          nullable: true
        offset:
          type: integer
          description: '<em>offset in the results array of returned keywords</em><br>optional field<br>default value: <code>0</code><br>if you specify the <code>10</code> value, the first ten keywords in the results array will be omitted and the data will be provided for the successive keywords'
          nullable: true
        tag:
          type: string
          description: <em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response
          nullable: true
      example:
        - app_ids:
            '1': '686449807'
            '2': '382617920'
          language_name: English
          location_code: 2840
          limit: 10
    DataforseoLabsleAppIntersectionLiveItem:
      type: object
      properties:
        se_type:
          type: string
          description: <em>search engine type</em>
          nullable: true
        keyword_data:
          type: object
          oneOf:
            - $ref: '#/components/schemas/KeywordDataInfo'
          description: <em>keyword data for the returned keyword</em>
          nullable: true
        intersection_result:
          type: object
          additionalProperties:
            type: object
            oneOf:
              - $ref: '#/components/schemas/GooglePlaySearchOrganic'
            nullable: true
          description: '<em>contains SERP data for the returned <code>keyword</code></em><br>data will be provided in separate arrays for each app ID you specified in the <code>app_ids</code> object when setting a task;<br>depending on the number of specified app IDs, it can contain from 1 to 20 arrays named respectively'
          nullable: true
    DataforseoLabsGoogleAppIntersectionLiveResultInfo:
      type: object
      properties:
        se_type:
          type: string
          description: <em>search engine type</em>
          nullable: true
        app_ids:
          type: object
          additionalProperties:
            type: string
            nullable: true
          description: <em>ids of the apps in a POST array</em>
          nullable: true
        location_code:
          type: integer
          description: <em>location code in a POST array</em>
          nullable: true
        language_code:
          type: string
          description: <em>language code in a POST array</em>
          nullable: true
        total_count:
          type: integer
          description: <em>total amount of results in our database relevant to your request</em>
          format: int64
          nullable: true
        items_count:
          type: integer
          description: <em>the number of results returned in the <code>items</code> array</em>
          format: int64
          nullable: true
        items:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/DataforseoLabsleAppIntersectionLiveItem'
            nullable: true
          description: <em>contains data related to the ranking keywords for the app specified in the <code>app_id</code> field</em>
          nullable: true
    DataforseoLabsGoogleAppIntersectionLiveTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/DataforseoLabsGoogleAppIntersectionLiveResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    DataforseoLabsGoogleAppIntersectionLiveResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/DataforseoLabsGoogleAppIntersectionLiveTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    DataforseoLabsAppleBulkAppMetricsLiveRequestInfo:
      type: object
      properties:
        app_ids:
          type: array
          items:
            type: string
          description: <em>ids of the apps</em><br><strong>required field</strong><br>IDs of mobile applications on App Store;<br>you can find the ID in the URL of every app listed on App Store;<br>example:<br>in the URL <code>https://apps.apple.com/us/app/id835599320</code><br>the id is <code>835599320</code>;<br>the maximum number of IDs you can specify in this field is <code>1000</code>
        location_name:
          type: string
          description: <em>full name of the location</em><br><strong>required field if you don't specify</strong> <code>location_code</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_name</code> by making a separate request to <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the US location only;<br>example:<br><code class="long-string">United States</code>
        location_code:
          type: integer
          description: <em>location code</em><br><strong>required field if you don't specify</strong> <code>location_name</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_code</code> by making a separate request to <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the US location only;<br>example:<br><code class="long-string">2840</code>
        language_name:
          type: string
          description: <em>full name of the language</em><br><strong>required field if you don't specify</strong> <code>language_code</code><br><strong>Note:</strong> it is required to specify either <code>language_name</code> or <code>language_code</code><br>you can receive the list of available languages with their <code>language_name</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the English language only;<br>example:<br><code class="long-string">English</code>
        language_code:
          type: string
          description: <em>language code</em><br><strong>required field if you don't specify</strong> <code>language_name</code><br><strong>Note:</strong> it is required to specify either <code>language_name</code> or <code>language_code</code><br>you can receive the list of available languages with their <code>language_code</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the English language only<br>example:<br><code class="long-string">en</code>
          nullable: true
        tag:
          type: string
          description: <em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response
          nullable: true
      example:
        - app_ids:
            - '686449807'
            - '382617920'
          language_name: English
          location_code: 2840
    DataforseoLabsAppleBulkAppMetricsLiveResultInfo:
      type: object
      properties:
        se_type:
          type: string
          description: <em>search engine type</em>
          nullable: true
        location_code:
          type: integer
          description: <em>location code in a POST array</em>
          nullable: true
        language_code:
          type: string
          description: <em>language code in a POST array</em>
          nullable: true
        total_count:
          type: integer
          description: <em>total amount of results in our database relevant to your request</em>
          format: int64
          nullable: true
        items_count:
          type: integer
          description: <em>the number of results returned in the <code>items</code> array</em>
          format: int64
          nullable: true
        items:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/DataforseoLabsleBulkAppMetricsLiveItem'
            nullable: true
          description: <em>contains data related to the ranking app metrics of the specified application
          nullable: true
    DataforseoLabsAppleBulkAppMetricsLiveTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/DataforseoLabsAppleBulkAppMetricsLiveResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    DataforseoLabsAppleBulkAppMetricsLiveResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/DataforseoLabsAppleBulkAppMetricsLiveTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    DataforseoLabsAppleKeywordsForAppLiveRequestInfo:
      type: object
      properties:
        app_id:
          type: string
          description: <em>id of the app</em><br><strong>required field</strong><br>ID of the mobile application on App Store;<br>you can find the ID in the URL of every app listed on App Store;<br>example:<br>in the URL <code>https://apps.apple.com/us/app/id835599320</code><br>the id is <code>835599320</code>
        location_name:
          type: string
          description: <em>full name of the location</em><br><strong>required field if you don't specify</strong> <code>location_code</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_name</code> by making a separate request to <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the US location only;<br>example:<br><code class="long-string">United States</code>
        location_code:
          type: integer
          description: <em>location code</em><br><strong>required field if you don't specify</strong> <code>location_name</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_code</code> by making a separate request to <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the US location only;<br>example:<br><code class="long-string">2840</code>
        language_name:
          type: string
          description: <em>full name of the language</em><br><strong>required field if you don't specify</strong> <code>language_code</code><br><strong>Note:</strong> it is required to specify either <code>language_name</code> or <code>language_code</code><br>you can receive the list of available languages with their <code>language_name</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the English language only;<br>example:<br><code class="long-string">English</code>
        language_code:
          type: string
          description: <em>language code</em><br><strong>required field if you don't specify</strong> <code>language_name</code><br><strong>Note:</strong> it is required to specify either <code>language_name</code> or <code>language_code</code><br>you can receive the list of available languages with their <code>language_code</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the English language only<br>example:<br><code class="long-string">en</code>
          nullable: true
        filters:
          type: array
          items:
            type: object
            nullable: true
          description: '<em>array of results filtering parameters</em><br>optional field<br><strong>you can add several filters at once (8 filters maximum)</strong><br>you should set a logical operator <code>and</code>, <code>or</code> between the conditions<br>the following operators are supported:<br><code>&lt;</code>, <code>&lt;=</code>, <code>&gt;</code>, <code>&gt;=</code>, <code>=</code>, <code>&lt;&gt;</code>, <code>in</code>, <code>not_in</code><br>example:<br><code>["keyword_data.keyword_info.search_volume","&gt;",500]</code><p><code>[["keyword_data.keyword_info.search_volume","&lt;&gt;",500],"and",["ranked_serp_element.serp_item.rank_group","&gt;=","10"]]</code><p>for more information about filters, please refer to <a href="/v3/dataforseo_labs/filters" target="_blank" rel="noopener noreferrer">Dataforseo Labs - Filters</a> or this <a href="https://dataforseo.com/help-center/how-to-use-filters-in-dataforseo-labs-api" rel="noopener noreferrer" target="_blank">help center guide</a>'
          nullable: true
        order_by:
          type: array
          items:
            type: string
          description: '<em>results sorting rules</em><br>optional field<br>you can use the same values as in the <code>filters</code> array to sort the results;<br>possible sorting types:<br><code>asc</code> - results will be sorted in the ascending order;<br><code>desc</code> - results will be sorted in the descending order;<br>you should use a comma to specify a sorting type;<br>example:<br><code>["ranked_serp_element.serp_item.rank_group,asc"]</code><br><strong>Note:</strong> you can set no more than three sorting rules in a single request;<br>you should use a comma to separate several sorting rules;<br>example:<br><code>["ranked_serp_element.serp_item.rank_group,desc","keyword_data.keyword_info.search_volume,asc"]</code><br>default rule:<br><code>["keyword_data.keyword_info.search_volume,desc"]</code><br><strong>Note:</strong> if the <code>item_types</code> array contains item types that are different from <code>organic</code>, the results will be ordered by the first item type in the array'
          nullable: true
        limit:
          type: integer
          description: '<em>the maximum number of returned keywords</em><br>optional field<br>default value: <code>100</code><br>maximum value: <code>1000</code>'
          nullable: true
        offset:
          type: integer
          description: '<em>offset in the results array of returned keywords</em><br>optional field<br>default value: <code>0</code><br>if you specify the <code>10</code> value, the first ten keywords in the results array will be omitted and the data will be provided for the successive keywords'
          nullable: true
        tag:
          type: string
          description: <em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response
          nullable: true
      example:
        - app_id: '686449807'
          language_name: English
          location_code: 2840
          limit: 10
    AppStoreSearchOrganic:
      type: object
      properties:
        type:
          type: string
          description: type of element
          nullable: true
        rank_group:
          type: integer
          description: <em>position within a group of elements with identical <code>type</code> values</em><br>positions of elements with different <code>type</code> values are omitted from <code>rank_group</code>
          nullable: true
        rank_absolute:
          type: integer
          description: <em>absolute rank in SERP</em><br>absolute position among all the elements in SERP
          nullable: true
        position:
          type: string
          description: '<em>the alignment of the element in SERP</em><br>can take the following values:<br><code>left</code>, <code>right</code>'
          nullable: true
        app_id:
          type: string
          description: <em>id of the app in a POST array</em>
          nullable: true
        title:
          type: string
          description: <em>title of the app</em>
          nullable: true
        url:
          type: string
          description: <em>URL to the app page on App Store</em>
          nullable: true
        icon:
          type: string
          description: <em>URL to the app icon</em>
          nullable: true
        reviews_count:
          type: integer
          description: <em>the total number of reviews of the app</em>
          format: int64
          nullable: true
        rating:
          type: object
          oneOf:
            - $ref: '#/components/schemas/RatingInfo'
          description: <em>average rating of the app</em>
          nullable: true
        is_free:
          type: boolean
          description: <em>indicates whether the app is free</em>
          nullable: true
        price:
          type: object
          oneOf:
            - $ref: '#/components/schemas/PriceInfo'
          description: <em>pricing information for the app</em>
          nullable: true
    AppleRankedSerpElementInfo:
      type: object
      properties:
        se_type:
          type: string
          description: <em>search engine type</em>
          nullable: true
        serp_item:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppStoreSearchOrganic'
          description: <em>contains data on the SERP element</em><br>the list of supported SERP elements can be found below
          nullable: true
        check_url:
          type: string
          description: <em>direct URL to search engine results</em><br>you can use it to make sure that we provided accurate results
          nullable: true
        se_results_count:
          type: integer
          description: <em>number of search results for the returned keyword</em>
          nullable: true
        last_updated_time:
          type: string
          description: '<em>date and time when keyword data was updated</em><br>in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”;<br>example:<br><code class="long-string">2019-11-15 12:57:46 +00:00</code>'
          nullable: true
        previous_updated_time:
          type: string
          description: '<em>previous to the most recent date and time when SERP data was updated</em><br>in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”<br>example:<br><code class="long-string">2019-10-15 12:57:46 +00:00</code>;<br>in this case, will equal null'
          nullable: true
    DataforseoLabsAppleKeywordsForAppLiveItem:
      type: object
      properties:
        se_type:
          type: string
          description: <em>search engine type</em>
          nullable: true
        keyword_data:
          type: object
          oneOf:
            - $ref: '#/components/schemas/KeywordDataInfo'
          description: <em>keyword data for the returned keyword</em>
          nullable: true
        ranked_serp_element:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppleRankedSerpElementInfo'
          description: <em>contains data on the domain's SERP element found for the returned <code>keyword</code></em>
          nullable: true
    DataforseoLabsAppleKeywordsForAppLiveResultInfo:
      type: object
      properties:
        se_type:
          type: string
          description: <em>search engine type</em>
          nullable: true
        app_id:
          type: string
          description: <em>id of the app in a POST array</em>
          nullable: true
        location_code:
          type: integer
          description: <em>location code in a POST array</em>
          nullable: true
        language_code:
          type: string
          description: <em>language code in a POST array</em>
          nullable: true
        total_count:
          type: integer
          description: <em>total amount of results in our database relevant to your request</em>
          format: int64
          nullable: true
        items_count:
          type: integer
          description: <em>the number of results returned in the <code>items</code> array</em>
          format: int64
          nullable: true
        items:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/DataforseoLabsAppleKeywordsForAppLiveItem'
            nullable: true
          description: <em>contains data related to the ranking keywords for the app specified in the <code>app_id</code> field</em>
          nullable: true
    DataforseoLabsAppleKeywordsForAppLiveTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/DataforseoLabsAppleKeywordsForAppLiveResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    DataforseoLabsAppleKeywordsForAppLiveResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/DataforseoLabsAppleKeywordsForAppLiveTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    DataforseoLabsAppleAppCompetitorsLiveRequestInfo:
      type: object
      properties:
        app_id:
          type: string
          description: <em>id of the app</em><br><strong>required field</strong><br>ID of the mobile application on App Store;<br>you can find the ID in the URL of every app listed on App Store;<br>example:<br>in the URL <code>https://apps.apple.com/us/app/id835599320</code><br>the id is <code>835599320</code>
        location_name:
          type: string
          description: <em>full name of the location</em><br><strong>required field if you don't specify</strong> <code>location_code</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_name</code> by making a separate request to <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the US location only;<br>example:<br><code class="long-string">United States</code>
        location_code:
          type: integer
          description: <em>location code</em><br><strong>required field if you don't specify</strong> <code>location_name</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_code</code> by making a separate request to <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the US location only;<br>example:<br><code class="long-string">2840</code>
        language_name:
          type: string
          description: <em>full name of the language</em><br><strong>required field if you don't specify</strong> <code>language_code</code><br><strong>Note:</strong> it is required to specify either <code>language_name</code> or <code>language_code</code><br>you can receive the list of available languages with their <code>language_name</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the English language only;<br>example:<br><code class="long-string">English</code>
        language_code:
          type: string
          description: <em>language code</em><br><strong>required field if you don't specify</strong> <code>language_name</code><br><strong>Note:</strong> it is required to specify either <code>language_name</code> or <code>language_code</code><br>you can receive the list of available languages with their <code>language_code</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the English language only<br>example:<br><code class="long-string">en</code>
          nullable: true
        filters:
          type: array
          items:
            type: object
            nullable: true
          description: '<em>array of results filtering parameters</em><br>optional field<br><strong>you can add several filters at once (8 filters maximum)</strong><br>you should set a logical operator <code>and</code>, <code>or</code> between the conditions<br>the following operators are supported:<br><code>&lt;</code>, <code>&lt;=</code>, <code>&gt;</code>, <code>&gt;=</code>, <code>=</code>, <code>&lt;&gt;</code>, <code>in</code>, <code>not_in</code><br>example:<br><code>["intersections","&gt;",500]</code><p><code>[["competitor_metrics.app_store_search_organic.pos_1","&lt;&gt;",10],"and",["avg_position","&gt;=","10"]]</code><p><code>[[["intersections","&gt;=",50],"and",["competitor_metrics.app_store_search_organic.pos_1","in",[1,5]]],<br>"or",<br>["sum_position","&gt;=","10000"]]</code><p>for more information about filters, please refer to <a href="/v3/dataforseo_labs/filters" target="_blank" rel="noopener noreferrer">Dataforseo Labs - Filters</a> or this <a href="https://dataforseo.com/help-center/how-to-use-filters-in-dataforseo-labs-api" rel="noopener noreferrer" target="_blank">help center guide</a>'
          nullable: true
        order_by:
          type: array
          items:
            type: string
          description: '<em>results sorting rules</em><br>optional field<br>you can use the same values as in the <code>filters</code> array to sort the results;<br>possible sorting types:<br><code>asc</code> - results will be sorted in the ascending order;<br><code>desc</code> - results will be sorted in the descending order;<br>you should use a comma to specify a sorting type;<br>example:<br><code>["intersections,asc"]</code><br><strong>Note:</strong> you can set no more than three sorting rules in a single request;<br>you should use a comma to separate several sorting rules;<br>example:<br><code>["intersections,desc","sum_position,asc"]</code><p>default rule:<br><code>["intersections,desc"]</code><br><strong>Note:</strong> if the <code>item_types</code> array contains item types that are different from <code>organic</code>, the results will be ordered by the first item type in the array'
          nullable: true
        limit:
          type: integer
          description: '<em>the maximum number of returned apps</em><br>optional field<br>default value: <code>100</code><br>maximum value: <code>1000</code>'
          nullable: true
        offset:
          type: integer
          description: '<em>offset in the results array of returned apps</em><br>optional field<br>default value: <code>0</code><br>if you specify the <code>10</code> value, the first ten apps in the results array will be omitted and the data will be provided for the successive keywords'
          nullable: true
        tag:
          type: string
          description: <em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response
          nullable: true
      example:
        - app_id: '686449807'
          language_name: English
          location_code: 2840
          limit: 10
    DataforseoLabsAppleAppCompetitorsLiveResultInfo:
      type: object
      properties:
        se_type:
          type: string
          description: <em>search engine type</em>
          nullable: true
        app_id:
          type: string
          description: <em>id of the app in a POST array</em>
          nullable: true
        location_code:
          type: integer
          description: <em>location code in a POST array</em>
          nullable: true
        language_code:
          type: string
          description: <em>language code in a POST array</em>
          nullable: true
        total_count:
          type: integer
          description: <em>total amount of results in our database relevant to your request</em>
          format: int64
          nullable: true
        items_count:
          type: integer
          description: <em>the number of results returned in the <code>items</code> array</em>
          format: int64
          nullable: true
        items:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/DataforseoLabsleAppCompetitorsLiveItem'
            nullable: true
          description: <em>contains data related to the <code>app_id</code> and competitor applications</em>
          nullable: true
    DataforseoLabsAppleAppCompetitorsLiveTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/DataforseoLabsAppleAppCompetitorsLiveResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    DataforseoLabsAppleAppCompetitorsLiveResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/DataforseoLabsAppleAppCompetitorsLiveTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    DataforseoLabsAppleAppIntersectionLiveRequestInfo:
      type: object
      properties:
        app_ids:
          type: object
          additionalProperties:
            type: string
            nullable: true
          description: '<em>ids of the target apps</em><br><strong>required field</strong><br>IDs of the target mobile applications on App Store;<br>you can find the ID in the URL of every app listed on App Store;<br>example:<br>in the URL <code>https://apps.apple.com/us/app/id835599320</code><br>the id is <code>835599320</code>;<br>the ids should be specified the following way:<br>`"app_ids": {<br>"1": "686449807",<br>"2": "382617920"<br>}`<br>if you specify a single ID here, the API will return results only for one application;<br>the maximum number of app IDs you can specify in this object is <code>20</code>'
          nullable: true
        location_name:
          type: string
          description: <em>full name of the location</em><br><strong>required field if you don't specify</strong> <code>location_code</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_name</code> by making a separate request to <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the US location only;<br>example:<br><code class="long-string">United States</code>
        location_code:
          type: integer
          description: <em>location code</em><br><strong>required field if you don't specify</strong> <code>location_name</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_code</code> by making a separate request to <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the US location only;<br>example:<br><code class="long-string">2840</code>
        language_name:
          type: string
          description: <em>full name of the language</em><br><strong>required field if you don't specify</strong> <code>language_code</code><br><strong>Note:</strong> it is required to specify either <code>language_name</code> or <code>language_code</code><br>you can receive the list of available languages with their <code>language_name</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the English language only;<br>example:<br><code class="long-string">English</code>
        language_code:
          type: string
          description: <em>language code</em><br><strong>required field if you don't specify</strong> <code>language_name</code><br><strong>Note:</strong> it is required to specify either <code>language_name</code> or <code>language_code</code><br>you can receive the list of available languages with their <code>language_code</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the English language only<br>example:<br><code class="long-string">en</code>
          nullable: true
        filters:
          type: array
          items:
            type: object
            nullable: true
          description: '<em>array of results filtering parameters</em><br>optional field<br><strong>you can add several filters at once (8 filters maximum)</strong><br>you should set a logical operator <code>and</code>, <code>or</code> between the conditions<br>the following operators are supported:<br><code>&lt;</code>, <code>&lt;=</code>, <code>&gt;</code>, <code>&gt;=</code>, <code>=</code>, <code>&lt;&gt;</code>, <code>in</code>, <code>not_in</code><br>example:<br><code>["keyword_data.keyword_info.search_volume","&gt;",500]</code><p><code>[["keyword_data.keyword_info.search_volume","&lt;&gt;",500],"and",[intersection_result.382617920.rank_group","&gt;=","10"]]</code><p>for more information about filters, please refer to <a href="/v3/dataforseo_labs/filters" target="_blank" rel="noopener noreferrer">Dataforseo Labs - Filters</a> or this <a href="https://dataforseo.com/help-center/how-to-use-filters-in-dataforseo-labs-api" rel="noopener noreferrer" target="_blank">help center guide</a>'
          nullable: true
        order_by:
          type: array
          items:
            type: string
          description: '<em>results sorting rules</em><br>optional field<br>you can use the same values as in the <code>filters</code> array to sort the results;<br>possible sorting types:<br><code>asc</code> - results will be sorted in the ascending order;<br><code>desc</code> - results will be sorted in the descending order;<br>you should use a comma to specify a sorting type;<br>example:<br><code>["intersection_result.382617920.rank_absolute,asc"]</code><br><strong>Note:</strong> you can set no more than three sorting rules in a single request;<br>you should use a comma to separate several sorting rules;<br>example:<br><code>["intersection_result.382617920.rank_absolute,desc","keyword_data.keyword_info.search_volume,asc"]</code><br>default rule:<br><code>["keyword_data.keyword_info.search_volume,desc"]</code><br><strong>Note:</strong> if the <code>item_types</code> array contains item types that are different from <code>organic</code>, the results will be ordered by the first item type in the array'
          nullable: true
        limit:
          type: integer
          description: '<em>the maximum number of returned keywords</em><br>optional field<br>default value: <code>100</code><br>maximum value: <code>1000</code>'
          nullable: true
        offset:
          type: integer
          description: '<em>offset in the results array of returned keywords</em><br>optional field<br>default value: <code>0</code><br>if you specify the <code>10</code> value, the first ten keywords in the results array will be omitted and the data will be provided for the successive keywords'
          nullable: true
        tag:
          type: string
          description: <em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response
          nullable: true
      example:
        - app_ids:
            '1': '686449807'
            '2': '382617920'
          language_name: English
          location_code: 2840
          limit: 10
    DataforseoLabsAppleAppIntersectionLiveResultInfo:
      type: object
      properties:
        se_type:
          type: string
          description: <em>search engine type</em>
          nullable: true
        app_ids:
          type: object
          additionalProperties:
            type: string
            nullable: true
          description: <em>ids of the apps in a POST array</em>
          nullable: true
        location_code:
          type: integer
          description: <em>location code in a POST array</em>
          nullable: true
        language_code:
          type: string
          description: <em>language code in a POST array</em>
          nullable: true
        total_count:
          type: integer
          description: <em>total amount of results in our database relevant to your request</em>
          format: int64
          nullable: true
        items_count:
          type: integer
          description: <em>the number of results returned in the <code>items</code> array</em>
          format: int64
          nullable: true
        items:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/DataforseoLabsleAppIntersectionLiveItem'
            nullable: true
          description: <em>contains data related to the ranking keywords for the app specified in the <code>app_id</code> field</em>
          nullable: true
    DataforseoLabsAppleAppIntersectionLiveTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/DataforseoLabsAppleAppIntersectionLiveResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    DataforseoLabsAppleAppIntersectionLiveResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/DataforseoLabsAppleAppIntersectionLiveTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    DomainAnalyticsIdListRequestInfo:
      type: object
      properties:
        datetime_from:
          type: string
          description: '<em>start time for filtering results</em><br><strong>required field</strong><br>if <code>include_metadata</code> is set to <code>true</code>, maximum value: a month from current datetime;<br>if <code>include_metadata</code> is set to <code>false</code>, maximum value: six months from current datetime;<br>must be specified in the UTC format: "yyyy-mm-dd hh-mm-ss +00:00"<br>example:<br><code>2023-01-15 12:57:46 +00:00</code>'
        datetime_to:
          type: string
          description: '<em>finish time for filtering results</em><br><strong>required field</strong><br>maximum value: current datetime;<br>must be specified in the UTC format: "yyyy-mm-dd hh-mm-ss +00:00"<br>example:<br><code>2023-01-31 13:57:46 +00:00</code>'
        limit:
          type: integer
          description: '<em>the maximum number of returned task IDs</em><br>optional field<br>default value: <code>1000</code><br>maximum value: <code>1000</code>'
          nullable: true
        offset:
          type: integer
          description: '<em>offset in the results array of returned task IDs</em><br>optional field<br>default value: <code>0</code><br>if you specify the <code>10</code> value, the first ten tasks in the results array will be omitted'
          nullable: true
        sort:
          type: string
          description: '<em>sorting by task execution time</em><br>optional field<br>possible values: <code>"asc"</code>, <code>"desc"</code><br>default value: <code>"asc"</code>'
          nullable: true
        include_metadata:
          type: boolean
          description: '<em>include task metadata in the respond</em><br>optional field<br>default value: <code>false</code>'
          nullable: true
      example:
        - datetime_from: '2026-09-10 11:12:35'
          datetime_to: '2026-09-20 11:12:35'
          limit: 10
          include_metadata: true
    DomainAnalyticsIdListResultInfo:
      type: object
      properties:
        id:
          type: string
          description: <em>task identifier</em><br><strong>unique task identifier in our system in the <a href="https://en.wikipedia.org/wiki/Universally_unique_identifier">UUID</a> format</strong>
          nullable: true
        url:
          type: string
          description: <em>URL of the task</em><br>URL you used for making an API call
          nullable: true
        datetime_posted:
          type: string
          description: '<em>date and time when the task was made</em><br>in the UTC format: "yyyy-mm-dd hh-mm-ss +00:00"<br>example:<br><code>2023-01-15 12:57:46 +00:00</code>'
          nullable: true
        datetime_done:
          type: string
          description: '<em>date and time when the task was completed</em><br>in the UTC format: "yyyy-mm-dd hh-mm-ss +00:00"<br>example:<br><code>2023-01-15 12:57:46 +00:00</code>'
          nullable: true
        status:
          type: string
          description: <em>informational message of the task</em><br>you can find the full list of general informational messages <a href="/v3/appendix-errors/">here</a>
          nullable: true
        cost:
          type: number
          description: '<em>total tasks cost, USD</em>'
          nullable: true
        metadata:
          type: object
          additionalProperties:
            type: object
            nullable: true
          description: <em>contains parameters you specified in the POST request</em>
          nullable: true
    DomainAnalyticsIdListTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/DomainAnalyticsIdListResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    DomainAnalyticsIdListResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/DomainAnalyticsIdListTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    DomainAnalyticsErrorsRequestInfo:
      type: object
      properties:
        limit:
          type: integer
          description: '<em>the maximum number of returned tasks that responded with an error</em><br>optional field<br>default value: <code>1000</code><br>maximum value: <code>1000</code>'
          nullable: true
        offset:
          type: integer
          description: '<em>offset in the results array of returned tasks</em><br>optional field<br>default value: <code>0</code><br>if you specify the <code>10</code> value, the first ten tasks in the results array will be omitted and the data will be provided for the successive tasks'
          nullable: true
        filtered_function:
          type: string
          description: '<em>return tasks with a certain function</em><br>use this field to obtain a list of tasks that returned an error filtered by a certain function<br>you can filter the results by the values you receive in the <code>function</code> fields of the API response<br>i.e., once you receive unfiltered results, you can call this API again to filter them by <code>function</code> <br>example: <code>domain_analytics/task_get</code>, <code>postback_url</code>, <code>pingback_url</code>'
          nullable: true
        datetime_from:
          type: string
          description: '<em>start time for filtering results</em><br>optional field<br>allows filtering results by the <code>datetime</code> parameter within the range of the last 7 days;<br>must be specified in the UTC format: "yyyy-mm-dd hh-mm-ss +00:00"<br>example:<br><code>2021-11-15 12:57:46 +00:00</code>'
          nullable: true
        datetime_to:
          type: string
          description: '<em>finish time for filtering results</em><br>optional field<br>allows filtering results by the <code>datetime</code> parameter within the range of the last 7 days;<br>must be specified in the UTC format: "yyyy-mm-dd hh-mm-ss +00:00"<br>example:<br><code>2021-11-15 13:57:46 +00:00</code>'
          nullable: true
      example:
        - limit: 10
          offset: 0
          filtered_function: pingback_url
    DomainAnalyticsErrorsResultInfo:
      type: object
      properties:
        id:
          type: string
          description: <em>task identifier</em><br><strong>unique task identifier in our system in the <a href="https://en.wikipedia.org/wiki/Universally_unique_identifier">UUID</a> format</strong>
          nullable: true
        datetime:
          type: string
          description: '<em>date and time when an error occurred</em><br>in the UTC format: "yyyy-mm-dd hh-mm-ss +00:00"<br>example:<br><code>2019-11-15 12:57:46 +00:00</code>'
          nullable: true
        function:
          type: string
          description: <em>corresponding API function</em>
          nullable: true
        error_code:
          type: integer
          description: <em>error code</em>
          nullable: true
        error_message:
          type: string
          description: <em>error message or error URL</em><br>error message <a href="https://docs.dataforseo.com/v3/appendix/errors/" rel="noopener noreferrer" target="_blank">(see full list)</a> or URL that caused an error
          nullable: true
        http_url:
          type: string
          description: <em>URL that caused an error</em><br>URL you used for making an API call or pingback/postback URL
          nullable: true
        http_method:
          type: string
          description: <em>HTTP method</em>
          nullable: true
        http_code:
          type: integer
          description: <em>HTTP status code</em>
          nullable: true
        http_time:
          type: number
          description: '<em>time taken by HTTP request</em><br>for tasks set with a pingback/postback, this field will show the time it took your server to respond'
          nullable: true
        http_response:
          type: string
          description: <em>HTTP response</em><br>server response
          nullable: true
    DomainAnalyticsErrorsTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/DomainAnalyticsErrorsResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    DomainAnalyticsErrorsResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/DomainAnalyticsErrorsTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    DomainAnalyticsTechnologiesAvailableFiltersResultInfo:
      type: object
      properties:
        domains_by_technology:
          type: object
          additionalProperties:
            type: string
            nullable: true
          nullable: true
        aggregation_technologies:
          type: object
          additionalProperties:
            type: string
            nullable: true
          nullable: true
        technologies_summary:
          type: object
          additionalProperties:
            type: string
            nullable: true
          nullable: true
        domains_by_html_terms:
          type: object
          additionalProperties:
            type: string
            nullable: true
          nullable: true
    DomainAnalyticsTechnologiesAvailableFiltersTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/DomainAnalyticsTechnologiesAvailableFiltersResultInfo'
                nullable: true
              nullable: true
    DomainAnalyticsTechnologiesAvailableFiltersResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/DomainAnalyticsTechnologiesAvailableFiltersTaskInfo'
                nullable: true
              nullable: true
    DomainAnalyticsTechnologiesLocationsResultInfo:
      type: object
      properties:
        location_name:
          type: string
          description: <em>full name of the location</em>
          nullable: true
        country_iso_code:
          type: string
          description: <em>ISO country code of the location</em>
          nullable: true
    DomainAnalyticsTechnologiesLocationsTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/DomainAnalyticsTechnologiesLocationsResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    DomainAnalyticsTechnologiesLocationsResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/DomainAnalyticsTechnologiesLocationsTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    DomainAnalyticsTechnologiesLanguagesResultInfo:
      type: object
      properties:
        language_name:
          type: string
          description: <em>language name</em>
          nullable: true
        language_code:
          type: string
          description: <em>language code according to <a href="https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes" target="_blank" rel="noopener noreferrer">ISO 639-1</a></em>
          nullable: true
    DomainAnalyticsTechnologiesLanguagesTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/DomainAnalyticsTechnologiesLanguagesResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    DomainAnalyticsTechnologiesLanguagesResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/DomainAnalyticsTechnologiesLanguagesTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    TechnologyCategoryInfo:
      type: object
      properties:
        id:
          type: string
          description: '<em>id of the technology category</em><br>example:<br><code>crm</code>, <code>cart_abandonment</code>'
          nullable: true
        path:
          type: string
          description: <em>path to the technology category</em><br>example:<br><code>user_generated_content.content_curation</code>
          nullable: true
        title:
          type: string
          description: <em>title of the technology category</em>
          nullable: true
        technologies:
          type: array
          items:
            type: string
            nullable: true
          description: '<em>list of technologies in this category</em><br>example:<br><code>"Salesforce"</code>, <code>"CareCart"</code>'
          nullable: true
    Groups:
      type: object
      properties:
        id:
          type: string
          description: '<em>id of the technology group</em><br>example:<br><code>marketing</code>, <code>sales</code>'
          nullable: true
        title:
          type: string
          description: <em>title of the technology group</em>
          nullable: true
        categories:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/TechnologyCategoryInfo'
            nullable: true
          description: <em>technology categories in this group</em>
          nullable: true
    DomainAnalyticsTechnologiesTechnologiesResultInfo:
      type: object
      properties:
        groups:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/Groups'
            nullable: true
          description: <em>array of technology groups</em>
          nullable: true
    DomainAnalyticsTechnologiesTechnologiesTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/DomainAnalyticsTechnologiesTechnologiesResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    DomainAnalyticsTechnologiesTechnologiesResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/DomainAnalyticsTechnologiesTechnologiesTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    DomainAnalyticsTechnologiesAggregationTechnologiesLiveRequestInfo:
      type: object
      properties:
        group:
          type: string
          description: '<em>id of the target technology group</em><br><strong>required field if you don''t specify <code>technology</code>, <code>category</code> or <code>keyword</code></strong><br>at least one field (<code>group</code>, <code>category</code>, <code>keyword</code>, <code>technology</code>) must be set<br>you can find the full list of technology group ids <a href="/v3/domain_analytics/technologies/technologies" target="_blank" rel="noopener noreferrer">on this page</a><br>example:<br><code>"marketing"</code>'
        category:
          type: string
          description: '<em>id of the target technology category</em><br><strong>required field if you don''t specify <code>group</code>, <code>keyword</code> or <code>technology</code></strong><br>at least one field (<code>group</code>, <code>category</code>, <code>keyword</code>, <code>technology</code>) must be set<br>you can find the full list of technology category ids <a href="/v3/domain_analytics/technologies/technologies" target="_blank" rel="noopener noreferrer">on this page</a><br>example:<br><code>"crm"</code>'
        technology:
          type: string
          description: '<em>target technology</em><br><strong>required field if you don''t specify <code>group</code>, <code>keyword</code> or <code>category</code></strong><br>at least one field (<code>group</code>, <code>category</code>, <code>keyword</code>, <code>technology</code>) must be set<br>you can find the full list of technologies <a href="/v3/domain_analytics/technologies/technologies" target="_blank" rel="noopener noreferrer">on this page</a><br>example:<br><code>"Salesforce"</code>'
        keyword:
          type: string
          description: '<em>target keyword in the domain''s meta keywords</em><br><strong>required field if you don''t specify <code>group</code>, <code>category</code> or <code>technology</code></strong><br>at least one field (<code>group</code>, <code>category</code>, <code>keyword</code>, <code>technology</code>) must be set<br>UTF-8 encoding<br>example:<br><code>"seo"</code>learn more about rules and limitations of <code>keyword</code> and <code>keywords</code> fields in DataForSEO APIs in this <a href="https://dataforseo.com/help-center/rules-and-limitations-of-keyword-and-keywords-fields-in-dataforseo-apis" target="_blank" rel="noopener noreferrer">Help Center article</a>'
        mode:
          type: string
          description: '<em>search mode</em><br>optional field<br>possible search mode types:<br><code>as_is</code> - search for results exactly matching the specified group ids, category ids, or technology names<br><code>entry</code> - search for results matching a part of the specified group ids, category ids, or technology names<br>default value: <code>as_is</code>'
          nullable: true
        filters:
          type: array
          items:
            type: object
            nullable: true
          description: '<em>array of results filtering parameters</em><br>optional field<br><strong>you can add several filters at once (8 filters maximum)</strong><br>you should set a logical operator <code>and</code>, <code>or</code> between the conditions<br>the following operators are supported:<br><code>&lt;</code>, <code>&lt;=</code>, <code>&gt;</code>, <code>&gt;=</code>, <code>=</code>, <code>&lt;&gt;</code>, <code>in</code>, <code>not_in</code>, <code>like</code>,<code>not_like</code><br>you can use the <code>%</code> operator with <code>like</code> and <code>not_like</code> to match any string of zero or more characters<br>you can use the following parameters to filter the results: <code>domain_rank</code>, <code>last_visited</code>, <code>country_iso_code</code>, <code>language_code</code>, <code>content_language_code</code><br><strong>Note:</strong> all filtering parameters are taken from the <code>domain_technology_item</code> of the <a href="/v3/domain_analytics/technologies/filters" target="_blank" rel="noopener noreferrer">domain_technologies</a> endpoint;<br>example:<br><code>[["country_iso_code","=","US"],<br>"and",<br>["domain_rank","&gt;",800]]</code>for more information about filters, please refer to <a href="/v3/domain_analytics/technologies/filters" target="_blank" rel="noopener noreferrer">Domain Analytics Technologies API - Filters</a>'
          nullable: true
        order_by:
          type: array
          items:
            type: string
          description: '<em>results sorting rules</em><br>optional field<br>you can use the following values to sort the results: <code>groups_count</code>, <code>categories_count</code>, <code>technologies_count</code><br>possible sorting types:<br><code>asc</code> - results will be sorted in the ascending order<br><code>desc</code> - results will be sorted in the descending order<br>you should use a comma to set up a sorting type<br>example:<br><code>["groups_count,desc"]</code><br><strong>note that you can set no more than three sorting rules in a single request</strong><br>you should use a comma to separate several sorting rules<br>example:<br><code>["groups_count,desc","technologies_count,desc"]</code><br>default value:<br><code>["groups_count,desc","categories_count,desc","technologies_count,desc"]</code>'
          nullable: true
        internal_groups_list_limit:
          type: integer
          description: '<em>maximum number of returned technology groups</em><br>optional field<br>you can use this field to limit the number of items with identical <code>"group"</code> in the results<br>default value: <code>5</code><br>minimum value: <code>1</code><br>maximum value: <code>10000</code>'
          nullable: true
        internal_categories_list_limit:
          type: integer
          description: '<em>maximum number of returned technology categories within the same group</em><br>optional field<br>you can use this field to limit the number of items with identical <code>"category"</code> in the results<br>default value: <code>5</code><br>minimum value: <code>1</code><br>maximum value: <code>10000</code>'
          nullable: true
        internal_technologies_list_limit:
          type: integer
          description: '<em>maximum number of returned technologies within the same category</em><br>optional field<br>you can use this field to limit the number of items with identical <code>"technology"</code> in the results<br>default value: <code>10</code><br>minimum value: <code>1</code><br>maximum value: <code>10000</code>'
          nullable: true
        internal_list_limit:
          type: integer
          description: '<em>maximum number of items with identical <code>"category"</code>, <code>"group"</code>, and <code>"technology"</code></em><br>optional field<br>if you use this field, the values specified in <code>internal_groups_list_limit</code>, <code>internal_categories_list_limit</code> and <code>internal_technologies_list_limit</code> will be ignored;<br>you can use this field to limit the number of items with identical <code>"category"</code>, <code>"group"</code>, or <code>"technology"</code><br>default value: <code>10</code><br>minimum value: <code>1</code><br>maximum value: <code>10000</code>'
          nullable: true
        limit:
          type: integer
          description: '<em>the maximum number of returned technologies</em><br>optional field<br>default value: <code>100</code><br>maximum value: <code>10000</code>'
          nullable: true
        offset:
          type: integer
          description: '<em>offset in the results array of returned domains</em><br>optional field<br>default value: <code>0</code><br>maximum value: <code>9999</code><br>if you specify the <code>10</code> value, the first ten technologies in the results array will be omitted and the data will be provided for the successive technologies'
          nullable: true
        tag:
          type: string
          description: <em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response
          nullable: true
      example:
        - mode: entry
          technology: Nginx
          keyword: WordPress
          filters:
            - 
              - country_iso_code
              - =
              - US
            - and
            - 
              - domain_rank
              - '>'
              - 800
          order_by:
            - 'groups_count,desc'
          limit: 10
    DomainAnalyticsTechnologiesAggregationTechnologiesLiveItem:
      type: object
      properties:
        type:
          type: string
          description: type of element
          nullable: true
        group:
          type: string
          description: <em>technology group id</em>
          nullable: true
        category:
          type: string
          description: <em>technology category id</em>
          nullable: true
        technology:
          type: string
          description: <em>technology name</em>
          nullable: true
        groups_count:
          type: integer
          description: <em>technology groups count</em><br>number of domains that match the parameters you specified and are using technologies from the indicated <code>group</code>
          format: int64
          nullable: true
        categories_count:
          type: integer
          description: <em>technology categories count</em><br>number of domains that match the parameters you specified and are using technologies from the indicated <code>category</code>
          format: int64
          nullable: true
        technologies_count:
          type: integer
          description: <em>technologies count</em><br>number of domains that match the parameters you specified and are using the indicated <code>technology</code>
          format: int64
          nullable: true
      description: items array
    DomainAnalyticsTechnologiesAggregationTechnologiesLiveResultInfo:
      type: object
      properties:
        total_count:
          type: integer
          description: <em>total amount of results in our database relevant to your request</em>
          format: int64
          nullable: true
        items_count:
          type: integer
          description: <em>the number of results returned in the <code>items</code> array</em>
          format: int64
          nullable: true
        offset:
          type: integer
          description: offset in the results array of returned domains
          nullable: true
        items:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/DomainAnalyticsTechnologiesAggregationTechnologiesLiveItem'
            nullable: true
          nullable: true
    DomainAnalyticsTechnologiesAggregationTechnologiesLiveTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/DomainAnalyticsTechnologiesAggregationTechnologiesLiveResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    DomainAnalyticsTechnologiesAggregationTechnologiesLiveResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/DomainAnalyticsTechnologiesAggregationTechnologiesLiveTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    DomainAnalyticsTechnologiesTechnologiesSummaryLiveRequestInfo:
      type: object
      properties:
        technology_paths:
          type: array
          items:
            type: string
          description: '<em>target technology paths</em><br><strong>required field if you don''t specify <code>groups</code>, <code>technologies</code> and <code>categories</code></strong><br>each technology path should be specified as a separate object containing "path" and "name", where "path" is specified as "$group_id.$category_id" and "name" - as the name of the target technology; <br>each object with a technology path should be separated with a comma<br>you can find the full list of technology group ids, category ids and technology names <a href="/v3/domain_analytics/technologies/technologies" target="_blank" rel="noopener noreferrer">on this page</a><br><strong>note:</strong> you can specify up to 10 technology paths in this array<br>example:<br><code>[{"path": "content.cms","name": "wordpress"}, {"path": "marketing.crm","name": "salesforce"}]</code>'
        groups:
          type: array
          items:
            type: string
          description: '<em>ids of the target technology groups</em><br><strong>required field if you don''t specify <code>technologies</code>, <code>technology_paths</code>, <code>categories</code>, or <code>keywords</code></strong><br>you can find the full list of technology group ids <a href="/v3/domain_analytics/technologies/technologies" target="_blank" rel="noopener noreferrer">on this page</a><br><strong>note:</strong> you can specify up to 10 technology groups in this array<br>example:<br><code>["sales", "marketing"]</code>'
        categories:
          type: array
          items:
            type: string
          description: '<em>ids of the target technology categories</em><br><strong>required field if you don''t specify <code>groups</code>, <code>technology_paths</code>, <code>technologies</code>, or <code>keywords</code></strong><br>you can find the full list of technology category ids <a href="/v3/domain_analytics/technologies/technologies" target="_blank" rel="noopener noreferrer">on this page</a><br><strong>note:</strong> you can specify up to 10 technology categories in this array<br>example:<br><code>["payment_processors","crm"]</code>'
        technologies:
          type: array
          items:
            type: string
          description: '<em>target technologies</em><br><strong>required field if you don''t specify <code>groups</code>, <code>technology_paths</code>, <code>categories</code>, or <code>keywords</code></strong><br>you can find the full list of technologies you can specify here <a href="/v3/domain_analytics/technologies/technologies" target="_blank" rel="noopener noreferrer">on this page</a><br><strong>note:</strong> you can specify up to 10 technologies in this array<br>example:<br><code>["Google Pay","Salesforce"]</code>'
        keywords:
          type: array
          items:
            type: string
          description: '<em>target keywords in the domain''s title, description or meta keywords</em><br><strong>required field if you don''t specify <code>groups</code>, <code>technology_paths</code>, <code>categories</code>, or <code>technologies</code></strong><br>you can specify the maximum of 10 keywords;<br>UTF-8 encoding;<br>example:<br><code>["seo","software"]</code><p>learn more about rules and limitations of <code>keyword</code> and <code>keywords</code> fields in DataForSEO APIs in this <a href="https://dataforseo.com/help-center/rules-and-limitations-of-keyword-and-keywords-fields-in-dataforseo-apis" rel="noopener noreferrer" target="_blank">Help Center article</a>'
        mode:
          type: string
          description: '<em>search mode</em><br>optional field<br>possible search mode types:<br><code>as_is</code> - search for results exactly matching the specified group ids, category ids, or technology names<br><code>entry</code> - search for results matching a part of the specified group ids, category ids, or technology names<br>default value: <code>as_is</code>'
          nullable: true
        filters:
          type: array
          items:
            type: object
            nullable: true
          description: '<em>array of results filtering parameters</em><br>optional field<br><strong>you can add several filters at once (8 filters maximum)</strong><br>you should set a logical operator <code>and</code>, <code>or</code> between the conditions<br>the following operators are supported:<br><code>&lt;</code>, <code>&lt;=</code>, <code>&gt;</code>, <code>&gt;=</code>, <code>=</code>, <code>&lt;&gt;</code>, <code>in</code>, <code>not_in</code>, <code>like</code>,<code>not_like</code><br>you can use the <code>%</code> operator with <code>like</code> and <code>not_like</code> to match any string of zero or more characters<br>you can use the following parameters to filter the results: <code>domain_rank</code>, <code>last_visited</code>, <code>country_iso_code</code>, <code>language_code</code>, <code>content_language_code</code><br>example:<br><code>[["country_iso_code","=","US"],<br>"and",<br>["domain_rank",">",800]]</code><p>for more information about filters, please refer to <a href="/v3/domain_analytics/technologies/filters" target="_blank" rel="noopener noreferrer">Domain Analytics Technologies API - Filters</a>'
          nullable: true
        internal_list_limit:
          type: integer
          description: '<em>maximum number of elements within internal arrays</em><br>optional field<br>you can use this field to limit the number of elements within the following arrays:<br><code>countries</code>, <code>languages</code>, <code>content_languages</code>, <code>keywords</code><br>default value: <code>10</code><br>minimum value: <code>1</code><br>maximum value: <code>10000</code>'
          nullable: true
        tag:
          type: string
          description: <em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response
          nullable: true
      example:
        - mode: entry
          technologies:
            - Ngi
          keywords:
            - WordPress
          filters:
            - 
              - country_iso_code
              - =
              - US
            - and
            - 
              - domain_rank
              - '>'
              - 800
    DomainAnalyticsTechnologiesTechnologiesSummaryLiveResultInfo:
      type: object
      properties:
        countries:
          type: object
          additionalProperties:
            type: integer
            format: int64
            nullable: true
          description: <em>distribution of websites by country</em><br>contains country codes and number of websites per country
          nullable: true
        languages:
          type: object
          additionalProperties:
            type: integer
            format: int64
            nullable: true
          description: <em>distribution of websites by language</em><br>contains language codes and number of websites per language
          nullable: true
        content_languages:
          type: object
          additionalProperties:
            type: integer
            format: int64
            nullable: true
          description: <em>distribution of websites by content language</em><br>contains content language codes and number of websites per language
          nullable: true
        keywords:
          type: object
          additionalProperties:
            type: integer
            format: int64
            nullable: true
          description: '<em>distribution of websites by keywords</em><br>contains keywords found in the websites'' titles, descriptions or meta keywords, and number of websites using each keyword'
          nullable: true
    DomainAnalyticsTechnologiesTechnologiesSummaryLiveTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/DomainAnalyticsTechnologiesTechnologiesSummaryLiveResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    DomainAnalyticsTechnologiesTechnologiesSummaryLiveResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/DomainAnalyticsTechnologiesTechnologiesSummaryLiveTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    DomainAnalyticsTechnologiesTechnologyStatsLiveRequestInfo:
      type: object
      properties:
        technology:
          type: string
          description: <em>target technology</em><br><strong>required field</strong><br>you can find the full list of technologies you can specify here <a href="/v3/domain_analytics/technologies/technologies" target="_blank" rel="noopener noreferrer">on this page</a><br>example:<br><code>"Salesforce"</code>
        date_from:
          type: string
          description: '<em>starting date of the time range</em><br>optional field<br>minimum value: <code>2022-10-31</code><br>if you don''t specify this field, the minimum value will be used by default<br>date format: <code>"yyyy-mm-dd"</code><br>example:<br><code>"2023-06-01"</code>'
          nullable: true
        date_to:
          type: string
          description: '<em>ending date of the time range</em><br>optional field<br>if you don''t specify this field, the today''s date will be used by default<br>date format: <code>"yyyy-mm-dd"</code><br>example:<br><code>"2023-01-15"</code>'
          nullable: true
        tag:
          type: string
          description: <em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response
          nullable: true
      example:
        - technology: jQuery
          date_from: '2022-10-31'
          date_to: '2023-06-01'
    DomainAnalyticsTechnologiesTechnologyStatsLiveItem:
      type: object
      properties:
        type:
          type: string
          description: type of element
          nullable: true
        date:
          type: string
          description: <em>date for which the data is provided</em>
          nullable: true
        domains_count:
          type: integer
          description: <em>number of domains that use the specified technology</em>
          format: int64
          nullable: true
        countries:
          type: object
          additionalProperties:
            type: integer
            format: int64
            nullable: true
          description: <em>distribution of websites by country</em><br>contains country codes and number of websites per country
          nullable: true
        languages:
          type: object
          additionalProperties:
            type: integer
            format: int64
            nullable: true
          description: <em>distribution of websites by language</em><br>contains language codes and number of websites per language
          nullable: true
        domains_rank:
          type: object
          additionalProperties:
            type: integer
            format: int64
            nullable: true
          description: <em>distribution of websites by backlink rank</em><br>contains domain rank ranges and number of websites per range<br>learn more about rank and how it is calculated in <a href="https://dataforseo.com/help-center/what_is_rank_in_backlinks_api" rel="noopener noreferrer" target="_blank">this help center article</a>
          nullable: true
      description: items array
    DomainAnalyticsTechnologiesTechnologyStatsLiveResultInfo:
      type: object
      properties:
        technology:
          type: string
          description: <em>target technology</em>
          nullable: true
        date_from:
          type: string
          description: <em>starting date of the time range</em>
          nullable: true
        date_to:
          type: string
          description: <em>ending date of the time range</em>
          nullable: true
        items_count:
          type: integer
          nullable: true
        items:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/DomainAnalyticsTechnologiesTechnologyStatsLiveItem'
            nullable: true
          nullable: true
    DomainAnalyticsTechnologiesTechnologyStatsLiveTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/DomainAnalyticsTechnologiesTechnologyStatsLiveResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    DomainAnalyticsTechnologiesTechnologyStatsLiveResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/DomainAnalyticsTechnologiesTechnologyStatsLiveTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    DomainAnalyticsTechnologiesDomainsByTechnologyLiveRequestInfo:
      type: object
      properties:
        technology_paths:
          type: array
          items:
            type: string
          description: '<em>target technology paths</em><br><strong>required field if you don''t specify <code>groups</code>, <code>technologies</code>, <code>keywords</code> or <code>categories</code></strong><br>at least one field (<code>technology_paths</code>, <code>groups</code>, <code>technologies</code>, <code>keywords</code> or <code>categories</code>) must be set;<br>each technology path should be specified as a separate object containing "path" and "name", where "path" is specified as "$group_id.$category_id" and "name" - as the name of the target technology; <br>each object with a technology path should be separated with a comma<br>you can find the full list of technology group ids, category ids and technology names <a href="/v3/domain_analytics/technologies/technologies" target="_blank" rel="noopener noreferrer">on this page</a><br><strong>note:</strong> you can specify up to 10 technology paths in this array<br>example:<br><code>[{"path": "content.cms","name": "wordpress"}, {"path": "marketing.crm","name": "salesforce"}]</code>'
        groups:
          type: array
          items:
            type: string
          description: '<em>ids of the target technology groups</em><br><strong>required field if you don''t specify <code>technologies</code>, <code>technology_paths</code>, <code>keywords</code> or <code>categories</code></strong><br>you can find the full list of technology group ids <a href="/v3/domain_analytics/technologies/technologies" target="_blank" rel="noopener noreferrer">on this page</a><br><strong>note:</strong> you can specify up to 10 technology groups in this array<br>example:<br><code>["sales", "marketing"]</code>'
        categories:
          type: array
          items:
            type: string
          description: '<em>ids of the target technology categories</em><br><strong>required field if you don''t specify <code>groups</code>, <code>technology_paths</code>, <code>keywords</code> or <code>technologies</code></strong><br>you can find the full list of technology category ids <a href="/v3/domain_analytics/technologies/technologies" target="_blank" rel="noopener noreferrer">on this page</a><br><strong>note:</strong> you can specify up to 10 technology categories in this array<br>example:<br><code>["payment_processors","crm"]</code>'
        technologies:
          type: array
          items:
            type: string
          description: '<em>target technologies</em><br><strong>required field if you don''t specify <code>groups</code>, <code>technology_paths</code>, <code>keywords</code> or <code>categories</code></strong><br>you can find the full list of technologies you can specify here <a href="/v3/domain_analytics/technologies/technologies" target="_blank" rel="noopener noreferrer">on this page</a><br><strong>note:</strong> you can specify up to 10 technologies in this array<br>example:<br><code>["Google Pay","Salesforce"]</code>'
        keywords:
          type: array
          items:
            type: string
          description: '<em>target keywords in the domain''s title, description or meta keywords</em><br><strong>required field if you don''t specify <code>groups</code>, <code>technology_paths</code>, <code>technologies</code> or <code>categories</code></strong><br>optional field<br>you can specify the maximum of 10 keywords;<br>UTF-8 encoding;<br>example:<br><code>["seo","software"]</code><p>learn more about rules and limitations of <code>keyword</code> and <code>keywords</code> fields in DataForSEO APIs in this <a href="https://dataforseo.com/help-center/rules-and-limitations-of-keyword-and-keywords-fields-in-dataforseo-apis" rel="noopener noreferrer" target="_blank">Help Center article</a>'
        mode:
          type: string
          description: '<em>search mode</em><br>optional field<br>possible search mode types:<br><code>as_is</code> - search for results exactly matching the specified group ids, category ids, or technology names<br><code>entry</code> - search for results matching a part of the specified group ids, category ids, or technology names<br>default value: <code>as_is</code>'
          nullable: true
        filters:
          type: array
          items:
            type: object
            nullable: true
          description: '<em>array of results filtering parameters</em><br>optional field<br><strong>you can add several filters at once (8 filters maximum)</strong><br>you should set a logical operator <code>and</code>, <code>or</code> between the conditions<br>the following operators are supported:<br><code>&lt;</code>, <code>&lt;=</code>, <code>&gt;</code>, <code>&gt;=</code>, <code>=</code>, <code>&lt;&gt;</code>, <code>in</code>, <code>not_in</code>, <code>like</code>, <code>not_like</code><br>you can use the <code>%</code> operator with <code>like</code> and <code>not_like</code> to match any string of zero or more characters<br>example:<br><code>["country_iso_code","=","US"]</code><p><code>[["country_iso_code","=","US"],<br>"and",<br>["domain_rank","&gt;",100]]</code><p><code>[["domain_rank","&gt;",100],<br>"and",<br>[["country_iso_code","=","US"],"or",["country_iso_code","=","CA"]]]</code><p>for more information about filters, please refer to <a href="/v3/domain_analytics/technologies/filters" target="_blank" rel="noopener noreferrer">Domain Analytics Technologies API - Filters</a>'
          nullable: true
        order_by:
          type: array
          items:
            type: string
          description: '<em>results sorting rules</em><br>optional field<br>available fields: <br><code>domain_rank</code>, <code>domain</code>, <code>last_visited</code>, <code>country_iso_code</code>, <code>language_code</code>, <code>content_language_code</code><br>possible sorting types:<br><code>asc</code> - results will be sorted in the ascending order<br><code>desc</code> - results will be sorted in the descending order<br>you should use a comma to set up a sorting type<br>example:<br><code>["last_visited,desc"]</code><br>default rule:<br><code>["domain_rank,desc"]</code><br><strong>note that you can set no more than three sorting rules in a single request</strong><br>you should use a comma to separate several sorting rules<br>example:<br><code>["last_visited,desc","domain_rank,desc"]</code>'
          nullable: true
        limit:
          type: integer
          description: '<em>the maximum number of returned domains</em><br>optional field<br>default value: <code>100</code><br>maximum value: <code>10000</code>'
          nullable: true
        offset:
          type: integer
          description: '<em>offset in the results array of returned domains</em><br>optional field<br>default value: <code>0</code><br>if you specify the <code>10</code> value, the first ten domains in the results array will be omitted and the data will be provided for the successive domains;<br><strong>Note:</strong> the maximum value is <code>9999</code>, the sum of <code>limit</code> and <code>offset</code> must not exceed <code>10000</code>;<br>use the <code>offset_token</code> if you would like to offset more results'
          nullable: true
        offset_token:
          type: string
          description: '<em>token for subsequent requests</em><br>optional field<br>provided in the identical filed of the response to each request;<br>use this parameter to avoid timeouts while trying to obtain over 100,000 results in a single request;<br>by specifying the unique <code>offset_token</code> value from the response array, you will get the subsequent results of the initial task;<br><code>offset_token</code> values are unique for each subsequent task <br><strong>Note:</strong> if the <code>offset_token</code> is specified in the request, all other parameters should be identical to the previous request<br>learn more about this parameter on our <a href="https://dataforseo.com/help-center/what-is-the-difference-between-the-offset-and-offset_token-parameters#offset_token" target="_blank">Help Center</a>'
          nullable: true
      example:
        - technologies:
            - Nginx
          filters:
            - 
              - country_iso_code
              - =
              - US
            - and
            - 
              - domain_rank
              - '>'
              - 800
          order_by:
            - 'last_visited,desc'
          limit: 10
    DomainAnalyticsTechnologiesDomainsByLiveItem:
      type: object
      properties:
        type:
          type: string
          description: type of element
          nullable: true
        domain:
          type: string
          description: <em>specified domain name</em>
          nullable: true
        title:
          type: string
          description: <em>domain meta title</em>
          nullable: true
        description:
          type: string
          description: <em>domain meta description</em>
          nullable: true
        meta_keywords:
          type: array
          items:
            type: string
            nullable: true
          description: <em>domain meta keywords</em>
          nullable: true
        domain_rank:
          type: integer
          description: <em>backlink rank of the target domain</em><br>learn more about the metric and how it is calculated in <a href="https://dataforseo.com/help-center/what_is_rank_in_backlinks_api" rel="noopener noreferrer" target="_blank">this help center article</a>
          nullable: true
        last_visited:
          type: string
          description: '<em>most recent date when our crawler visited the domain</em><br>in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”<br>example:<br><code>2022-10-10 12:57:46 +00:00</code>'
          nullable: true
        country_iso_code:
          type: string
          description: <em>domain ISO code</em><br>ISO code of the country that target domain is determined to belong to
          nullable: true
        language_code:
          type: string
          description: <em>domain language</em><br>code of the language that target domain is determined to be associated with
          nullable: true
        content_language_code:
          type: string
          description: <em>content language</em><br>code of the language that content on the target domain is written with
          nullable: true
        phone_numbers:
          type: array
          items:
            type: string
            nullable: true
          description: <em>phone numbers of the target</em><br>contact phone numbers indicated on the target website
          nullable: true
        emails:
          type: array
          items:
            type: string
            nullable: true
          description: <em>emails of the target</em><br>emails indicated on the target website
          nullable: true
        social_graph_urls:
          type: array
          items:
            type: string
            nullable: true
          description: <em>social media links and handles</em><br>social media URLs detected in the social graphs of the target website
          nullable: true
        technologies:
          type: object
          oneOf:
            - $ref: '#/components/schemas/TechnologiesInfo'
          description: '<em>technologies used by target domain</em><br>contains objects with the names of technologies used on the website;<br>to get a full list of technologies and their structure, refer to the <a href="/v3/domain_analytics/technologies/technologies/">technologies endpoint</a>'
          nullable: true
      description: items array
    DomainAnalyticsTechnologiesDomainsByTechnologyLiveResultInfo:
      type: object
      properties:
        total_count:
          type: integer
          description: <em>total number of relevant items in the database</em>
          format: int64
          nullable: true
        items_count:
          type: integer
          description: <em>number of items in the results array</em>
          format: int64
          nullable: true
        offset:
          type: integer
          description: <em>specified offset value</em>
          nullable: true
        offset_token:
          type: string
          description: '<em>token for subsequent requests</em><br>by specifying the unique <code>offset_token</code> when setting a new task, you will get the subsequent results of the initial task;<br><code>offset_token</code> values are unique for each subsequent task'
          nullable: true
        items:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/DomainAnalyticsTechnologiesDomainsByLiveItem'
            nullable: true
          description: <em>items array</em>
          nullable: true
    DomainAnalyticsTechnologiesDomainsByTechnologyLiveTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/DomainAnalyticsTechnologiesDomainsByTechnologyLiveResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    DomainAnalyticsTechnologiesDomainsByTechnologyLiveResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/DomainAnalyticsTechnologiesDomainsByTechnologyLiveTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    DomainAnalyticsTechnologiesDomainsByHtmlTermsLiveRequestInfo:
      type: object
      properties:
        search_terms:
          type: array
          items:
            type: string
          description: '<em>target search terms</em><br><strong>required field</strong><br>specify target HTML elements, tags, attributes, their content or all of the above<br>if you specify more than one search term, you will receive only the domains containing all of the specified terms in the HTML code of their homepage<br>maximum number of search terms you can specify: 10<br>example:<br><code>["data-attrid"]</code>'
        keywords:
          type: array
          items:
            type: string
          description: '<em>target keywords in the domain''s title, description or meta keywords</em><br>optional field<br>UTF-8 encoding<br>maximum number of keywords you can specify: 10 <br>example:<br><code>["seo","software"]</code><p>learn more about rules and limitations of <code>keyword</code> and <code>keywords</code> fields in DataForSEO APIs in this <a href="https://dataforseo.com/help-center/rules-and-limitations-of-keyword-and-keywords-fields-in-dataforseo-apis" rel="noopener noreferrer" target="_blank">Help Center article</a>'
          nullable: true
        mode:
          type: string
          description: '<em>search mode</em><br>optional field<br>possible search mode types:<br><code>strict_entry</code> - search for results exactly matching the order, intervals and separators in the specified search terms<br><code>entry</code> - search for results ignoring the order, intervals and separators in the specified search terms<br>default value: <code>entry</code>'
          nullable: true
        filters:
          type: array
          items:
            type: object
            nullable: true
          description: '<em>array of results filtering parameters</em><br>optional field<br><strong>you can add several filters at once (8 filters maximum)</strong><br>you should set a logical operator <code>and</code>, <code>or</code> between the conditions<br>the following operators are supported:<br><code>&lt;</code>, <code>&lt;=</code>, <code>&gt;</code>, <code>&gt;=</code>, <code>=</code>, <code>&lt;&gt;</code>, <code>in</code>, <code>not_in</code>, <code>like</code>, <code>not_like</code><br>you can use the <code>%</code> operator with <code>like</code> and <code>not_like</code> to match any string of zero or more characters<br>example:<br><code>["domain","like","%seo%"]</code><p><code>[["country_iso_code","=","US"],<br>"and",<br>["domain_rank","&gt;",100]]</code><p><code>[["domain_rank","&gt;",100],<br>"and",<br>[["country_iso_code","=","US"],"or",["country_iso_code","=","CA"]]]</code><p>for more information about filters, please refer to <a href="/v3/domain_analytics/technologies/filters" target="_blank" rel="noopener noreferrer">Domain Analytics Technologies API - Filters</a>'
          nullable: true
        order_by:
          type: array
          items:
            type: string
          description: '<em>results sorting rules</em><br>optional field<br>available fields: <br><code>domain_rank</code>, <code>domain</code>, <code>last_visited</code>, <code>country_iso_code</code>, <code>language_code</code>, <code>content_language_code</code><br>possible sorting types:<br><code>asc</code> - results will be sorted in the ascending order<br><code>desc</code> - results will be sorted in the descending order<br>you should use a comma to set up a sorting type<br>example:<br><code>["last_visited,desc"]</code><br>default rule:<br><code>["domain_rank,desc"]</code><br><strong>note that you can set no more than three sorting rules in a single request</strong><br>you should use a comma to separate several sorting rules<br>example:<br><code>["last_visited,desc","domain_rank,desc"]</code>'
          nullable: true
        limit:
          type: integer
          description: '<em>the maximum number of returned domains</em><br>optional field<br>default value: <code>100</code><br>maximum value: <code>10000</code>'
          nullable: true
        offset:
          type: integer
          description: '<em>offset in the results array of returned domains</em><br>optional field<br>default value: <code>0</code><br>if you specify the <code>10</code> value, the first ten domains in the results array will be omitted and the data will be provided for the successive domains;<br><strong>Note:</strong> the maximum value is <code>9999</code>, the sum of <code>limit</code> and <code>offset</code> must not exceed <code>10000</code>;<br>use the <code>offset_token</code> if you would like to offset more results'
          nullable: true
        offset_token:
          type: string
          description: '<em>token for subsequent requests</em><br>optional field<br>provided in the identical filed of the response to each request;<br>use this parameter to avoid timeouts while trying to obtain over 100,000 results in a single request;<br>by specifying the unique <code>offset_token</code> value from the response array, you will get the subsequent results of the initial task;<br><code>offset_token</code> values are unique for each subsequent task <br><strong>Note:</strong> if the <code>offset_token</code> is specified in the request, all other parameters should be identical to the previous request<br>learn more about this parameter on our <a href="https://dataforseo.com/help-center/what-is-the-difference-between-the-offset-and-offset_token-parameters#offset_token" target="_blank">Help Center</a>'
          nullable: true
      example:
        - search_terms:
            - data-attrid
          order_by:
            - 'last_visited,desc'
          limit: 10
          offset: 0
    DomainAnalyticsTechnologiesDomainsByHtmlTermsLiveResultInfo:
      type: object
      properties:
        total_count:
          type: integer
          description: <em>total number of relevant items in the database</em>
          format: int64
          nullable: true
        items_count:
          type: integer
          description: <em>number of items in the results array</em>
          format: int64
          nullable: true
        offset:
          type: integer
          description: <em>specified offset value</em>
          nullable: true
        offset_token:
          type: string
          description: '<em>token for subsequent requests</em><br>by specifying the unique <code>offset_token</code> when setting a new task, you will get the subsequent results of the initial task;<br><code>offset_token</code> values are unique for each subsequent task'
          nullable: true
        items:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/DomainAnalyticsTechnologiesDomainsByLiveItem'
            nullable: true
          description: <em>items array</em>
          nullable: true
    DomainAnalyticsTechnologiesDomainsByHtmlTermsLiveTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/DomainAnalyticsTechnologiesDomainsByHtmlTermsLiveResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    DomainAnalyticsTechnologiesDomainsByHtmlTermsLiveResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/DomainAnalyticsTechnologiesDomainsByHtmlTermsLiveTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    DomainAnalyticsTechnologiesDomainTechnologiesLiveRequestInfo:
      type: object
      properties:
        target:
          type: string
          description: <em>target domain</em><br><strong>required field</strong><br>domain name of the website to analyze<br><strong>Note:</strong> results will be returned for the specified domain only
      example:
        - target: dataforseo.com
    DomainAnalyticsTechnologiesDomainTechnologiesLiveResultInfo:
      type: object
      properties:
        type:
          type: string
          description: type of element
          nullable: true
        domain:
          type: string
          description: <em>specified domain name</em>
          nullable: true
        title:
          type: string
          description: <em>domain meta title</em>
          nullable: true
        description:
          type: string
          description: <em>domain meta description</em>
          nullable: true
        meta_keywords:
          type: array
          items:
            type: string
            nullable: true
          description: <em>domain meta keywords</em>
          nullable: true
        domain_rank:
          type: integer
          description: <em>backlink rank of the target domain</em><br>learn more about the metric and how it is calculated in <a href="https://dataforseo.com/help-center/what_is_rank_in_backlinks_api" rel="noopener noreferrer" target="_blank">this help center article</a>
          nullable: true
        last_visited:
          type: string
          description: '<em>most recent date when our crawler visited the domain</em><br>in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”<br>example:<br><code>2022-10-10 12:57:46 +00:00</code>'
          nullable: true
        country_iso_code:
          type: string
          description: <em>domain ISO code</em><br>ISO code of the country that the target domain is determined to belong to
          nullable: true
        language_code:
          type: string
          description: <em>domain language</em><br>code of the language that the target domain is determined to be associated with
          nullable: true
        content_language_code:
          type: string
          description: <em>content language</em><br>code of the language that content on the target domain is written in
          nullable: true
        phone_numbers:
          type: array
          items:
            type: string
            nullable: true
          description: <em>phone numbers of the target</em><br>contact phone numbers indicated on the target website
          nullable: true
        emails:
          type: array
          items:
            type: string
            nullable: true
          description: <em>emails of the target</em><br>emails indicated on the target website
          nullable: true
        social_graph_urls:
          type: array
          items:
            type: string
            nullable: true
          description: <em>social media links and handles</em><br>social media URLs detected in the social graphs of the target website
          nullable: true
        technologies:
          type: object
          oneOf:
            - $ref: '#/components/schemas/TechnologiesInfo'
          description: <em>technologies used by target domain</em><br>contains objects with the names of technologies used on the website<br><a href="/v3/domain_analytics/technologies/technologies/" rel="noopener noreferrer" target="_blank">see the full list of available technologies structured by groups and categories</a>
          nullable: true
    DomainAnalyticsTechnologiesDomainTechnologiesLiveTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/DomainAnalyticsTechnologiesDomainTechnologiesLiveResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    DomainAnalyticsTechnologiesDomainTechnologiesLiveResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/DomainAnalyticsTechnologiesDomainTechnologiesLiveTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    DomainAnalyticsWhoisAvailableFiltersResultInfo:
      type: object
      properties:
        overview:
          type: object
          additionalProperties:
            type: string
            nullable: true
          nullable: true
    DomainAnalyticsWhoisAvailableFiltersTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/DomainAnalyticsWhoisAvailableFiltersResultInfo'
                nullable: true
              nullable: true
    DomainAnalyticsWhoisAvailableFiltersResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/DomainAnalyticsWhoisAvailableFiltersTaskInfo'
                nullable: true
              nullable: true
    DomainAnalyticsWhoisOverviewLiveRequestInfo:
      type: object
      properties:
        limit:
          type: integer
          description: '<em>the maximum number of returned domains</em><br>optional field<br>default value: <code>100</code><br>maximum value: <code>1000</code>'
          nullable: true
        offset:
          type: integer
          description: '<em>offset in the results array of returned items</em><br>optional field<br>default value: <code>0</code><br>if you specify the <code>10</code> value, the first ten <code>items</code> in the results array will be omitted and the data will be provided for the successive items;<br><strong>Note:</strong> we recommend using this parameter only when retrieving up to 10,000 results for retrieving over 10,000 results, use the <code>offset_token</code> instead'
          nullable: true
        offset_token:
          type: string
          description: '<em>token for subsequent requests</em><br>optional field<br>provided in the identical filed of the response to each request;<br>use this parameter to avoid timeouts while trying to obtain over 100,000 results in a single request;<br>by specifying the unique <code>offset_token</code> value from the response array, you will get the subsequent results of the initial task;<br><code>offset_token</code> values are unique for each subsequent task<br><strong>Note:</strong> if the <code>offset_token</code> is specified in the request, all other parameters should be identical to the previous request<br>learn more about this parameter on our <a href="https://dataforseo.com/help-center/what-is-the-difference-between-the-offset-and-offset_token-parameters#offset_token" target="_blank">Help Center</a>'
          nullable: true
        filters:
          type: array
          items:
            type: object
            nullable: true
          description: '<em>array of results filtering parameters</em><br>optional field<br><strong>you can add several filters at once (8 filters maximum)</strong><br>you should set a logical operator <code>and</code>, <code>or</code> between the conditions<br>the following operators are supported:<br><code>regex</code>, <code>&lt;</code>, <code>&lt;=</code>, <code>&gt;</code>, <code>&gt;=</code>, <code>=</code>, <code>&lt;&gt;</code>, <code>in</code>, <code>not_in</code>, <code>like</code>, <code>not_like</code><br>you can use the <code>%</code> operator with <code>like</code> and <code>not_like</code> to match any string of zero or more characters'
          nullable: true
        order_by:
          type: array
          items:
            type: string
          description: '<em>results sorting rules</em><br>optional field<br>you can use the same values as in the <code>filters</code> array to sort the results<br>possible sorting types:<br><code>asc</code> - results will be sorted in the ascending order<br><code>desc</code> - results will be sorted in the descending order<br>the comma is used as a separator<br>example:<br><code>["metrics.organic.pos_1,desc"]</code><br>default rule:<br><code>["metrics.organic.count,desc"]</code><br><strong>note that you can set no more than three sorting rules in a single request</strong><br>you should use a comma to separate several sorting rules<br>example:<br><code>["expiration_datetime,asc","metrics.organic.etv,desc","metrics.organic.pos_1,desc"]</code>'
          nullable: true
        tag:
          type: string
          description: <em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response
          nullable: true
      example:
        - limit: 2
          filters:
            - 
              - epp_status_codes
              - in
              - 
                - client_transfer_prohibited
                - client_update_prohibited
    MetricsInfo:
      type: object
      properties:
        pos_1:
          type: integer
          description: '<em>number of organic SERPs where the domain ranks #1</em>'
          nullable: true
        pos_2_3:
          type: integer
          description: '<em>number of organic SERPs where the domain ranks #2-3</em>'
          nullable: true
        pos_4_10:
          type: integer
          description: '<em>number of organic SERPs where the domain ranks #4-10</em>'
          nullable: true
        pos_11_20:
          type: integer
          description: '<em>number of organic SERPs where the domain ranks #11-20</em>'
          nullable: true
        pos_21_30:
          type: integer
          description: '<em>number of organic SERPs where the domain ranks #21-30</em>'
          nullable: true
        pos_31_40:
          type: integer
          description: '<em>number of organic SERPs where the domain ranks #31-40</em>'
          nullable: true
        pos_41_50:
          type: integer
          description: '<em>number of organic SERPs where the domain ranks #41-50</em>'
          nullable: true
        pos_51_60:
          type: integer
          description: '<em>number of organic SERPs where the domain ranks #51-60</em>'
          nullable: true
        pos_61_70:
          type: integer
          description: '<em>number of organic SERPs where the domain ranks #61-70</em>'
          nullable: true
        pos_71_80:
          type: integer
          description: '<em>number of organic SERPs where the domain ranks #71-80</em>'
          nullable: true
        pos_81_90:
          type: integer
          description: '<em>number of organic SERPs where the domain ranks #81-90</em>'
          nullable: true
        pos_91_100:
          type: integer
          description: '<em>number of organic SERPs where the domain ranks #91-100</em>'
          nullable: true
        etv:
          type: number
          description: <em>estimated traffic volume</em><br>estimated organic monthly traffic to the domain<br>calculated as the product of CTR (click-through-rate) and search volume values of all keywords the domain ranks for<br>learn more about how the metric is calculated in <a href="https://dataforseo.com/help-center/how-is-etv-calculated" rel="noopener noreferrer" target="_blank">this help center article</a>
          nullable: true
        count:
          type: integer
          description: <em>total count of organic SERPs that contain the domain</em>
          format: int64
          nullable: true
        estimated_paid_traffic_cost:
          type: number
          description: <em>estimated cost of converting organic search traffic into paid</em><br>represents the estimated monthly cost of running ads (USD) for all keywords a domain ranks for<br>the metric is calculated as the product of organic <code>etv</code> and paid <code>cpc</code> values and indicates the cost of driving the estimated volume of monthly organic traffic through PPC advertising in Google Search<br>learn more about how the metric is calculated in <a href="https://dataforseo.com/help-center/how-is-traffic-cost-calculated" rel="noopener noreferrer" target="_blank">this help center article</a>
          nullable: true
        is_new:
          type: integer
          description: "number of new ranked elements\nindicates how many new ranked elements were found for this domain"
          format: int64
          nullable: true
        is_up:
          type: integer
          description: "rank went up\nindicates how many ranked elements of this domain went up in Google Search"
          format: int64
          nullable: true
        is_down:
          type: integer
          description: "rank went down\nindicates how many ranked elements of this domain went down in Google Search"
          format: int64
          nullable: true
        is_lost:
          type: integer
          description: "lost ranked elements\nindicates how many ranked elements of this domain were previously presented in SERPs, but weren’t found during the last check"
          format: int64
          nullable: true
    MetricsBundleInfo:
      type: object
      properties:
        organic:
          type: object
          oneOf:
            - $ref: '#/components/schemas/MetricsInfo'
          properties:
            is_new:
              type: integer
              description: "number of new ranked elements\nindicates how many new ranked elements were found for this domain"
              format: int64
              nullable: true
            is_up:
              type: integer
              description: "rank went up\nindicates how many ranked elements of this domain went up in Google Search"
              format: int64
              nullable: true
            is_down:
              type: integer
              description: "rank went down\nindicates how many ranked elements of this domain went down in Google Search"
              format: int64
              nullable: true
            is_lost:
              type: integer
              description: "lost ranked elements\nindicates how many ranked elements of this domain were previously presented in SERPs, but weren’t found during the last check"
              format: int64
              nullable: true
          description: <em>ranking and traffic data from organic search</em>
          nullable: true
        paid:
          type: object
          oneOf:
            - $ref: '#/components/schemas/MetricsInfo'
          description: <em>ranking and traffic data from paid search</em>
          nullable: true
    DomainAnalyticsWhoisOverviewLiveItem:
      type: object
      properties:
        domain:
          type: string
          description: <em>domain name</em>
          nullable: true
        created_datetime:
          type: string
          description: '<em>date and time of registration</em><br>date and time (in the <a href="https://en.wikipedia.org/wiki/ISO_8601" rel="noopener noreferrer" target="_blank">ISO 8601 format</a>) when the domain was first registered <br>example: <br><code>"1997-03-29 03:00:00 +00:00"</code>'
          nullable: true
        changed_datetime:
          type: string
          description: '<em>date and time when the domain entry was changed</em><br>date and time (in the <a href="https://en.wikipedia.org/wiki/ISO_8601" rel="noopener noreferrer" target="_blank">ISO 8601 format</a>) when the domain entry was last modified<br>example: <br><code>"2021-01-14 08:36:28 +00:00"</code>'
          nullable: true
        expiration_datetime:
          type: string
          description: '<em>date and time when the domain will expire</em><br>date and time (in the <a href="https://en.wikipedia.org/wiki/ISO_8601" rel="noopener noreferrer" target="_blank">ISO 8601 format</a>) when the domain is due to expire <br>example: <br><code>"2022-11-26 17:21:23 +00:00"</code>'
          nullable: true
        updated_datetime:
          type: string
          description: '<em>date and time when the domain was updated</em><br>date and time (in the <a href="https://en.wikipedia.org/wiki/ISO_8601" rel="noopener noreferrer" target="_blank">ISO 8601 format</a>) when the domain was last updated <br>example: <br><code>"2021-01-29 13:59:38 +00:00"</code>'
          nullable: true
        first_seen:
          type: string
          description: '<em>date and time when our crawler found the domain for the first time</em><br>in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”<br>example: <br><code>"2019-11-15 12:57:46 +00:00"</code>'
          nullable: true
        epp_status_codes:
          type: array
          items:
            type: string
            nullable: true
          description: <em>extensive provisioning protocol status codes</em><br>the status of a domain name registration <a href="https://www.icann.org/resources/pages/epp-status-codes-2014-06-16-en" rel="noopener noreferrer" target="_blank">as defined by ICANN</a>
          nullable: true
        tld:
          type: string
          description: <em>top-level domain</em><br>top-level domain in the <a href="https://www.iana.org/domains/root/db" rel="noopener noreferrer" target="_blank">DNS root zone</a>
          nullable: true
        registered:
          type: boolean
          description: '<em>domain registration status</em><br>if <code>false</code>, the domain name registration has expired<br><strong>Note: expired domains will remain in the database for only a short period of time</strong>'
          nullable: true
        registrar:
          type: string
          description: '<em>domain registrar</em><br>if <code>null</code>, the domain registrar is unknown<br>example:<br><code>NameCheap, Inc.</code>'
          nullable: true
        metrics:
          type: object
          oneOf:
            - $ref: '#/components/schemas/MetricsBundleInfo'
          description: <em>ranking data relevant to the specified domain</em>
          nullable: true
        backlinks_info:
          type: object
          oneOf:
            - $ref: '#/components/schemas/BacklinksInfo'
          description: <em>backlink data for the returned domain</em>
          nullable: true
      description: items array
    DomainAnalyticsWhoisOverviewLiveResultInfo:
      type: object
      properties:
        total_count:
          type: integer
          description: <em>total amount of results in our database relevant to your request</em>
          format: int64
          nullable: true
        items_count:
          type: integer
          description: <em>the number of results returned in the <code>items</code> array</em>
          format: int64
          nullable: true
        offset:
          type: integer
          description: <em> results offset value specified in POST request</em>
          nullable: true
        offset_token:
          type: string
          nullable: true
        items:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/DomainAnalyticsWhoisOverviewLiveItem'
            nullable: true
          description: <em>contains ranking and traffic data</em>
          nullable: true
    DomainAnalyticsWhoisOverviewLiveTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/DomainAnalyticsWhoisOverviewLiveResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    DomainAnalyticsWhoisOverviewLiveResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/DomainAnalyticsWhoisOverviewLiveTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    KeywordsDataIdListRequestInfo:
      type: object
      properties:
        datetime_from:
          type: string
          description: '<em>start time for filtering results</em><br><strong>required field</strong><br>if <code>include_metadata</code> is set to <code>true</code>, maximum value: a month from current datetime;<br>if <code>include_metadata</code> is set to <code>false</code>, maximum value: six months from current datetime;<br>must be specified in the UTC format: "yyyy-mm-dd hh-mm-ss +00:00"<br>example:<br><code>2023-01-15 12:57:46 +00:00</code>'
        datetime_to:
          type: string
          description: '<em>finish time for filtering results</em><br><strong>required field</strong><br>maximum value: current datetime;<br>must be specified in the UTC format: "yyyy-mm-dd hh-mm-ss +00:00"<br>example:<br><code>2023-01-31 13:57:46 +00:00</code>'
        limit:
          type: integer
          description: '<em>the maximum number of returned task IDs</em><br>optional field<br>default value: <code>1000</code><br>maximum value: <code>1000</code>'
          nullable: true
        offset:
          type: integer
          description: '<em>offset in the results array of returned task IDs</em><br>optional field<br>default value: <code>0</code><br>if you specify the <code>10</code> value, the first ten tasks in the results array will be omitted'
          nullable: true
        sort:
          type: string
          description: '<em>sorting by task execution time</em><br>optional field<br>possible values: <code>"asc"</code>, <code>"desc"</code><br>default value: <code>"asc"</code>'
          nullable: true
        include_metadata:
          type: boolean
          description: '<em>include task metadata in the respond</em><br>optional field<br>default value: <code>false</code>'
          nullable: true
      example:
        - datetime_from: '2026-09-10 11:12:35'
          datetime_to: '2026-09-20 11:12:35'
          limit: 10
          include_metadata: true
    KeywordsDataIdListResultInfo:
      type: object
      properties:
        id:
          type: string
          description: <em>task identifier</em><br><strong>unique task identifier in our system in the <a href="https://en.wikipedia.org/wiki/Universally_unique_identifier">UUID</a> format</strong>
          nullable: true
        url:
          type: string
          description: <em>URL of the task</em><br>URL you used for making an API call
          nullable: true
        datetime_posted:
          type: string
          description: '<em>date and time when the task was made</em><br>in the UTC format: "yyyy-mm-dd hh-mm-ss +00:00"<br>example:<br><code>2023-01-15 12:57:46 +00:00</code>'
          nullable: true
        datetime_done:
          type: string
          description: '<em>date and time when the task was completed</em><br>in the UTC format: "yyyy-mm-dd hh-mm-ss +00:00"<br>example:<br><code>2023-01-15 12:57:46 +00:00</code>'
          nullable: true
        status:
          type: string
          description: <em>informational message of the task</em><br>you can find the full list of general informational messages <a href="/v3/appendix-errors/">here</a>
          nullable: true
        cost:
          type: number
          description: '<em>total tasks cost, USD</em>'
          nullable: true
        metadata:
          type: object
          additionalProperties:
            type: object
            nullable: true
          description: <em>contains parameters you specified in the POST request</em>
          nullable: true
    KeywordsDataIdListTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/KeywordsDataIdListResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    KeywordsDataIdListResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/KeywordsDataIdListTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    KeywordsDataErrorsRequestInfo:
      type: object
      properties:
        limit:
          type: integer
          description: '<em>the maximum number of returned tasks that responded with an error</em><br>optional field<br>default value: <code>1000</code><br>maximum value: <code>1000</code>'
          nullable: true
        offset:
          type: integer
          description: '<em>offset in the results array of returned tasks</em><br>optional field<br>default value: <code>0</code><br>if you specify the <code>10</code> value, the first ten tasks in the results array will be omitted and the data will be provided for the successive tasks'
          nullable: true
        filtered_function:
          type: string
          description: '<em>return tasks with a certain function</em><br>use this field to obtain a list of tasks that returned an error filtered by a certain function<br>you can filter the results by the values you receive in the <code>function</code> fields of the API response<br>i.e., once you receive unfiltered results, you can call this API again to filter them by <code>function</code> <br>example: <code>keywords_data/keywords_for_site/task_post</code>, <code>postback_url</code>, <code>pingback_url</code>'
          nullable: true
        datetime_from:
          type: string
          description: '<em>start time for filtering results</em><br>optional field<br>allows filtering results by the <code>datetime</code> parameter within the range of the last 7 days;<br>must be specified in the UTC format: "yyyy-mm-dd hh-mm-ss +00:00"<br>example:<br><code>2021-11-15 12:57:46 +00:00</code>'
          nullable: true
        datetime_to:
          type: string
          description: '<em>finish time for filtering results</em><br>optional field<br>allows filtering results by the <code>datetime</code> parameter within the range of the last 7 days;<br>must be specified in the UTC format: "yyyy-mm-dd hh-mm-ss +00:00"<br>example:<br><code>2021-11-15 13:57:46 +00:00</code>'
          nullable: true
      example:
        - limit: 10
          offset: 0
          filtered_function: pingback_url
    KeywordsDataErrorsResultInfo:
      type: object
      properties:
        id:
          type: string
          description: <em>task identifier</em><br><strong>unique task identifier in our system in the <a href="https://en.wikipedia.org/wiki/Universally_unique_identifier">UUID</a> format</strong>
          nullable: true
        datetime:
          type: string
          description: '<em>date and time when an error occurred</em><br>in the UTC format: "yyyy-mm-dd hh-mm-ss +00:00"<br>example:<br><code>2019-11-15 12:57:46 +00:00</code>'
          nullable: true
        function:
          type: string
          description: <em>corresponding API function</em>
          nullable: true
        error_code:
          type: integer
          description: <em>error code</em>
          nullable: true
        error_message:
          type: string
          description: <em>error message or error URL</em><br>error message <a href="https://docs.dataforseo.com/v3/appendix/errors/" rel="noopener noreferrer" target="_blank">(see full list)</a> or URL that caused an error
          nullable: true
        http_url:
          type: string
          description: <em>URL that caused an error</em><br>URL you used for making an API call or pingback/postback URL
          nullable: true
        http_method:
          type: string
          description: <em>HTTP method</em>
          nullable: true
        http_code:
          type: integer
          description: <em>HTTP status code</em>
          nullable: true
        http_time:
          type: number
          description: '<em>time taken by HTTP request</em><br>for tasks set with a pingback/postback, this field will show the time it took your server to respond'
          nullable: true
        http_response:
          type: string
          description: <em>HTTP response</em><br>server response
          nullable: true
    KeywordsDataErrorsTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/KeywordsDataErrorsResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    KeywordsDataErrorsResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/KeywordsDataErrorsTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    KeywordsDataGoogleAdsStatusResultInfo:
      type: object
      properties:
        actual_data:
          type: boolean
          description: '<em>indicates whether Google updated keyword data for the previous month</em><br>generally, Google updates keyword data in the middle of the month<br>if the value is <code>true</code>, Google currently provides up-to-date data for the previous month<br>if the value is <code>false</code>, we are not able to provide data for the previous month'
          nullable: true
        date_update:
          type: string
          description: '<em>date of the latest update of Google Ads data</em><br>indicates the latest date when Google updated search volume, CPC, and other keyword metrics<br>example:<br><code>2020-05-15</code>'
          nullable: true
        last_year_in_monthly_searches:
          type: integer
          description: <em>the latest year for which search volume data is available</em>
          nullable: true
        last_month_in_monthly_searches:
          type: integer
          description: <em>the latest month for which search volume data is available</em>
          nullable: true
    KeywordsDataGoogleAdsStatusTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/KeywordsDataGoogleAdsStatusResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    KeywordsDataGoogleAdsStatusResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/KeywordsDataGoogleAdsStatusTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    KeywordsDataGoogleAdsLocationsResultInfo:
      type: object
      properties:
        location_code:
          type: integer
          description: <em>location code</em>
          nullable: true
        location_name:
          type: string
          description: <em>full name of the location</em>
          nullable: true
        location_code_parent:
          type: integer
          description: '<em>the code of the superordinate location</em><br>example:<br><code>"location_code": 9041134,<br>"location_name": "Vienna International Airport,Lower Austria,Austria",<br>"location_code_parent": 20044</code><p>where <code>location_code_parent</code> corresponds to:<p><code>"location_code": 20044,<br>"location_name": "Lower Austria,Austria"</code>'
          nullable: true
        country_iso_code:
          type: string
          description: <em>ISO country code of the location</em>
          nullable: true
        location_type:
          type: string
          description: <em>location type</em><br>possible values according to <a href="https://developers.google.com/adwords/api/docs/appendix/geotargeting" target="_blank" rel="noopener noreferrer">Google’s target types</a>
          nullable: true
    KeywordsDataGoogleAdsLocationsTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/KeywordsDataGoogleAdsLocationsResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    KeywordsDataGoogleAdsLocationsResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/KeywordsDataGoogleAdsLocationsTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    KeywordsDataGoogleAdsLocationsCountryResultInfo:
      type: object
      properties:
        location_code:
          type: integer
          description: <em>location code</em>
          nullable: true
        location_name:
          type: string
          description: <em>full name of the location</em>
          nullable: true
        location_code_parent:
          type: integer
          description: '<em>the code of the superordinate location</em><br>example:<br><code>"location_code": 9041134,<br>"location_name": "Vienna International Airport,Lower Austria,Austria",<br>"location_code_parent": 20044</code><p>where <code>location_code_parent</code> corresponds to:<p><code>"location_code": 20044,<br>"location_name": "Lower Austria,Austria"</code>'
          nullable: true
        country_iso_code:
          type: string
          description: <em>ISO country code of the location</em>
          nullable: true
        location_type:
          type: string
          description: <em>location type</em><br>possible values according to <a href="https://developers.google.com/adwords/api/docs/appendix/geotargeting" target="_blank" rel="noopener noreferrer">Google’s target types</a>
          nullable: true
    KeywordsDataGoogleAdsLocationsCountryTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/KeywordsDataGoogleAdsLocationsCountryResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    KeywordsDataGoogleAdsLocationsCountryResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/KeywordsDataGoogleAdsLocationsCountryTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    KeywordsDataGoogleAdsLanguagesResultInfo:
      type: object
      properties:
        language_name:
          type: string
          description: <em>language name</em>
          nullable: true
        language_code:
          type: string
          description: <em>language code according to <a href="https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes" target="_blank" rel="noopener noreferrer">ISO 639-1</a></em>
          nullable: true
    KeywordsDataGoogleAdsLanguagesTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/KeywordsDataGoogleAdsLanguagesResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    KeywordsDataGoogleAdsLanguagesResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/KeywordsDataGoogleAdsLanguagesTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    KeywordsDataGoogleAdsSearchVolumeTaskPostRequestInfo:
      type: object
      properties:
        keywords:
          type: array
          items:
            type: string
          description: '<em>keywords</em><br><strong>required field</strong><br>The maximum number of keywords you can specify: 1000<br>The maximum number of characters for each keyword: 80<br>The maximum number of words for each keyword phrase: 10<br>the keywords you specify will be converted to a lowercase format<br><strong>Note #1:</strong> <a href="https://dataforseo.com/help-center/no-search-volume-data-for-some-keywords" target="_blank" rel="noopener noreferrer">Google Ads may return no data for certain groups of keywords</a>;<br><strong>Note #2:</strong> <a href="https://dataforseo.com/help-center/sv-broad-exact-phrase-match" target="_blank" rel="noopener noreferrer">Google Ads provides combined search volume values for groups of similar keywords</a><br>to obtain search volume for similar keywords, we recommend submitting such keywords in separate requests;<br><strong>Note #3:</strong> Google Ads doesn''t allow using certain symbols and characters (e.g., UTF symbols, emojis), so you can''t use them when setting a task;<br>to learn more about which symbols and characters can be used, please refer to <a href="https://dataforseo.com/help-center/using-symbols-in-keywords-when-setting-a-google-ads-task" target="_blank" rel="noopener noreferrer">this article</a><p>learn more about rules and limitations of <code>keyword</code> and <code>keywords</code> fields in DataForSEO APIs in this <a href="https://dataforseo.com/help-center/rules-and-limitations-of-keyword-and-keywords-fields-in-dataforseo-apis" rel="noopener noreferrer" target="_blank">Help Center article</a>'
        location_name:
          type: string
          description: '<em>full name of search engine location</em><br>optional field<br>if you do not indicate the location, you will receive worldwide results, i.e., for all available locations;<br><strong>if you use this field, you don''t need to specify <code>location_code</code> or <code>location_coordinate</code></strong><br>you can receive the list of available locations of the search engine with their <code>location_name</code> by making a separate request to <code>https://api.dataforseo.com/v3/keywords_data/google_ads/locations</code><br>example:<br><code class="long-string">London,England,United Kingdom</code>'
          nullable: true
        location_code:
          type: integer
          description: '<em>search engine location code</em><br>optional field<br>if you do not indicate the location, you will receive worldwide results, i.e., for all available locations;<br><strong>if you use this field, you don''t need to specify <code>location_name</code> or <code>location_coordinate</code></strong>;<br>you can receive the list of available locations of the search engines with their <code>location_code</code> by making a separate request to <code>https://api.dataforseo.com/v3/keywords_data/google_ads/locations</code><br>example:<br><code class="long-string">2840</code>'
          nullable: true
        location_coordinate:
          type: string
          description: '<em>GPS coordinates of a location</em><br>optional field<br>if you do not indicate the location, you will receive worldwide results, i.e., for all available locations;<br><strong>if you use this field, you don''t need to specify <code>location_name</code> or <code>location_code</code></strong>;<br><code>location_coordinate</code> parameter should be specified in the <em>"latitude,longitude"</em> format;<br><strong>the data will be provided for the country the specified coordinates belong to</strong>;<br>example:<br><code class="long-string">52.6178549,-155.352142</code>'
          nullable: true
        language_name:
          type: string
          description: <em>full name of search engine language</em><br>optional field<br>you can receive the list of available languages of the search engine with their <code>language_name</code> by making a separate request to <code>https://api.dataforseo.com/v3/keywords_data/google_ads/languages</code><br>example:<br><code class="long-string">English</code>
          nullable: true
        language_code:
          type: string
          description: <em>search engine language code</em><br>optional field<br>you can receive the list of available languages of the search engine with their <code>language_code</code> by making a separate request to <code>https://api.dataforseo.com/v3/keywords_data/google_ads/languages</code><br>example:<br><code class="long-string">en</code>
          nullable: true
        search_partners:
          type: boolean
          description: '<em>include Google search partners</em><br>optional field<br>if you specify <code class="prettyprint">true</code>, the results will be delivered for owned, operated, and syndicated networks across <a href="https://support.google.com/google-ads/answer/1722047?hl=en" target="_blank" rel="noopener noreferrer">Google and partner sites</a> that host Google search;<br>default value: <code>false</code> - results are returned for Google search sites'
          nullable: true
        date_from:
          type: string
          description: '<em>starting date of the time range</em><br>optional field<br>date format: <code>"yyyy-mm-dd"</code><br>minimal value: 4 years from the current date<br>by default, data is returned for the past 12 months;<br><strong>Note</strong>: the indicated date cannot be greater than that specified in <code>date_to</code> and/or yesterday''s date;<br>if <a href="/v3/keywords_data/google_ads/status/" target="_blank" rel="noopener noreferrer">Status endpoint</a> returns <code>false</code> in the <code>actual_data</code> field, <code>date_from</code> can be set to the month before last and prior;<br>if <a href="/v3/keywords_data/google_ads/status/" target="_blank" rel="noopener noreferrer">Status endpoint</a> returns <code>true</code> in the <code>actual_data</code> field, <code>date_from</code> can be set to the last month and prior'
          nullable: true
        date_to:
          type: string
          description: '<em>ending date of the time range</em><br>optional field<br><strong>Note:</strong> the indicated date cannot be greater than the past month, Google Ads does not return data on the current month;<br>if you don''t specify this field, yesterday''s date will be used by default<br>date format: <code>"yyyy-mm-dd"</code><br>example:<br><code>"2022-11-30"</code>'
          nullable: true
        include_adult_keywords:
          type: boolean
          description: '<em>include keywords associated with adult content<br></em>optional field<em><br></em>if set to_<code>true</code>, adult keywords will be included in the response<br>default value:_<code>false</code><br><strong>note</strong>_that the API may return no data for such keywords due to_<a href="https://support.google.com/adspolicy/answer/6008942?hl=en" target="_blank" rel="noopener noreferrer">Google Ads restrictions</a>n'
          nullable: true
        sort_by:
          type: string
          description: '<em>results sorting parameters</em><br>optional field<br>use these parameters to sort the results by <code>relevance</code>, <code>search_volume</code>, <code>competition_index</code>, <code>low_top_of_page_bid</code>, or <code>high_top_of_page_bid</code> in the descending order<br>default value: <code>relevance</code>'
          nullable: true
        postback_url:
          type: string
          description: '<em>URL for sending task results</em><br>optional field<br>once the task is completed, we will send a POST request with its results compressed in the <code>gzip</code> format to the <code>postback_url</code> you specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/postbackscript?id=$id</code><br><code>http://your-server.com/postbackscript?id=$id&amp;tag=$tag</code><br><strong>Note:</strong> special character in <code>postback_url</code> will be urlencoded;<br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href="https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api" target="_blank" rel="noopener noreferrer">Help Center</a>'
          nullable: true
        pingback_url:
          type: string
          description: '<em>notification URL of a completed task</em><br>optional field<br>when a task is completed we will notify you by GET request sent to the URL you have specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request<br>example:<br><code>http://your-server.com/pingscript?id=$id</code><br><code>http://your-server.com/pingscript?id=$id&amp;tag=$tag</code><br><strong>Note:</strong> special character in <code>pingback_url</code> will be urlencoded;<br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href="https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api" target="_blank" rel="noopener noreferrer">Help Center</a>'
          nullable: true
        tag:
          type: string
          description: <em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> array of the response
          nullable: true
      example:
        - location_name: United States
          keywords:
            - buy laptop
            - cheap laptops for sale
            - purchase laptop
    KeywordsDataGoogleAdsSearchVolumeTaskPostTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: object
              description: '<em>array of results</em><br>in this case, the value will be <code>null</code>'
              nullable: true
    KeywordsDataGoogleAdsSearchVolumeTaskPostResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/KeywordsDataGoogleAdsSearchVolumeTaskPostTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    KeywordsDataGoogleAdsSearchVolumeTasksReadyResultInfo:
      type: object
      properties:
        id:
          type: string
          description: <em>task identifier of the completed task</em><br><strong>unique task identifier in our system in the <a href="https://en.wikipedia.org/wiki/Universally_unique_identifier">UUID</a> format</strong>
          nullable: true
        se:
          type: string
          description: <em>search engine specified when setting the task</em>
          nullable: true
        se_type:
          type: string
          nullable: true
        date_posted:
          type: string
          description: <em>date when the task was posted (in the UTC format)</em>
          nullable: true
        tag:
          type: string
          nullable: true
        endpoint:
          type: string
          description: <em>URL for collecting the results of the task</em>
          nullable: true
    KeywordsDataGoogleAdsSearchVolumeTasksReadyTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/KeywordsDataGoogleAdsSearchVolumeTasksReadyResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    KeywordsDataGoogleAdsSearchVolumeTasksReadyResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/KeywordsDataGoogleAdsSearchVolumeTasksReadyTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    KeywordsDataGoogleAdsSearchVolumeTaskGetResultInfo:
      type: object
      properties:
        keyword:
          type: string
          description: <em>keyword<br></em><strong>keyword is returned with decoded %## (plus character '+' will be decoded to a space character)</strong>
          nullable: true
        spell:
          type: string
          description: '<em>correct spelling of the keyword</em><br><strong>Note:</strong>if the keyword in the POST array appears to be misspelled, data will be returned for the correctly spelled keyword;<br>we use the functionality of Google Ads API to check and validate the spelling of keywords, <a href="https://support.google.com/google-ads/answer/7476658" target="_blank" rel="noopener noreferrer">learn more by this link</a>'
          nullable: true
        location_code:
          type: integer
          description: '<em>location code in a POST array</em><br>if there is no data, then the value is_<code>null</code>n'
          nullable: true
        language_code:
          type: string
          description: '<em>language code in a POST array</em><br>if there is no data, then the value is_<code>null</code>n'
          nullable: true
        search_partners:
          type: boolean
          description: <em>indicates whether data from partner networks included in the response</em>
          nullable: true
        competition:
          type: string
          description: '<em>competition</em><br>represents the relative amount of competition associated with the given keyword in paid SERP only;<br>this value is based on Google Ads data and can take the following values: <code>HIGH</code>, <code>MEDIUM</code>, <code>LOW</code>;<br>if there is no data the value is <code>null</code>;<br>learn more about the metric in <a href="https://dataforseo.com/help-center/what-is-competition" target="_blank" rel="noopener noreferrer">this help center article</a>'
          nullable: true
        competition_index:
          type: integer
          description: <em>competition</em><br>represents the relative amount of competition associated with the given keyword in paid SERP only;<br>this value is based on Google Ads data and can be between 0 and 100 (inclusive);<br>if there is no data the value is <code>null</code>;<br>learn more about the metric in <a href="https://dataforseo.com/help-center/what-is-competition" target="_blank" rel="noopener noreferrer">this help center article</a>
          nullable: true
        search_volume:
          type: integer
          description: <em>monthly average search volume rate</em>
          format: int64
          nullable: true
        low_top_of_page_bid:
          type: number
          description: <em>minimum bid for the ad to be displayed at the top of the first page</em><br>indicates the value greater than about 20% of the lowest bids for which ads were displayed (based on Google Ads statistics for advertisers);<br>the value may differ depending on the location specified in a POST request
          nullable: true
        high_top_of_page_bid:
          type: number
          description: <em>maximum bid for the ad to be displayed at the top of the first page</em><br>indicates the value greater than about 80% of the lowest bids for which ads were displayed (based on Google Ads statistics for advertisers);<br>the value may differ depending on the location specified in a POST request
          nullable: true
        cpc:
          type: number
          description: <em>cost per click</em><br>indicates the amount paid (USD) for each click on the ad displayed for a given keyword
          nullable: true
        monthly_searches:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/MonthlySearchesInfo'
            nullable: true
          description: '<em>monthly searches</em><br>represents the (approximate) number of searches on this keyword idea (as available for the past twelve months by default), targeted to the specified geographic locations;<br>if there is no data then the value is_<code>null</code>n'
          nullable: true
    KeywordsDataGoogleAdsSearchVolumeTaskGetTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/KeywordsDataGoogleAdsSearchVolumeTaskGetResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    KeywordsDataGoogleAdsSearchVolumeTaskGetResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/KeywordsDataGoogleAdsSearchVolumeTaskGetTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    KeywordsDataGoogleAdsSearchVolumeLiveRequestInfo:
      type: object
      properties:
        keywords:
          type: array
          items:
            type: string
          description: '<em>keywords</em><br><strong>required field</strong><br>The maximum number of keywords you can specify: 1000<br>The maximum number of characters for each keyword: 80<br>The maximum number of words for each keyword phrase: 10<br>the keywords you specify will be converted to a lowercase format<br><strong>Note #1:</strong> <a href="https://dataforseo.com/help-center/no-search-volume-data-for-some-keywords" target="_blank" rel="noopener noreferrer">Google Ads may return no data for certain groups of keywords</a>;<br><strong>Note #2:</strong> <a href="https://dataforseo.com/help-center/sv-broad-exact-phrase-match" target="_blank" rel="noopener noreferrer">Google Ads provides combined search volume values for groups of similar keywords</a><br>to obtain search volume for similar keywords, we recommend submitting such keywords in separate requests;<br><strong>Note #3:</strong> Google Ads doesn''t allow using certain symbols and characters (e.g., UTF symbols, emojis), so you can''t use them when setting a task;<br>to learn more about which symbols and characters can be used, please refer to <a href="https://dataforseo.com/help-center/using-symbols-in-keywords-when-setting-a-google-ads-task" target="_blank" rel="noopener noreferrer">this article</a><p>learn more about rules and limitations of <code>keyword</code> and <code>keywords</code> fields in DataForSEO APIs in this <a href="https://dataforseo.com/help-center/rules-and-limitations-of-keyword-and-keywords-fields-in-dataforseo-apis" rel="noopener noreferrer" target="_blank">Help Center article</a>'
        location_name:
          type: string
          description: '<em>full name of search engine location</em><br>optional field<br>if you do not indicate the location, you will receive worldwide results, i.e., for all available locations;<br><strong>if you use this field, you don''t need to specify <code>location_code</code> or <code>location_coordinate</code></strong><br>you can receive the list of available locations of the search engine with their <code>location_name</code> by making a separate request to <code>https://api.dataforseo.com/v3/keywords_data/google_ads/locations</code><br>example:<br><code class="long-string">London,England,United Kingdom</code>'
          nullable: true
        location_code:
          type: integer
          description: '<em>search engine location code</em><br>optional field<br>if you do not indicate the location, you will receive worldwide results, i.e., for all available locations;<br><strong>if you use this field, you don''t need to specify <code>location_name</code> or <code>location_coordinate</code></strong>;<br>you can receive the list of available locations of the search engines with their <code>location_code</code> by making a separate request to <code>https://api.dataforseo.com/v3/keywords_data/google_ads/locations</code><br>example:<br><code class="long-string">2840</code>'
          nullable: true
        location_coordinate:
          type: string
          description: '<em>GPS coordinates of a location</em><br>optional field<br>if you do not indicate the location, you will receive worldwide results, i.e., for all available locations;<br><strong>if you use this field, you don''t need to specify <code>location_name</code> or <code>location_code</code></strong>;<br><code>location_coordinate</code> parameter should be specified in the <em>"latitude,longitude"</em> format;<br><strong>the data will be provided for the country the specified coordinates belong to</strong>;<br>example:<br><code class="long-string">52.6178549,-155.352142</code>'
          nullable: true
        language_name:
          type: string
          description: <em>full name of search engine language</em><br>optional field<br>you can receive the list of available languages of the search engine with their <code>language_name</code> by making a separate request to <code>https://api.dataforseo.com/v3/keywords_data/google_ads/languages</code><br>example:<br><code class="long-string">English</code>
          nullable: true
        language_code:
          type: string
          description: <em>search engine language code</em><br>optional field<br>you can receive the list of available languages of the search engine with their <code>language_code</code> by making a separate request to <code>https://api.dataforseo.com/v3/keywords_data/google_ads/languages</code><br>example:<br><code class="long-string">en</code>
          nullable: true
        search_partners:
          type: boolean
          description: '<em>include Google search partners</em><br>optional field<br>if you specify <code class="prettyprint">true</code>, the results will be delivered for owned, operated, and syndicated networks across <a href="https://support.google.com/google-ads/answer/1722047?hl=en" target="_blank" rel="noopener noreferrer">Google and partner sites</a> that host Google search;<br>default value: <code>false</code> - results are returned for Google search sites'
          nullable: true
        date_from:
          type: string
          description: '<em>starting date of the time range</em><br>optional field<br>date format: <code>"yyyy-mm-dd"</code><br>minimal value: 4 years from the current date<br>by default, data is returned for the past 12 months;<br><strong>Note</strong>: the indicated date cannot be greater than that specified in <code>date_to</code> and/or yesterday''s date;if <a href="/v3/keywords_data/google_ads/status/" target="_blank" rel="noopener noreferrer">Status endpoint</a> returns <code>false</code> in the <code>actual_data</code> field, <code>date_from</code> can be set to the month before last and prior;<br>if <a href="/v3/keywords_data/google_ads/status/" target="_blank" rel="noopener noreferrer">Status endpoint</a> returns <code>true</code> in the <code>actual_data</code> field, <code>date_from</code> can be set to the last month and prior'
          nullable: true
        date_to:
          type: string
          description: '<em>ending date of the time range</em><br>optional field<br><strong>Note:</strong> the indicated date cannot be greater than the past month, Google Ads does not return data on the current month;<br>if you don''t specify this field, yesterday''s date will be used by default<br>date format: <code>"yyyy-mm-dd"</code><br>example:<br><code>"2022-11-30"</code>'
          nullable: true
        include_adult_keywords:
          type: boolean
          description: '<em>include keywords associated with adult content<br></em>optional field<br>if set to_<code>true</code>, adult keywords will be included in the response<br>default value:_<code>false</code><br><strong>note</strong>_that the API may return no data for such keywords due to_<a href="https://support.google.com/adspolicy/answer/6008942?hl=en" target="_blank" rel="noopener noreferrer">Google Ads restrictions</a>n'
          nullable: true
        sort_by:
          type: string
          description: '<em>results sorting parameters</em><br>optional field<br>use these parameters to sort the results by <code>relevance</code>, <code>search_volume</code>, <code>competition_index</code>, <code>low_top_of_page_bid</code>, or <code>high_top_of_page_bid</code> in the descending order<br>default value: <code>relevance</code>'
          nullable: true
        tag:
          type: string
          description: <em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> array of the response
          nullable: true
      example:
        - location_code: 2840
          keywords:
            - buy laptop
            - cheap laptops for sale
            - purchase laptop
          date_from: '2021-08-01'
          search_partners: true
    KeywordsDataGoogleAdsSearchVolumeLiveResultInfo:
      type: object
      properties:
        keyword:
          type: string
          description: <em>keyword<br></em><strong>keyword is returned with decoded %## (plus character '+' will be decoded to a space character)</strong>
          nullable: true
        spell:
          type: string
          description: '<em>correct spelling of the keyword</em><br><strong>Note:</strong>if the keyword in the POST array appears to be misspelled, data will be returned for the correctly spelled keyword;<br>we use the functionality of Google Ads API to check and validate the spelling of keywords, <a href="https://support.google.com/google-ads/answer/7476658" target="_blank" rel="noopener noreferrer">learn more by this link</a>'
          nullable: true
        location_code:
          type: integer
          description: '<em>location code in a POST array</em><br>if there is no data, then the value is_<code>null</code>n'
          nullable: true
        language_code:
          type: string
          description: '<em>language code in a POST array</em><br>if there is no data, then the value is_<code>null</code>n'
          nullable: true
        search_partners:
          type: boolean
          description: <em>indicates whether data from partner networks included in the response</em>
          nullable: true
        competition:
          type: string
          description: '<em>competition</em><br>represents the relative amount of competition associated with the given keyword in paid SERP only;<br>this value is based on Google Ads data and can take the following values: <code>HIGH</code>, <code>MEDIUM</code>, <code>LOW</code>;<br>if there is no data the value is <code>null</code>;<br>learn more about the metric in <a href="https://dataforseo.com/help-center/what-is-competition" target="_blank" rel="noopener noreferrer">this help center article</a>'
          nullable: true
        competition_index:
          type: integer
          description: <em>competition</em><br>represents the relative amount of competition associated with the given keyword in paid SERP only;<br>this value is based on Google Ads data and can be between 0 and 100 (inclusive);<br>if there is no data the value is <code>null</code>;<br>learn more about the metric in <a href="https://dataforseo.com/help-center/what-is-competition" target="_blank" rel="noopener noreferrer">this help center article</a>
          nullable: true
        search_volume:
          type: integer
          description: '<em>monthly average search volume rate;<br></em>represents either the (approximate) number of searches for the given keyword idea on google.com or google.com and partners, depending on the user’s targeting;<br>if there is no data then the value is_<code>null</code>n'
          format: int64
          nullable: true
        low_top_of_page_bid:
          type: number
          description: <em>minimum bid for the ad to be displayed at the top of the first page</em><br>indicates the value greater than about 20% of the lowest bids for which ads were displayed (based on Google Ads statistics for advertisers);<br>the value may differ depending on the location specified in a POST request
          nullable: true
        high_top_of_page_bid:
          type: number
          description: <em>maximum bid for the ad to be displayed at the top of the first page</em><br>indicates the value greater than about 80% of the lowest bids for which ads were displayed (based on Google Ads statistics for advertisers);<br>the value may differ depending on the location specified in a POST request
          nullable: true
        cpc:
          type: number
          description: <em>cost per click</em><br>indicates the amount paid (USD) for each click on the ad displayed for a given keyword
          nullable: true
        monthly_searches:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/MonthlySearchesInfo'
            nullable: true
          description: '<em>monthly searches</em><br>represents the (approximate) number of searches on this keyword idea (as available for the past twelve months by default), targeted to the specified geographic locations;<br>if there is no data then the value is_<code>null</code>n'
          nullable: true
    KeywordsDataGoogleAdsSearchVolumeLiveTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/KeywordsDataGoogleAdsSearchVolumeLiveResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    KeywordsDataGoogleAdsSearchVolumeLiveResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/KeywordsDataGoogleAdsSearchVolumeLiveTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    KeywordsDataGoogleAdsKeywordsForSiteTaskPostRequestInfo:
      type: object
      properties:
        target:
          type: string
          description: '<em>domain or page</em><br><strong>required field</strong><br>the domain name of the target website or the url of the target page;<br><strong>note:</strong> to obtain keywords for the target website, use the <code>target_type</code> parameter'
        target_type:
          type: string
          description: '<em>search keywords for site or url</em><br>optional field<br>possible values: <code>site</code>, <code>page</code>;<br>default value: <code>page</code><br>if set to <code>site</code>, keywords will be provided for the entire site;<br>if set to <code>page</code>, keywords will be provided for the specified webpage'
          nullable: true
        location_name:
          type: string
          description: '<em>full name of search engine location</em><br>optional field<br>if you do not indicate the location, you will receive worldwide results, i.e., for all available locations;<br><strong>if you use this field, you don''t need to specify <code>location_code</code> or <code>location_coordinate</code></strong><br>you can receive the list of available locations of the search engine with their <code>location_name</code> by making a separate request to <code>https://api.dataforseo.com/v3/keywords_data/google_ads/locations</code><br>example:<br><code class="long-string">London,England,United Kingdom</code>'
          nullable: true
        location_code:
          type: integer
          description: '<em>search engine location code</em><br>optional field<br>if you do not indicate the location, you will receive worldwide results, i.e., for all available locations;<br><strong>if you use this field, you don''t need to specify <code>location_name</code> or <code>location_coordinate</code></strong>;<br>you can receive the list of available locations of the search engines with their <code>location_code</code> by making a separate request to <code>https://api.dataforseo.com/v3/keywords_data/google_ads/locations</code><br>example:<br><code class="long-string">2840</code>'
          nullable: true
        location_coordinate:
          type: string
          description: '<em>GPS coordinates of a location</em><br>optional field<br>if you do not indicate the location, you will receive worldwide results, i.e., for all available locations;<br><strong>if you use this field, you don''t need to specify <code>location_name</code> or <code>location_code</code></strong>;<br><code>location_coordinate</code> parameter should be specified in the <em>"latitude,longitude"</em> format;<br><strong>the data will be provided for the country the specified coordinates belong to</strong>;<br>example:<br><code class="long-string">52.6178549,-155.352142</code>'
          nullable: true
        language_name:
          type: string
          description: <em>full name of search engine language</em><br>optional field<br>you can receive the list of available languages of the search engine with their <code>language_name</code> by making a separate request to <code>https://api.dataforseo.com/v3/keywords_data/google_ads/languages</code><br>example:<br><code class="long-string">English</code>
          nullable: true
        language_code:
          type: string
          description: <em>search engine language code</em><br>optional field<br>you can receive the list of available languages of the search engine with their <code>language_code</code> by making a separate request to <code>https://api.dataforseo.com/v3/keywords_data/google_ads/languages</code><br>example:<br><code class="long-string">en</code>
          nullable: true
        search_partners:
          type: boolean
          description: '<em>include Google search partners</em><br>optional field<br>if you specify <code class="prettyprint">true</code>, the results will be delivered for owned, operated, and syndicated networks across <a href="https://support.google.com/google-ads/answer/1722047?hl=en" target="_blank" rel="noopener noreferrer">Google and partner sites</a> that host Google search;<br>default value: <code>false</code> - results are returned for Google search sites'
          nullable: true
        date_from:
          type: string
          description: '<em>starting date of the time range</em><br>optional field<br>date format: <code>"yyyy-mm-dd"</code><br>minimal value: 4 years from the current date<br>by default, data is returned for the past 12 months;<br><strong>Note</strong>: the indicated date cannot be greater than that specified in <code>date_to</code> and/or yesterday''s date;if <a href="/v3/keywords_data/google_ads/status/" target="_blank" rel="noopener noreferrer">Status endpoint</a> returns <code>false</code> in the <code>actual_data</code> field, <code>date_from</code> can be set to the month before last and prior;<br>if <a href="/v3/keywords_data/google_ads/status/" target="_blank" rel="noopener noreferrer">Status endpoint</a> returns <code>true</code> in the <code>actual_data</code> field, <code>date_from</code> can be set to the last month and prior'
          nullable: true
        date_to:
          type: string
          description: '<em>ending date of the time range</em><br>optional field<br><strong>Note:</strong> the indicated date cannot be greater than yesterday''s date;<br>if you don''t specify this field, yesterday''s date will be used by default<br>date format: <code>"yyyy-mm-dd"</code><br>example:<br><code>"2022-11-30"</code>'
          nullable: true
        include_adult_keywords:
          type: boolean
          description: '<em>include keywords associated with adult content</em><br>optional field<br>if set to <code>true</code>, adult keywords will be included in the response<br>default value: <code>false</code><br><strong>note</strong> that the API may return no data for such keywords due to <a href="https://support.google.com/adspolicy/answer/6008942?hl=en" target="_blank" rel="noopener noreferrer">Google Ads restrictions</a>'
          nullable: true
        sort_by:
          type: string
          description: '<em>results sorting parameters</em><br>optional field<br>Use these parameters to sort the results by <code>relevance</code>, <code>search_volume</code>, <code>competition_index</code>, <code>low_top_of_page_bid</code>, or <code>high_top_of_page_bid</code> in descending order<br>default value: <code>relevance</code>'
          nullable: true
        postback_url:
          type: string
          description: '<em>URL for sending task results</em><br>optional field<br>once the task is completed, we will send a POST request with its results compressed in the <code>gzip</code> format to the <code>postback_url</code> you specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/postbackscript?id=$id</code><br><code>http://your-server.com/postbackscript?id=$id&amp;tag=$tag</code><br><strong>Note:</strong> special characters in <code>postback_url</code> will be urlencoded;<br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href="https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api" target="_blank" rel="noopener noreferrer">Help Center</a>'
          nullable: true
        pingback_url:
          type: string
          description: '<em>notification URL of a completed task</em><br>optional field<br>when a task is completed we will notify you by GET request sent to the URL you have specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request<br>example:<br><code>http://your-server.com/pingscript?id=$id</code><br><code>http://your-server.com/pingscript?id=$id&amp;tag=$tag</code><br><strong>Note:</strong> special characters in <code>pingback_url</code> will be urlencoded;<br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href="https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api" target="_blank" rel="noopener noreferrer">Help Center</a>'
          nullable: true
        tag:
          type: string
          description: <em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response
          nullable: true
      example:
        - location_code: 2840
          target: dataforseo.com
    KeywordsDataGoogleAdsKeywordsForSiteTaskPostTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: object
              description: '<em>array of results</em><br>in this case, the value will be <code>null</code>'
              nullable: true
    KeywordsDataGoogleAdsKeywordsForSiteTaskPostResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/KeywordsDataGoogleAdsKeywordsForSiteTaskPostTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    KeywordsDataGoogleAdsKeywordsForSiteTasksReadyResultInfo:
      type: object
      properties:
        id:
          type: string
          description: <em>task identifier of the completed task</em><br><strong>unique task identifier in our system in the <a href="https://en.wikipedia.org/wiki/Universally_unique_identifier">UUID</a> format</strong>
          nullable: true
        se:
          type: string
          description: <em>search engine specified when setting the task</em>
          nullable: true
        se_type:
          type: string
          nullable: true
        date_posted:
          type: string
          description: <em>date when the task was posted (in the UTC format)</em>
          nullable: true
        tag:
          type: string
          nullable: true
        endpoint:
          type: string
          description: <em>URL for collecting the results of the task</em>
          nullable: true
    KeywordsDataGoogleAdsKeywordsForSiteTasksReadyTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/KeywordsDataGoogleAdsKeywordsForSiteTasksReadyResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    KeywordsDataGoogleAdsKeywordsForSiteTasksReadyResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/KeywordsDataGoogleAdsKeywordsForSiteTasksReadyTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    KeywordsDataGoogleAdsKeywordsForSiteTaskGetResultInfo:
      type: object
      properties:
        keyword:
          type: string
          description: <em>keyword in a POST array</em>
          nullable: true
        spell:
          type: string
          nullable: true
        location_code:
          type: integer
          description: '<em>location code in a POST array</em><br>if there is no data, the value is_<code>null</code>n'
          nullable: true
        language_code:
          type: string
          description: '<em>language code in a POST array</em><br>if there is no data, the value is_<code>null</code>n'
          nullable: true
        search_partners:
          type: boolean
          description: '<em>include Google search partners</em><br>the value you specified when setting the task<br>if <code class="prettyprint">true</code>, the results are returned for owned, operated, and syndicated networks across Google and partner sites that host Google search;<br>if <code>false</code>, the results are returned for Google search sites only'
          nullable: true
        competition:
          type: string
          description: '<em>competition</em><br>represents the relative level of competition associated with the given keyword in paid SERP only<br>possible values: <code>LOW</code>, <code>MEDIUM</code>, <code>HIGH</code><br>if competition level is unknown, the value is <code>null</code>;<br>learn more about the metric in <a href="https://dataforseo.com/help-center/what-is-competition" rel="noopener noreferrer" target="_blank">this help center article</a>'
          nullable: true
        competition_index:
          type: integer
          description: '<em>competition index</em><br>the competition index for the query indicating how competitive ad placement is for the keyword<br>can take values from 0 to 100 <br>the level of competition from 0 to 100 is determined by the number of ad slots filled divided by the total number of ad slots available <br>if not enough data is available, the value is <code>null</code>;<br>learn more about the metric in <a href="https://dataforseo.com/help-center/what-is-competition" rel="noopener noreferrer" target="_blank">this help center article</a>'
          nullable: true
        search_volume:
          type: integer
          description: '<em>monthly average search volume rate</em><br>represents the (approximate) number of searches for the given keyword idea either on google.com or google.com and partners, depending on the user’s targeting<br>if there is no data, the value is <code>null</code>'
          format: int64
          nullable: true
        low_top_of_page_bid:
          type: number
          description: <em>minimum bid for the ad to be displayed at the top of the first page</em><br>indicates the value greater than about 20% of the lowest bids for which ads were displayed (based on Google Ads statistics for advertisers)<br>the value may differ depending on the location specified in a POST request
          nullable: true
        high_top_of_page_bid:
          type: number
          description: <em>maximum bid for the ad to be displayed at the top of the first page</em><br>indicates the value greater than about 80% of the lowest bids for which ads were displayed (based on Google Ads statistics for advertisers)<br>the value may differ depending on the location specified in a POST request
          nullable: true
        cpc:
          type: number
          description: <em>cost per click</em><br>indicates the amount paid (USD) for each click on the ad displayed for a given keyword
          nullable: true
        monthly_searches:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/MonthlySearchesInfo'
            nullable: true
          description: '<em>monthly searches</em><br>represents the (approximate) number of searches on this keyword idea (as available for the past twelve months), targeted to the specified geographic locations<br>if there is no data, the value is <code>null</code>'
          nullable: true
    KeywordsDataGoogleAdsKeywordsForSiteTaskGetTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/KeywordsDataGoogleAdsKeywordsForSiteTaskGetResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    KeywordsDataGoogleAdsKeywordsForSiteTaskGetResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/KeywordsDataGoogleAdsKeywordsForSiteTaskGetTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    KeywordsDataGoogleAdsKeywordsForSiteLiveRequestInfo:
      type: object
      properties:
        target:
          type: string
          description: '<em>domain or page</em><br><strong>required field</strong><br>the domain name of the target website or the url of the target page;<br><strong>note:</strong> to obtain keywords for the target website, use the <code>target_type</code> parameter'
        target_type:
          type: string
          description: '<em>search keywords for site or for url</em><br>optional field<br>possible values: <code>site</code>, <code>page</code>;<br>default value: <code>page</code>;<br>if set to <code>site</code>, keywords will be provided for the entire site;<br>if set to <code>page</code>, keywords will be provided for the specified webpage'
          nullable: true
        location_name:
          type: string
          description: '<em>full name of search engine location</em><br>optional field<br>if you do not indicate the location, you will receive worldwide results, i.e., for all available locations;<br><strong>if you use this field, you don''t need to specify <code>location_code</code> or <code>location_coordinate</code></strong><br>you can receive the list of available locations of the search engine with their <code>location_name</code> by making a separate request to <code>https://api.dataforseo.com/v3/keywords_data/google_ads/locations</code><br>example:<br><code class="long-string">London,England,United Kingdom</code>'
          nullable: true
        location_code:
          type: integer
          description: '<em>search engine location code</em><br>optional field<br>if you do not indicate the location, you will receive worldwide results, i.e., for all available locations;<br><strong>if you use this field, you don''t need to specify <code>location_name</code> or <code>location_coordinate</code></strong>;<br>you can receive the list of available locations of the search engines with their <code>location_code</code> by making a separate request to <code>https://api.dataforseo.com/v3/keywords_data/google_ads/locations</code><br>example:<br><code class="long-string">2840</code>'
          nullable: true
        location_coordinate:
          type: string
          description: '<em>GPS coordinates of a location</em><br>optional field<br>if you do not indicate the location, you will receive worldwide results, i.e., for all available locations;<br><strong>if you use this field, you don''t need to specify <code>location_name</code> or <code>location_code</code></strong>;<br><code>location_coordinate</code> parameter should be specified in the <em>"latitude,longitude"</em> format;<br><strong>the data will be provided for the country the specified coordinates belong to</strong>;<br>example:<br><code class="long-string">52.6178549,-155.352142</code>'
          nullable: true
        language_name:
          type: string
          description: <em>full name of search engine language</em><br>optional field<br>you can receive the list of available languages of the search engine with their <code>language_name</code> by making a separate request to <code>https://api.dataforseo.com/v3/keywords_data/google_ads/languages</code><br>example:<br><code class="long-string">English</code>
          nullable: true
        language_code:
          type: string
          description: <em>search engine language code</em><br>optional field<br>you can receive the list of available languages of the search engine with their <code>language_code</code> by making a separate request to <code>https://api.dataforseo.com/v3/keywords_data/google_ads/languages</code><br>example:<br><code class="long-string">en</code>
          nullable: true
        search_partners:
          type: boolean
          description: '<em>include Google search partners</em><br>optional field<br>if you specify <code class="prettyprint">true</code>, the results will be delivered for owned, operated, and syndicated networks across <a href="https://support.google.com/google-ads/answer/1722047?hl=en" target="_blank" rel="noopener noreferrer">Google and partner sites</a> that host Google search;<br>default value: <code>false</code> - results are returned for Google search sites'
          nullable: true
        date_from:
          type: string
          description: '<em>starting date of the time range</em><br>optional field<br>date format: <code>"yyyy-mm-dd"</code><br>minimal value: 4 years from the current date<br>by default, data is returned for the past 12 months;<br><strong>Note</strong>: the indicated date cannot be greater than that specified in <code>date_to</code> and/or yesterday''s date;if <a href="/v3/keywords_data/google_ads/status/" target="_blank" rel="noopener noreferrer">Status endpoint</a> returns <code>false</code> in the <code>actual_data</code> field, <code>date_from</code> can be set to the month before last and prior;<br>if <a href="/v3/keywords_data/google_ads/status/" target="_blank" rel="noopener noreferrer">Status endpoint</a> returns <code>true</code> in the <code>actual_data</code> field, <code>date_from</code> can be set to the last month and prior'
          nullable: true
        date_to:
          type: string
          description: '<em>ending date of the time range</em><br>optional field<br><strong>Note:</strong> the indicated date cannot be greater than yesterday''s date;<br>if you don''t specify this field, yesterday''s date will be used by default<br>date format: <code>"yyyy-mm-dd"</code><br>example:<br><code>"2022-11-30"</code>'
          nullable: true
        include_adult_keywords:
          type: boolean
          description: '<em>include keywords associated with adult content</em><br>optional field<br>if set to <code>true</code>, adult keywords will be included in the response<br>default value: <code>false</code><br><strong>note</strong> that the API may return no data for such keywords due to <a href="https://support.google.com/adspolicy/answer/6008942?hl=en" target="_blank" rel="noopener noreferrer">Google Ads restrictions</a>'
          nullable: true
        sort_by:
          type: string
          description: '<em>results sorting parameters</em><br>optional field<br>Use these parameters to sort the results by <code>relevance</code>, <code>search_volume</code>, <code>competition_index</code>, <code>low_top_of_page_bid</code>, or <code>high_top_of_page_bid</code> in descending order<br>default value: <code>relevance</code>'
          nullable: true
        tag:
          type: string
          description: <em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response
          nullable: true
      example:
        - location_code: 2840
          target: dataforseo.com
    KeywordsDataGoogleAdsKeywordsForSiteLiveResultInfo:
      type: object
      properties:
        keyword:
          type: string
          description: <em>keyword in a POST array</em>
          nullable: true
        spell:
          type: string
          nullable: true
        location_code:
          type: integer
          description: '<em>location code in a POST array</em><br>if there is no data, the value is_<code>null</code>n'
          nullable: true
        language_code:
          type: string
          description: '<em>language code in a POST array</em><br>if there is no data, the value is_<code>null</code>n'
          nullable: true
        search_partners:
          type: boolean
          description: '<em>include Google search partners</em><br>the value you specified when setting the task<br>if <code class="prettyprint">true</code>, the results are returned for owned, operated, and syndicated networks across Google and partner sites that host Google search;<br>if <code>false</code>, the results are returned for Google search sites only'
          nullable: true
        competition:
          type: string
          description: '<em>competition</em><br>represents the relative level of competition associated with the given keyword in paid SERP only<br>possible values: <code>LOW</code>, <code>MEDIUM</code>, <code>HIGH</code><br>if competition level is unknown, the value is <code>null</code>;<br>learn more about the metric in <a href="https://dataforseo.com/help-center/what-is-competition" target="_blank" rel="noopener noreferrer">this help center article</a>'
          nullable: true
        competition_index:
          type: integer
          description: '<em>competition index</em><br>the competition index for the query indicating how competitive ad placement is for the keyword<br>can take values from 0 to 100<br>the level of competition from 0 to 100 is determined by the number of ad slots filled divided by the total number of ad slots available<br>if not enough data is available, the value is <code>null</code>;<br>learn more about the metric in <a href="https://dataforseo.com/help-center/what-is-competition" target="_blank" rel="noopener noreferrer">this help center article</a>'
          nullable: true
        search_volume:
          type: integer
          description: '<em>monthly average search volume rate</em><br>represents the (approximate) number of searches for the given keyword idea either on google.com or google.com and partners, depending on the user’s targeting<br>if there is no data, the value is <code>null</code>'
          format: int64
          nullable: true
        low_top_of_page_bid:
          type: number
          description: <em>minimum bid for the ad to be displayed at the top of the first page</em><br>indicates the value greater than about 20% of the lowest bids for which ads were displayed (based on Google Ads statistics for advertisers)<br>the value may differ depending on the location specified in a POST request
          nullable: true
        high_top_of_page_bid:
          type: number
          description: <em>maximum bid for the ad to be displayed at the top of the first page</em><br>indicates the value greater than about 80% of the lowest bids for which ads were displayed (based on Google Ads statistics for advertisers)<br>the value may differ depending on the location specified in a POST request
          nullable: true
        cpc:
          type: number
          description: <em>cost per click</em><br>indicates the amount paid (USD) for each click on the ad displayed for a given keyword
          nullable: true
        monthly_searches:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/MonthlySearchesInfo'
            nullable: true
          description: '<em>monthly searches</em><br>represents the (approximate) number of searches on this keyword idea (as available for the past twelve months), targeted to the specified geographic locations<br>if there is no data, the value is <code>null</code>'
          nullable: true
    KeywordsDataGoogleAdsKeywordsForSiteLiveTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/KeywordsDataGoogleAdsKeywordsForSiteLiveResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    KeywordsDataGoogleAdsKeywordsForSiteLiveResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/KeywordsDataGoogleAdsKeywordsForSiteLiveTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    KeywordsDataGoogleAdsKeywordsForKeywordsTaskPostRequestInfo:
      type: object
      properties:
        keywords:
          type: array
          items:
            type: string
          description: '<em>keywords</em><br><strong>required field</strong><br>The maximum number of keywords you can specify: 20<br>The maximum number of characters for each keyword: 80<br>the keywords you specify will be converted to a lowercase format<br><strong>Note:</strong> Google Ads may return no data for certain groups of keywords<br><a href="https://dataforseo.com/help-center/no-search-volume-data-for-some-keywords" target="_blank" rel="noopener noreferrer">visit our Help Center to learn more</a><br><strong>Also note</strong> that Google Ads doesn''t allow using certain symbols and characters (e.g., UTF symbols, emojis), so you can''t use them when setting a task;<br>to learn more about which symbols and characters can be used, please refer to <a href="https://dataforseo.com/help-center/using-symbols-in-keywords-when-setting-a-google-ads-task" target="_blank" rel="noopener noreferrer">this article</a><p>learn more about rules and limitations of <code>keyword</code> and <code>keywords</code> fields in DataForSEO APIs in this <a href="https://dataforseo.com/help-center/rules-and-limitations-of-keyword-and-keywords-fields-in-dataforseo-apis" rel="noopener noreferrer" target="_blank">Help Center article</a>'
        target:
          type: string
          description: '<em>target website</em><br>optional field<br>specify a website or URL to get a list of keywords relevant to it;<br><strong>Note:</strong> if a website url is specified, you will still get keywords relevant for the entire website'
          nullable: true
        location_name:
          type: string
          description: '<em>full name of search engine location</em><br>optional field<br>if you do not indicate the location, you will receive worldwide results, i.e., for all available locations;<br><strong>if you use this field, you don''t need to specify <code>location_code</code> or <code>location_coordinate</code></strong><br>you can receive the list of available locations of the search engine with their <code>location_name</code> by making a separate request to <code>https://api.dataforseo.com/v3/keywords_data/google_ads/locations</code><br>example:<br><code class="long-string">London,England,United Kingdom</code>'
          nullable: true
        location_code:
          type: integer
          description: '<em>search engine location code</em><br>optional field<br>if you do not indicate the location, you will receive worldwide results, i.e., for all available locations;<br><strong>if you use this field, you don''t need to specify <code>location_name</code> or <code>location_coordinate</code></strong>;<br>you can receive the list of available locations of the search engines with their <code>location_code</code> by making a separate request to <code>https://api.dataforseo.com/v3/keywords_data/google_ads/locations</code><br>example:<br><code class="long-string">2840</code>'
          nullable: true
        location_coordinate:
          type: string
          description: '<em>GPS coordinates of a location</em><br>optional field<br>if you do not indicate the location, you will receive worldwide results, i.e., for all available locations;<br><strong>if you use this field, you don''t need to specify <code>location_name</code> or <code>location_code</code></strong>;<br><code>location_coordinate</code> parameter should be specified in the <em>"latitude,longitude"</em> format;<br><strong>the data will be provided for the country the specified coordinates belong to</strong>;<br>example:<br><code class="long-string">52.6178549,-155.352142</code>'
          nullable: true
        language_name:
          type: string
          description: <em>full name of search engine language</em><br>optional field<br>you can receive the list of available languages of the search engine with their <code>language_name</code> by making a separate request to <code>https://api.dataforseo.com/v3/keywords_data/google_ads/languages</code><br>example:<br><code class="long-string">English</code>
          nullable: true
        language_code:
          type: string
          description: <em>search engine language code</em><br>optional field<br>you can receive the list of available languages of the search engine with their <code>language_code</code> by making a separate request to <code>https://api.dataforseo.com/v3/keywords_data/google_ads/languages</code><br>example:<br><code class="long-string">en</code>
          nullable: true
        search_partners:
          type: boolean
          description: '<em>include Google search partners</em><br>optional field<br>if you specify <code class="prettyprint">true</code>, the results will be delivered for owned, operated, and syndicated networks across <a href="https://support.google.com/google-ads/answer/1722047?hl=en" target="_blank" rel="noopener noreferrer">Google and partner sites</a> that host Google search;<br>default value: <code>false</code> - results are returned for Google search sites'
          nullable: true
        date_from:
          type: string
          description: '<em>starting date of the time range</em><br>optional field<br>date format: <code>"yyyy-mm-dd"</code><br>minimal value: 4 years from the current date<br>by default, data is returned for the past 12 months;<br><strong>Note</strong>: the indicated date cannot be greater than that specified in <code>date_to</code> and/or yesterday''s date;if <a href="/v3/keywords_data/google_ads/status/" target="_blank" rel="noopener noreferrer">Status endpoint</a> returns <code>false</code> in the <code>actual_data</code> field, <code>date_from</code> can be set to the month before last and prior;<br>if <a href="/v3/keywords_data/google_ads/status/" target="_blank" rel="noopener noreferrer">Status endpoint</a> returns <code>true</code> in the <code>actual_data</code> field, <code>date_from</code> can be set to the last month and prior'
          nullable: true
        date_to:
          type: string
          description: '<em>ending date of the time range</em><br>optional field<br><strong>Note:</strong> the indicated date cannot be greater than yesterday''s date;<br>if you don''t specify this field, yesterday''s date will be used by default<br>date format: <code>"yyyy-mm-dd"</code><br>example:<br><code>"2022-11-30"</code>'
          nullable: true
        sort_by:
          type: string
          description: '<em>results sorting parameters</em><br>optional field<br>Use these parameters to sort the results by <code>relevance</code>, <code>search_volume</code>, <code>competition_index</code>, <code>low_top_of_page_bid</code>, or <code>high_top_of_page_bid</code> in descending order<br>default value: <code>relevance</code>'
          nullable: true
        include_adult_keywords:
          type: boolean
          description: '<em>include keywords associated with adult content</em><br>optional field<br>if set to <code>true</code>, adult keywords will be included in the response<br>default value: <code>false</code><br><strong>note</strong> that the API may return no data for such keywords due to <a href="https://support.google.com/adspolicy/answer/6008942?hl=en" target="_blank" rel="noopener noreferrer">Google Ads restrictions</a>'
          nullable: true
        postback_url:
          type: string
          description: '<em>URL for sending task results</em><br>optional field<br>once the task is completed, we will send a POST request with its results compressed in the <code>gzip</code> format to the <code>postback_url</code> you specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/postbackscript?id=$id</code><br><code>http://your-server.com/postbackscript?id=$id&amp;tag=$tag</code><br><strong>Note:</strong> special characters in <code>postback_url</code> will be urlencoded;<br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href="https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api" target="_blank" rel="noopener noreferrer">Help Center</a>'
          nullable: true
        pingback_url:
          type: string
          description: '<em>notification URL of a completed task</em><br>optional field<br>when a task is completed we will notify you by GET request sent to the URL you have specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request<br>example:<br><code>http://your-server.com/pingscript?id=$id</code><br><code>http://your-server.com/pingscript?id=$id&amp;tag=$tag</code><br><strong>Note:</strong> special characters in <code>pingback_url</code> will be urlencoded;<br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href="https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api" target="_blank" rel="noopener noreferrer">Help Center</a>'
          nullable: true
        tag:
          type: string
          description: <em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response
          nullable: true
      example:
        - location_code: 2840
          keywords:
            - phone
            - cellphone
    KeywordsDataGoogleAdsKeywordsForKeywordsTaskPostTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: object
              description: '<em>array of results</em><br>in this case, the value will be <code>null</code>'
              nullable: true
    KeywordsDataGoogleAdsKeywordsForKeywordsTaskPostResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/KeywordsDataGoogleAdsKeywordsForKeywordsTaskPostTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    KeywordsDataGoogleAdsKeywordsForKeywordsTasksReadyResultInfo:
      type: object
      properties:
        id:
          type: string
          description: <em>task identifier of the completed task</em><br><strong>unique task identifier in our system in the <a href="https://en.wikipedia.org/wiki/Universally_unique_identifier">UUID</a> format</strong>
          nullable: true
        se:
          type: string
          description: <em>search engine specified when setting the task</em>
          nullable: true
        se_type:
          type: string
          nullable: true
        date_posted:
          type: string
          description: <em>date when the task was posted (in the UTC format)</em>
          nullable: true
        tag:
          type: string
          nullable: true
        endpoint:
          type: string
          description: <em>URL for collecting the results of the task</em>
          nullable: true
    KeywordsDataGoogleAdsKeywordsForKeywordsTasksReadyTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/KeywordsDataGoogleAdsKeywordsForKeywordsTasksReadyResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    KeywordsDataGoogleAdsKeywordsForKeywordsTasksReadyResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/KeywordsDataGoogleAdsKeywordsForKeywordsTasksReadyTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    KeywordsDataGoogleAdsKeywordsForKeywordsTaskGetResultInfo:
      type: object
      properties:
        keyword:
          type: string
          description: <em>keyword in a POST array</em>
          nullable: true
        spell:
          type: string
          nullable: true
        location_code:
          type: integer
          description: '<em>location code in a POST array</em><br>if there is no data, the value is_<code>null</code>n'
          nullable: true
        language_code:
          type: string
          description: '<em>language code in a POST array</em><br>if there is no data, the value is_<code>null</code>n'
          nullable: true
        search_partners:
          type: boolean
          description: '<em>include Google search partners</em><br>the value you specified when setting the task<br>if <code class="prettyprint">true</code>, the results are returned for owned, operated, and syndicated networks across Google and partner sites that host Google search;<br>if <code>false</code>, the results are returned for Google search sites only'
          nullable: true
        competition:
          type: string
          description: '<em>competition</em><br>represents the relative level of competition associated with the given keyword in paid SERP only<br>possible values: <code>LOW</code>, <code>MEDIUM</code>, <code>HIGH</code><br>if competition level is unknown, the value is <code>null</code>;<br>learn more about the metric in <a href="https://dataforseo.com/help-center/what-is-competition" rel="noopener noreferrer" target="_blank">this help center article</a>'
          nullable: true
        competition_index:
          type: integer
          description: '<em>competition index</em><br>the competition index for the query indicating how competitive ad placement is for the keyword<br>can take values from 0 to 100 <br>the level of competition from 0 to 100 is determined by the number of ad slots filled divided by the total number of ad slots available <br>if not enough data is available, the value is <code>null</code>;<br>learn more about the metric in <a href="https://dataforseo.com/help-center/what-is-competition" rel="noopener noreferrer" target="_blank">this help center article</a>'
          nullable: true
        search_volume:
          type: integer
          description: '<em>monthly average search volume rate</em><br>represents the (approximate) number of searches for the given keyword idea either on google.com or google.com and partners, depending on the user’s targeting<br>if there is no data, the value is <code>null</code>'
          format: int64
          nullable: true
        low_top_of_page_bid:
          type: number
          description: <em>minimum bid for the ad to be displayed at the top of the first page</em><br>indicates the value greater than about 20% of the lowest bids for which ads were displayed (based on Google Ads statistics for advertisers)<br>the value may differ depending on the location specified in a POST request
          nullable: true
        high_top_of_page_bid:
          type: number
          description: <em>maximum bid for the ad to be displayed at the top of the first page</em><br>indicates the value greater than about 80% of the lowest bids for which ads were displayed (based on Google Ads statistics for advertisers)<br>the value may differ depending on the location specified in a POST request
          nullable: true
        cpc:
          type: number
          description: <em>cost per click</em><br>indicates the amount paid (USD) for each click on the ad displayed for a given keyword
          nullable: true
        monthly_searches:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/MonthlySearchesInfo'
            nullable: true
          description: '<em>monthly searches</em><br>represents the (approximate) number of searches on this keyword idea (as available for the past twelve months), targeted to the specified geographic locations<br>if there is no data, the value is <code>null</code>'
          nullable: true
    KeywordsDataGoogleAdsKeywordsForKeywordsTaskGetTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/KeywordsDataGoogleAdsKeywordsForKeywordsTaskGetResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    KeywordsDataGoogleAdsKeywordsForKeywordsTaskGetResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/KeywordsDataGoogleAdsKeywordsForKeywordsTaskGetTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    KeywordsDataGoogleAdsKeywordsForKeywordsLiveRequestInfo:
      type: object
      properties:
        keywords:
          type: array
          items:
            type: string
          description: '<em>keywords</em><br><strong>required field</strong><br>The maximum number of keywords you can specify: 20<br>The maximum number of characters for each keyword: 80<br>the keywords you specify will be converted to a lowercase format<br><strong>Note:</strong> Google Ads may return no data for certain groups of keywords<br><a href="https://dataforseo.com/help-center/no-search-volume-data-for-some-keywords" target="_blank" rel="noopener noreferrer">visit our Help Center to learn more</a><br><strong>Also note</strong> that Google Ads doesn''t allow using certain symbols and characters (e.g., UTF symbols, emojis), so you can''t use them when setting a task;<br>to learn more about which symbols and characters can be used, please refer to <a href="https://dataforseo.com/help-center/using-symbols-in-keywords-when-setting-a-google-ads-task" target="_blank" rel="noopener noreferrer">this article</a><p>learn more about rules and limitations of <code>keyword</code> and <code>keywords</code> fields in DataForSEO APIs in this <a href="https://dataforseo.com/help-center/rules-and-limitations-of-keyword-and-keywords-fields-in-dataforseo-apis" rel="noopener noreferrer" target="_blank">Help Center article</a>'
        location_name:
          type: string
          description: '<em>full name of search engine location</em><br>optional field<br>if you do not indicate the location, you will receive worldwide results, i.e., for all available locations;<br><strong>if you use this field, you don''t need to specify <code>location_code</code> or <code>location_coordinate</code></strong><br>you can receive the list of available locations of the search engine with their <code>location_name</code> by making a separate request to <code>https://api.dataforseo.com/v3/keywords_data/google_ads/locations</code><br>example:<br><code class="long-string">London,England,United Kingdom</code>'
          nullable: true
        location_code:
          type: integer
          description: '<em>search engine location code</em><br>optional field<br>if you do not indicate the location, you will receive worldwide results, i.e., for all available locations;<br><strong>if you use this field, you don''t need to specify <code>location_name</code> or <code>location_coordinate</code></strong>;<br>you can receive the list of available locations of the search engines with their <code>location_code</code> by making a separate request to <code>https://api.dataforseo.com/v3/keywords_data/google_ads/locations</code><br>example:<br><code class="long-string">2840</code>'
          nullable: true
        location_coordinate:
          type: string
          description: '<em>GPS coordinates of a location</em><br>optional field<br>if you do not indicate the location, you will receive worldwide results, i.e., for all available locations;<br><strong>if you use this field, you don''t need to specify <code>location_name</code> or <code>location_code</code></strong>;<br><code>location_coordinate</code> parameter should be specified in the <em>"latitude,longitude"</em> format;<br><strong>the data will be provided for the country the specified coordinates belong to</strong>;<br>example:<br><code class="long-string">52.6178549,-155.352142</code>'
          nullable: true
        language_name:
          type: string
          description: <em>full name of search engine language</em><br>optional field<br>you can receive the list of available languages of the search engine with their <code>language_name</code> by making a separate request to <code>https://api.dataforseo.com/v3/keywords_data/google_ads/languages</code><br>example:<br><code class="long-string">English</code>
          nullable: true
        language_code:
          type: string
          description: <em>search engine language code</em><br>optional field<br>you can receive the list of available languages of the search engine with their <code>language_code</code> by making a separate request to <code>https://api.dataforseo.com/v3/keywords_data/google_ads/languages</code><br>example:<br><code class="long-string">en</code>
          nullable: true
        search_partners:
          type: boolean
          description: '<em>include Google search partners</em><br>optional field<br>if you specify <code class="prettyprint">true</code>, the results will be delivered for owned, operated, and syndicated networks across <a href="https://support.google.com/google-ads/answer/1722047?hl=en" target="_blank" rel="noopener noreferrer">Google and partner sites</a> that host Google search;<br>default value: <code>false</code> - results are returned for Google search sites'
          nullable: true
        date_from:
          type: string
          description: '<em>starting date of the time range</em><br>optional field<br>date format: <code>"yyyy-mm-dd"</code><br>minimal value: 4 years from the current date<br>by default, data is returned for the past 12 months;<br><strong>Note</strong>: the indicated date cannot be greater than that specified in <code>date_to</code> and/or yesterday''s date;if <a href="/v3/keywords_data/google_ads/status/" target="_blank" rel="noopener noreferrer">Status endpoint</a> returns <code>false</code> in the <code>actual_data</code> field, <code>date_from</code> can be set to the month before last and prior;<br>if <a href="/v3/keywords_data/google_ads/status/" target="_blank" rel="noopener noreferrer">Status endpoint</a> returns <code>true</code> in the <code>actual_data</code> field, <code>date_from</code> can be set to the last month and prior'
          nullable: true
        date_to:
          type: string
          description: '<em>ending date of the time range</em><br>optional field<br><strong>Note:</strong> the indicated date cannot be greater than yesterday''s date;<br>if you don''t specify this field, yesterday''s date will be used by default<br>date format: <code>"yyyy-mm-dd"</code><br>example:<br><code>"2022-11-30"</code>'
          nullable: true
        sort_by:
          type: string
          description: '<em>results sorting parameters</em><br>optional field<br>Use these parameters to sort the results by <code>relevance</code>, <code>search_volume</code>, <code>competition_index</code>, <code>low_top_of_page_bid</code>, or <code>high_top_of_page_bid</code> in descending order<br>default value: <code>relevance</code>'
          nullable: true
        include_adult_keywords:
          type: boolean
          description: '<em>include keywords associated with adult content</em><br>optional field<br>if set to <code>true</code>, adult keywords will be included in the response<br>default value: <code>false</code><br><strong>note</strong> that the API may return no data for such keywords due to <a href="https://support.google.com/adspolicy/answer/6008942?hl=en" target="_blank" rel="noopener noreferrer">Google Ads restrictions</a>'
          nullable: true
        tag:
          type: string
          description: <em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response
          nullable: true
      example:
        - location_code: 2840
          keywords:
            - phone
            - cellphone
    KeywordsDataGoogleAdsKeywordsForKeywordsLiveResultInfo:
      type: object
      properties:
        keyword:
          type: string
          description: <em>keyword in a POST array</em>
          nullable: true
        spell:
          type: string
          nullable: true
        location_code:
          type: integer
          description: '<em>location code in a POST array</em><br>if there is no data, the value is_<code>null</code>n'
          nullable: true
        language_code:
          type: string
          description: '<em>language code in a POST array</em><br>if there is no data, the value is_<code>null</code>n'
          nullable: true
        search_partners:
          type: boolean
          description: '<em>include Google search partners</em><br>the value you specified when setting the task<br>if <code class="prettyprint">true</code>, the results are returned for owned, operated, and syndicated networks across Google and partner sites that host Google search;<br>if <code>false</code>, the results are returned for Google search sites only'
          nullable: true
        competition:
          type: string
          description: '<em>competition</em><br>represents the relative level of competition associated with the given keyword in paid SERP only<br>possible values: <code>LOW</code>, <code>MEDIUM</code>, <code>HIGH</code><br>if competition level is unknown, the value is <code>null</code>;<br>learn more about the metric in <a href="https://dataforseo.com/help-center/what-is-competition" target="_blank" rel="noopener noreferrer">this help center article</a>'
          nullable: true
        competition_index:
          type: integer
          description: '<em>competition index</em><br>the competition index for the query indicating how competitive ad placement is for the keyword<br>can take values from 0 to 100<br>the level of competition from 0 to 100 is determined by the number of ad slots filled divided by the total number of ad slots available<br>if not enough data is available, the value is <code>null</code>;<br>learn more about the metric in <a href="https://dataforseo.com/help-center/what-is-competition" target="_blank" rel="noopener noreferrer">this help center article</a>'
          nullable: true
        search_volume:
          type: integer
          description: '<em>monthly average search volume rate</em><br>represents the (approximate) number of searches for the given keyword idea either on google.com or google.com and partners, depending on the user’s targeting<br>if there is no data, the value is <code>null</code>'
          format: int64
          nullable: true
        low_top_of_page_bid:
          type: number
          description: <em>minimum bid for the ad to be displayed at the top of the first page</em><br>indicates the value greater than about 20% of the lowest bids for which ads were displayed (based on Google Ads statistics for advertisers)<br>the value may differ depending on the location specified in a POST request
          nullable: true
        high_top_of_page_bid:
          type: number
          description: <em>maximum bid for the ad to be displayed at the top of the first page</em><br>indicates the value greater than about 80% of the lowest bids for which ads were displayed (based on Google Ads statistics for advertisers)<br>the value may differ depending on the location specified in a POST request
          nullable: true
        cpc:
          type: number
          description: <em>cost per click</em><br>indicates the amount paid (USD) for each click on the ad displayed for a given keyword
          nullable: true
        monthly_searches:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/MonthlySearchesInfo'
            nullable: true
          description: '<em>monthly searches</em><br>represents the (approximate) number of searches on this keyword idea (as available for the past twelve months), targeted to the specified geographic locations<br>if there is no data, the value is <code>null</code>'
          nullable: true
    KeywordsDataGoogleAdsKeywordsForKeywordsLiveTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/KeywordsDataGoogleAdsKeywordsForKeywordsLiveResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    KeywordsDataGoogleAdsKeywordsForKeywordsLiveResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/KeywordsDataGoogleAdsKeywordsForKeywordsLiveTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    KeywordsDataGoogleAdsAdTrafficByKeywordsTaskPostRequestInfo:
      type: object
      properties:
        keywords:
          type: array
          items:
            type: string
          description: '<em>keywords</em><br><strong>required field</strong><br>The maximum number of keywords you can specify: 1000<br>The maximum number of characters for each keyword: 80<br>The maximum number of words for each keyword phrase: 10<br>the keywords you specify will be converted to a lowercase format<br><strong>Note #1:</strong> <a href="https://dataforseo.com/help-center/no-search-volume-data-for-some-keywords" target="_blank" rel="noopener noreferrer">Google Ads may return no data for certain groups of keywords</a>;<br><strong>Note #2:</strong> <a href="https://dataforseo.com/help-center/sv-broad-exact-phrase-match" target="_blank" rel="noopener noreferrer">Google Ads provides combined search volume values for groups of similar keywords</a><br>to obtain search volume for similar keywords, we recommend submitting such keywords in separate requests;<br><strong>Note #3:</strong> Google Ads doesn''t allow using certain symbols and characters (e.g., UTF symbols, emojis), so you can''t use them when setting a task;<br>to learn more about which symbols and characters can be used, please refer to <a href="https://dataforseo.com/help-center/using-symbols-in-keywords-when-setting-a-google-ads-task" target="_blank" rel="noopener noreferrer">this article</a><p>learn more about rules and limitations of <code>keyword</code> and <code>keywords</code> fields in DataForSEO APIs in this <a href="https://dataforseo.com/help-center/rules-and-limitations-of-keyword-and-keywords-fields-in-dataforseo-apis" rel="noopener noreferrer" target="_blank">Help Center article</a>'
        bid:
          type: number
          description: '<em>the maximum custom bid</em><br><strong>required field</strong><br>the collected data will be based on this value<br>it stands for the price you are willing to pay for an ad; the higher value you specify here, the higher values you will get in the returned metrics<br>learn more in <a href="https://dataforseo.com/help-center/configuring-bid">this help center article</a>'
        match:
          type: string
          description: '<em>keywords match-type</em><br><strong>required field</strong><br>can take the following values: <code>exact</code>, <code>broad</code>, <code>phrase</code>'
        location_name:
          type: string
          description: '<em>full name of search engine location</em><br>optional field<br>if you do not indicate the location, you will receive worldwide results, i.e., for all available locations;<br><strong>if you use this field, you don''t need to specify <code>location_code</code> or <code>location_coordinate</code></strong><br>you can receive the list of available locations of the search engine with their <code>location_name</code> by making a separate request to <code>https://api.dataforseo.com/v3/keywords_data/google_ads/locations</code><br>example:<br><code class="long-string">London,England,United Kingdom</code>'
          nullable: true
        location_code:
          type: integer
          description: '<em>search engine location code</em><br>optional field<br>if you do not indicate the location, you will receive worldwide results, i.e., for all available locations;<br><strong>if you use this field, you don''t need to specify <code>location_name</code> or <code>location_coordinate</code></strong>;<br>you can receive the list of available locations of the search engines with their <code>location_code</code> by making a separate request to <code>https://api.dataforseo.com/v3/keywords_data/google_ads/locations</code><br>example:<br><code class="long-string">2840</code>'
          nullable: true
        location_coordinate:
          type: string
          description: '<em>GPS coordinates of a location</em><br>optional field<br>if you do not indicate the location, you will receive worldwide results, i.e., for all available locations;<br><strong>if you use this field, you don''t need to specify <code>location_name</code> or <code>location_code</code></strong>;<br><code>location_coordinate</code> parameter should be specified in the <em>"latitude,longitude"</em> format;<br><strong>the data will be provided for the country the specified coordinates belong to</strong>;<br>example:<br><code class="long-string">52.6178549,-155.352142</code>'
          nullable: true
        language_name:
          type: string
          description: <em>full name of search engine language</em><br>optional field<br>you can receive the list of available languages of the search engine with their <code>language_name</code> by making a separate request to <code>https://api.dataforseo.com/v3/keywords_data/google_ads/languages</code><br>example:<br><code class="long-string">English</code>
          nullable: true
        language_code:
          type: string
          description: <em>search engine language code</em><br>optional field<br>you can receive the list of available languages of the search engine with their <code>language_code</code> by making a separate request to <code>https://api.dataforseo.com/v3/keywords_data/google_ads/languages</code><br>example:<br><code class="long-string">en</code>
          nullable: true
        date_from:
          type: string
          description: '<em>starting date of the forecasting time range</em><br>required field if you specify <code>date_to</code><br><strong>if you indicate <code>date_from</code> and <code>date_to</code>, you don''t need to specify <code>date_interval</code></strong><br>minimum value is tomorrow''s date<br>the value you specify in <code>date_from</code> shouldn''t be further than <code>date_to</code><br>date format: <code>"yyyy-mm-dd"</code><br>example:<br><code>"2021-10-30"</code>if <a href="/v3/keywords_data/google_ads/status/" target="_blank" rel="noopener noreferrer">Status endpoint</a> returns <code>false</code> in the <code>actual_data</code> field, <code>date_from</code> can be set to the month before last and prior;<br>if <a href="/v3/keywords_data/google_ads/status/" target="_blank" rel="noopener noreferrer">Status endpoint</a> returns <code>true</code> in the <code>actual_data</code> field, <code>date_from</code> can be set to the last month and prior'
        date_to:
          type: string
          description: '<em>ending date of the forecasting time range</em><br>required field if you specify <code>date_from</code><br><strong>if you indicate <code>date_from</code> and <code>date_to</code>, you don''t need to specify <code>date_interval</code></strong><br>minimum value is <code>date_from</code> +1 day<br>maximum value is current day and month of the next year<br>date format: <code>"yyyy-mm-dd"</code><br>example:<br><code>"2022-10-30"</code>'
        date_interval:
          type: string
          description: '<em>forecasting date interval</em><br>optional field<br><strong>if you specify <code>date_interval</code>, you don''t need to indicate <code>date_from</code> and <code>date_to</code></strong><br>possible values: <code>next_week</code>, <code>next_month</code>, <code>next_quarter</code><br>default value: <code>next_month</code>'
          nullable: true
        sort_by:
          type: string
          description: '<em>results sorting parameters</em><br>optional field<br>Use these parameters to sort the results by <code>relevance</code>, <code>average_cpc</code>, <code>cost</code>, or <code>clicks</code> in the descending order<br>default value: <code>relevance</code>'
          nullable: true
        postback_url:
          type: string
          description: '<em>URL for sending task results</em><br>optional field<br>once the task is completed, we will send a POST request with its results compressed in the <code>gzip</code> format to the <code>postback_url</code> you specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/postbackscript?id=$id</code><br><code>http://your-server.com/postbackscript?id=$id&amp;tag=$tag</code><br><strong>Note:</strong> special characters in <code>postback_url</code> will be urlencoded;<br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href="https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api" target="_blank" rel="noopener noreferrer">Help Center</a>'
          nullable: true
        pingback_url:
          type: string
          description: '<em>notification URL of a completed task</em><br>optional field<br>when a task is completed we will notify you by GET request sent to the URL you have specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/pingscript?id=$id</code><br><code>http://your-server.com/pingscript?id=$id&amp;tag=$tag</code><br><strong>Note:</strong> special characters in <code>pingback_url</code> will be urlencoded;<br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href="https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api" target="_blank" rel="noopener noreferrer">Help Center</a>'
          nullable: true
        tag:
          type: string
          description: <em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response
          nullable: true
      example:
        - language_code: en
          location_code: 2840
          bid: 999
          match: exact
          keywords:
            - seo marketing
    KeywordsDataGoogleAdsAdTrafficByKeywordsTaskPostTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: object
              description: '<em>array of results</em><br>in this case, the value will be <code>null</code>'
              nullable: true
    KeywordsDataGoogleAdsAdTrafficByKeywordsTaskPostResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/KeywordsDataGoogleAdsAdTrafficByKeywordsTaskPostTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    KeywordsDataGoogleAdsAdTrafficByKeywordsTasksReadyResultInfo:
      type: object
      properties:
        id:
          type: string
          description: <em>task identifier of the completed task</em><br><strong>unique task identifier in our system in the <a href="https://en.wikipedia.org/wiki/Universally_unique_identifier">UUID</a> format</strong>
          nullable: true
        se:
          type: string
          description: <em>search engine specified when setting the task</em>
          nullable: true
        se_type:
          type: string
          nullable: true
        date_posted:
          type: string
          description: <em>date when the task was posted (in the UTC format)</em>
          nullable: true
        tag:
          type: string
          nullable: true
        endpoint:
          type: string
          description: <em>URL for collecting the results of the task</em>
          nullable: true
    KeywordsDataGoogleAdsAdTrafficByKeywordsTasksReadyTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/KeywordsDataGoogleAdsAdTrafficByKeywordsTasksReadyResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    KeywordsDataGoogleAdsAdTrafficByKeywordsTasksReadyResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/KeywordsDataGoogleAdsAdTrafficByKeywordsTasksReadyTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    KeywordsDataGoogleAdsAdTrafficByKeywordsTaskGetResultInfo:
      type: object
      properties:
        keyword:
          type: string
          description: <em>keyword in a POST array</em><br>metrics are provided for all the keywords specified in the POST array
          nullable: true
        location_code:
          type: integer
          description: '<em>location code in a POST array</em><br>if there is no data, then the value is_<code>null</code>n'
          nullable: true
        language_code:
          type: string
          description: '<em>language code in a POST array</em><br>if there is no data, then the value is_<code>null</code>n'
          nullable: true
        date_interval:
          type: string
          description: <em>forecasting date interval in a POST array</em>
          nullable: true
        search_partners:
          type: boolean
          description: <em>include Google search partners</em><br>the value is always <code>false</code>
          nullable: true
        bid:
          type: number
          description: '<em>the maximum custom bid</em><br>the bid you have specified when setting the task<br>represents the price you are willing to pay for an ad<br>the higher value you have specified, the higher metrics and cost you receive in response<br>learn more in <a href="https://dataforseo.com/help-center/configuring-bid">this help center article</a>'
          nullable: true
        match:
          type: string
          description: '<em>keywords match-type</em><br>can take the following values: <code>exact</code>, <code>broad</code>, <code>phrase</code>'
          nullable: true
        impressions:
          type: integer
          description: '<em>projected number of ad impressions</em><br>number of impressions an ad is projected to get within the specified time period<br><strong>Note:</strong> parameter deprecated, the value is always_<code>null</code>n'
          nullable: true
        ctr:
          type: number
          description: '<em>projected clickthrough rate (CTR) of the advertisement</em><br>number of clicks an ad is projected to receive divided by the number of ad impressions;<br><strong>Note:</strong> parameter deprecated, the value is always <code>null</code>'
          format: double
          nullable: true
        average_cpc:
          type: number
          description: '<em>the average cost-per-click value</em><br>represents the cost-per-click (USD) estimated for a keyword based on the specified time period and historical data;<br>if there is no data, then the value is_<code>null</code>n'
          format: double
          nullable: true
        cost:
          type: number
          description: '<em>charge for an ad</em><br>amount that will be charged for running an ad within the specified time period<br>if there is no data, then the value is_<code>null</code>n'
          nullable: true
        clicks:
          type: number
          description: '<em>number of clicks on an ad</em><br>number of clicks an ad is projected to get within the specified time period<br>if there is no data, then the value is_<code>null</code>n'
          nullable: true
    KeywordsDataGoogleAdsAdTrafficByKeywordsTaskGetTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/KeywordsDataGoogleAdsAdTrafficByKeywordsTaskGetResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    KeywordsDataGoogleAdsAdTrafficByKeywordsTaskGetResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/KeywordsDataGoogleAdsAdTrafficByKeywordsTaskGetTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    KeywordsDataGoogleAdsAdTrafficByKeywordsLiveRequestInfo:
      type: object
      properties:
        keywords:
          type: array
          items:
            type: string
          description: '<em>keywords</em><br><strong>required field</strong><br>The maximum number of keywords you can specify: 1000<br>The maximum number of characters for each keyword: 80<br>The maximum number of words for each keyword phrase: 10<br>the keywords you specify will be converted to a lowercase format<br><strong>Note:</strong> Google Ads may return no data for certain groups of keywords<br><a href="https://dataforseo.com/help-center/no-search-volume-data-for-some-keywords" target="_blank" rel="noopener noreferrer">visit our Help Center to learn more</a><br><strong>Also note</strong> that Google Ads doesn''t allow using certain symbols and characters (e.g., UTF symbols, emojis), so you can''t use them when setting a task;<br>to learn more about which symbols and characters can be used, please refer to <a href="https://dataforseo.com/help-center/using-symbols-in-keywords-when-setting-a-google-ads-task" target="_blank" rel="noopener noreferrer">this article</a><p>learn more about rules and limitations of <code>keyword</code> and <code>keywords</code> fields in DataForSEO APIs in this <a href="https://dataforseo.com/help-center/rules-and-limitations-of-keyword-and-keywords-fields-in-dataforseo-apis" rel="noopener noreferrer" target="_blank">Help Center article</a>'
        bid:
          type: integer
          description: '<em>the maximum custom bid</em><br><strong>required field</strong><br>the collected data will be based on this value<br>it stands for the price you are willing to pay for an ad; the higher value you specify here, the higher values you will get in the returned metrics<br>learn more in <a href="https://dataforseo.com/help-center/configuring-bid">this help center article</a>'
          format: int64
        match:
          type: string
          description: '<em>keywords match-type</em><br><strong>required field</strong><br>can take the following values: <code>exact</code>, <code>broad</code>, <code>phrase</code>'
        location_name:
          type: string
          description: '<em>full name of search engine location</em><br>optional field<br>if you do not indicate the location, you will receive worldwide results, i.e., for all available locations;<br><strong>if you use this field, you don''t need to specify <code>location_code</code> or <code>location_coordinate</code></strong><br>you can receive the list of available locations of the search engine with their <code>location_name</code> by making a separate request to <code>https://api.dataforseo.com/v3/keywords_data/google_ads/locations</code><br>example:<br><code class="long-string">London,England,United Kingdom</code>'
          nullable: true
        location_code:
          type: integer
          description: '<em>search engine location code</em><br>optional field<br>if you do not indicate the location, you will receive worldwide results, i.e., for all available locations;<br><strong>if you use this field, you don''t need to specify <code>location_name</code> or <code>location_coordinate</code></strong>;<br>you can receive the list of available locations of the search engines with their <code>location_code</code> by making a separate request to <code>https://api.dataforseo.com/v3/keywords_data/google_ads/locations</code><br>example:<br><code class="long-string">2840</code>'
          nullable: true
        location_coordinate:
          type: string
          description: '<em>GPS coordinates of a location</em><br>optional field<br>if you do not indicate the location, you will receive worldwide results, i.e., for all available locations;<br><strong>if you use this field, you don''t need to specify <code>location_name</code> or <code>location_code</code></strong>;<br><code>location_coordinate</code> parameter should be specified in the <em>"latitude,longitude"</em> format;<br><strong>the data will be provided for the country the specified coordinates belong to</strong>;<br>example:<br><code class="long-string">52.6178549,-155.352142</code>'
          nullable: true
        language_name:
          type: string
          description: <em>full name of search engine language</em><br>optional field<br>you can receive the list of available languages of the search engine with their <code>language_name</code> by making a separate request to <code>https://api.dataforseo.com/v3/keywords_data/google_ads/languages</code><br>example:<br><code class="long-string">English</code>
          nullable: true
        language_code:
          type: string
          description: <em>search engine language code</em><br>optional field<br>you can receive the list of available languages of the search engine with their <code>language_code</code> by making a separate request to <code>https://api.dataforseo.com/v3/keywords_data/google_ads/languages</code><br>example:<br><code class="long-string">en</code>
          nullable: true
        date_from:
          type: string
          description: '<em>starting date of the forecasting time range</em><br>required field if you specify <code>date_to</code><br><strong>if you indicate <code>date_from</code> and <code>date_to</code>, you don''t need to specify <code>date_interval</code></strong><br>minimum value is tomorrow''s date<br>the value you specify in <code>date_from</code> shouldn''t be further than <code>date_to</code><br>date format: <code>"yyyy-mm-dd"</code><br>example:<br><code>"2021-10-30"</code>if <a href="/v3/keywords_data/google_ads/status/" target="_blank" rel="noopener noreferrer">Status endpoint</a> returns <code>false</code> in the <code>actual_data</code> field, <code>date_from</code> can be set to the month before last and prior;<br>if <a href="/v3/keywords_data/google_ads/status/" target="_blank" rel="noopener noreferrer">Status endpoint</a> returns <code>true</code> in the <code>actual_data</code> field, <code>date_from</code> can be set to the last month and prior'
        date_to:
          type: string
          description: '<em>ending date of the forecasting time range</em><br>required field if you specify <code>date_from</code><br><strong>if you indicate <code>date_from</code> and <code>date_to</code>, you don''t need to specify <code>date_interval</code></strong><br>minimum value is <code>date_from</code> +1 day<br>maximum value is current day and month of the next year<br>date format: <code>"yyyy-mm-dd"</code><br>example:<br><code>"2022-10-30"</code>'
        date_interval:
          type: string
          description: '<em>forecasting date interval</em><br>optional field<br><strong>if you specify <code>date_interval</code>, you don''t need to indicate <code>date_from</code> and <code>date_to</code></strong><br>possible values: <code>next_week</code>, <code>next_month</code>, <code>next_quarter</code><br>default value: <code>next_month</code>'
          nullable: true
        sort_by:
          type: string
          description: '<em>results sorting parameters</em><br>optional field<br>Use these parameters to sort the results by <code>relevance</code>, <code>impressions</code>, <code>ctr</code>, <code>average_cpc</code>, <code>cost</code>, or <code>clicks</code> in the descending order<br>default value: <code>relevance</code>'
          nullable: true
        tag:
          type: string
          description: <em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response
          nullable: true
      example:
        - location_code: 2840
          language_code: en
          bid: 999
          match: exact
          keywords:
            - seo marketing
    KeywordsDataGoogleAdsAdTrafficByKeywordsLiveResultInfo:
      type: object
      properties:
        keyword:
          type: string
          description: <em>keyword in a POST array</em>
          nullable: true
        location_code:
          type: integer
          description: '<em>location code in a POST array</em><br>if there is no data, then the value is_<code>null</code>n'
          nullable: true
        language_code:
          type: string
          description: '<em>language code in a POST array</em><br>if there is no data, then the value is_<code>null</code>n'
          nullable: true
        date_interval:
          type: string
          description: <em>forecasting date interval in a POST array</em>
          nullable: true
        search_partners:
          type: boolean
          description: '<em>include Google search partners</em><br>the value you specified when setting the task<br><strong>Note:</strong> parameter deprecated, the value is always <code>false</code>'
          nullable: true
        bid:
          type: number
          description: '<em>the maximum custom bid</em><br>the bid you have specified when setting the task<br>represents the price you are willing to pay for an ad<br>the higher value you have specified, the higher metrics and cost you receive in response<br>learn more in <a href="https://dataforseo.com/help-center/configuring-bid">this help center article</a>'
          format: int64
          nullable: true
        match:
          type: string
          description: '<em>keywords match-type</em><br>can take the following values: <code>exact</code>, <code>broad</code>, <code>phrase</code>'
          nullable: true
        impressions:
          type: integer
          description: '<em>projected number of ad impressions</em><br>number of impressions an ad is projected to get within the specified time period<br><strong>Note:</strong> parameter deprecated, the value is always <code>null</code>'
          nullable: true
        ctr:
          type: number
          description: '<em>projected click through rate (CTR) of the advertisement</em><br>number of clicks an ad is projected to receive divided by the number of ad impressions; the CTR is projected for the specified time period<br><strong>Note:</strong> parameter deprecated, the value is always <code>null</code>'
          format: double
          nullable: true
        average_cpc:
          type: number
          description: '<em>the average cost-per-click value</em><br>represents the cost-per-click (USD) estimated for a keyword based on the specified time period and historical data;<br>if there is no data, then the value is_<code>null</code>n'
          format: double
          nullable: true
        cost:
          type: number
          description: '<em>total <i>tasks</i> cost, USD</em>'
          nullable: true
        clicks:
          type: number
          description: '<em>number of clicks on an ad</em><br>number of clicks an ad is projected to get within the specified time period<br>if there is no data, then the value is_<code>null</code>n'
          nullable: true
    KeywordsDataGoogleAdsAdTrafficByKeywordsLiveTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/KeywordsDataGoogleAdsAdTrafficByKeywordsLiveResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    KeywordsDataGoogleAdsAdTrafficByKeywordsLiveResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/KeywordsDataGoogleAdsAdTrafficByKeywordsLiveTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    KeywordsDataGoogleTrendsLocationsResultInfo:
      type: object
      properties:
        location_code:
          type: integer
          description: <em>location code</em>
          nullable: true
        location_name:
          type: string
          description: <em>full name of the location</em>
          nullable: true
        location_code_parent:
          type: integer
          description: '<em>the code of the superordinate location</em><br>example:<br><code>"location_code": 9041134,<br>"location_name": "Vienna International Airport,Lower Austria,Austria",<br>"location_code_parent": 20044</code><br>where <code>location_code_parent</code> corresponds to:<br><code>"location_code": 20044,<br>"location_name": "Lower Austria,Austria"</code>'
          nullable: true
        country_iso_code:
          type: string
          description: <em>ISO country code of the location</em>
          nullable: true
        location_type:
          type: string
          description: <em>location type</em><br>possible values according to <a href="https://developers.google.com/adwords/api/docs/appendix/geotargeting" target="_blank" rel="noopener noreferrer">Google’s target types</a>
          nullable: true
        geo_id:
          type: string
          description: <em>google trends location identifier</em><br>you can use this field for matching obtained results with the <code>location_code</code> parameter specified in the request
          nullable: true
    KeywordsDataGoogleTrendsLocationsTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/KeywordsDataGoogleTrendsLocationsResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    KeywordsDataGoogleTrendsLocationsResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/KeywordsDataGoogleTrendsLocationsTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    KeywordsDataGoogleTrendsLocationsCountryResultInfo:
      type: object
      properties:
        location_code:
          type: integer
          description: <em>location code</em>
          nullable: true
        location_name:
          type: string
          description: <em>full name of the location</em>
          nullable: true
        location_code_parent:
          type: integer
          description: '<em>the code of the superordinate location</em><br>example:<br><code>"location_code": 9041134,<br>"location_name": "Vienna International Airport,Lower Austria,Austria",<br>"location_code_parent": 20044</code><br>where <code>location_code_parent</code> corresponds to:<br><code>"location_code": 20044,<br>"location_name": "Lower Austria,Austria"</code>'
          nullable: true
        country_iso_code:
          type: string
          description: <em>ISO country code of the location</em>
          nullable: true
        location_type:
          type: string
          description: <em>location type</em><br>possible values according to <a href="https://developers.google.com/adwords/api/docs/appendix/geotargeting" target="_blank" rel="noopener noreferrer">Google’s target types</a>
          nullable: true
        geo_id:
          type: string
          description: <em>google trends location identifier</em><br>you can use this field for matching obtained results with the <code>location_code</code> parameter specified in the request
          nullable: true
    KeywordsDataGoogleTrendsLocationsCountryTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/KeywordsDataGoogleTrendsLocationsCountryResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    KeywordsDataGoogleTrendsLocationsCountryResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/KeywordsDataGoogleTrendsLocationsCountryTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    KeywordsDataGoogleTrendsLanguagesResultInfo:
      type: object
      properties:
        language_name:
          type: string
          description: <em>language name</em>
          nullable: true
        language_code:
          type: string
          description: <em>language code according to <a href="https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes" target="_blank" rel="noopener noreferrer">ISO 639-1</a></em>
          nullable: true
    KeywordsDataGoogleTrendsLanguagesTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/KeywordsDataGoogleTrendsLanguagesResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    KeywordsDataGoogleTrendsLanguagesResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/KeywordsDataGoogleTrendsLanguagesTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    KeywordsDataGoogleTrendsCategoriesResultInfo:
      type: object
      properties:
        category_code:
          type: integer
          description: <em>unique google trends category identifier</em>
          nullable: true
        category_name:
          type: string
          description: <em>name of the google trends category</em>
          nullable: true
        category_code_parent:
          type: integer
          description: '<em>the code of the superordinate category</em><br>example:<br><code>"category_code": 1100,</code><br><code>"category_name": "Superhero Films",</code><br><code>"category_code_parent": 1097</code> <br>where <code>category_code_parent</code> corresponds to: <br><code>"category_code": 1097,</code><br><code>"category_name": "Action &amp; Adventure Films"</code>'
          nullable: true
    KeywordsDataGoogleTrendsCategoriesTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/KeywordsDataGoogleTrendsCategoriesResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    KeywordsDataGoogleTrendsCategoriesResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/KeywordsDataGoogleTrendsCategoriesTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    KeywordsDataGoogleTrendsExploreTaskPostRequestInfo:
      type: object
      properties:
        keywords:
          type: array
          items:
            type: string
          description: '<em>keywords</em><br><strong>required field if you don''t specify `category_code`</strong><br>the maximum number of keywords you can specify: 5<br>the maximum number of characters you can specify in a keyword: 100<br>the minimum number of characters must be greater than 1<br>comma characters (<code>,</code>) in the specified keywords will be unset and ignored<p><strong>Note:</strong> keywords cannot consist of a combination of the following characters: <code>&lt; &gt; |  " - + = ~ ! : * ( ) [ ] { }</code><p><strong>Note:</strong> to obtain <code>google_trends_topics_list</code> and <code>google_trends_queries_list</code> items, specify no more than 1 keyword<p>learn more about rules and limitations of <code>keyword</code> and <code>keywords</code> fields in DataForSEO APIs in this <a href="https://dataforseo.com/help-center/rules-and-limitations-of-keyword-and-keywords-fields-in-dataforseo-apis" rel="noopener noreferrer" target="_blank">Help Center article</a>'
        location_name:
          type: string
          description: '<em>full name of search engine location</em><br>optional field<br>if you don''t use this field, you will recieve global results<br><strong>if you use this field, you don''t need to specify <code>location_code</code></strong><br>you can use this field as an array to set several locations, each corresponding to a specific keyword - <a href="https://dataforseo.com/help-center/multiple-locations-in-google-trends-api" rel="noopener noreferrer" target="_blank">learn more</a>;<br>you can receive the list of available locations of the search engine with their <code>location_name</code> by making a separate request to <code>https://api.dataforseo.com/v3/keywords_data/google_trends/locations</code><br>example:<br><code class="long-string">United Kingdom</code>'
          nullable: true
        location_code:
          type: string
          description: '<em>search engine location code</em><br>optional field<br>if you don''t use this field, you will recieve global results<br><strong>if you use this field, you don''t need to specify <code>location_name</code></strong><br>you can use this field as an array to set several locations, each corresponding to a specific keyword - <a href="https://dataforseo.com/help-center/multiple-locations-in-google-trends-api" rel="noopener noreferrer" target="_blank">learn more</a>;<br>you can receive the list of available locations of the search engines with their <code>location_code</code> by making a separate request to <code>https://api.dataforseo.com/v3/keywords_data/google_trends/locations</code><br>example:<br><code class="long-string">2840</code>'
          nullable: true
        language_name:
          type: string
          description: '<em>full name of search engine language</em><br>optional field<br>default value: <code>English</code><br>if you use this field, you don''t need to specify <code>language_code</code><br>you can receive the list of available languages of the search engine with their <code>language_name</code> by making a separate request to <code>https://api.dataforseo.com/v3/keywords_data/google_trends/languages</code><br>example:<br><code class="long-string">English</code>'
          nullable: true
        language_code:
          type: string
          description: '<em>search engine language code</em><br>optional field<br>default value: <code>en</code><br>if you use this field, you don''t need to specify <code>language_name</code><br>you can receive the list of available languages of the search engine with their <code>language_code</code> by making a separate request to <code>https://api.dataforseo.com/v3/keywords_data/google_trends/languages</code><br>example:<br><code class="long-string">en</code>'
          nullable: true
        type:
          type: string
          description: type of element
          nullable: true
        category_code:
          type: integer
          description: '<em>google trends search category</em><br><strong>required field if you don''t specify `keywords`</strong><br>if you don''t specify `keywords`, the value of this field must be greater than `0`<br>if you specify `keywords` and don''t specify this field, the <code>0</code> value will be applied by default and the search will be carried out across all available categories<br>you can receive the list of available categories with their <code>category_code</code> by making a separate request to the <code>https://api.dataforseo.com/v3/keywords_data/google_trends/categories</code>'
        date_from:
          type: string
          description: '<em>starting date of the time range</em><br>optional field<br>if you don''t specify this field, the current day and month of the preceding year will be used by default<br>minimal value for the <code>web</code> type: <code>2004-01-01</code><br>minimal value for other types: <code>2008-01-01</code><br>date format: <code>"yyyy-mm-dd"</code><br>example:<br><code>"2019-01-15"</code>'
          nullable: true
        date_to:
          type: string
          description: '<em>ending date of the time range</em><br>optional field<br>if you don''t specify this field, the today''s date will be used by default<br>date format: <code>"yyyy-mm-dd"</code><br>example:<br><code>"2019-01-15"</code>'
          nullable: true
        time_range:
          type: string
          description: '<em>preset time ranges</em><br>optional field<br>if you specify <code>date_from</code> or <code>date_to</code> parameters, this field will be ignored when setting a task<br><em>possible values for all <code>type</code> parameters:</em><br><code>past_hour</code>, <code>past_4_hours</code>, <code>past_day</code>, <code>past_7_days</code>, <code>past_30_days</code>, <code>past_90_days</code>, <code>past_12_months</code>, <code>past_5_years</code><br><em>possible values for <code>web</code> only:</em><br><code>2004_present</code><br><em>possible values for <code>news</code>, <code>youtube</code>, <code>images</code>, <code>froogle</code>:</em><br><code>2008_present</code>'
          nullable: true
        item_types:
          type: array
          items:
            type: string
          description: '<em>types of items returned</em><br>optional field<br>to speed up the execution of the request, specify one item at a time;<br>possible values:<br><code>"google_trends_graph"</code>, <code>"google_trends_map"</code>, <code>"google_trends_topics_list"</code>,<code>"google_trends_queries_list"</code><br>default value:<br><code>"google_trends_graph"</code><p><strong>Note:</strong> to obtain <code>google_trends_topics_list</code> and <code>google_trends_queries_list</code> items, specify no more than 1 keyword in the <code>keywords</code> field'
          nullable: true
        postback_url:
          type: string
          description: '<em>URL for sending task results</em><br>optional field<br>once the task is completed, we will send a POST request with its results compressed in the <code>gzip</code> format to the <code>postback_url</code> you specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/postbackscript?id=$id</code><br><code>http://your-server.com/postbackscript?id=$id&amp;tag=$tag</code><br><strong>Note:</strong> special characters in <code>postback_url</code> will be urlencoded;<br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href="https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api" target="_blank" rel="noopener noreferrer">Help Center</a>'
          nullable: true
        pingback_url:
          type: string
          description: '<em>notification URL of a completed task</em><br>optional field<br>when a task is completed we will notify you by GET request sent to the URL you have specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request<br>example:<br><code>http://your-server.com/pingscript?id=$id</code><br><code>http://your-server.com/pingscript?id=$id&amp;tag=$tag</code><br><strong>Note:</strong> special characters in <code>pingback_url</code> will be urlencoded;<br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href="https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api" target="_blank" rel="noopener noreferrer">Help Center</a>'
          nullable: true
        tag:
          type: string
          description: <em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response
          nullable: true
      example:
        - date_from: '2019-01-01'
          date_to: '2020-01-01'
          type: youtube
          category_code: 3
          keywords:
            - seo api
            - rank api
    KeywordsDataGoogleTrendsExploreTaskPostTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: object
              description: '<em>array of results</em><br>in this case, the value will be <code>null</code>'
              nullable: true
    KeywordsDataGoogleTrendsExploreTaskPostResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/KeywordsDataGoogleTrendsExploreTaskPostTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    KeywordsDataGoogleTrendsExploreTasksReadyResultInfo:
      type: object
      properties:
        id:
          type: string
          description: <em>task identifier of the completed task</em><br><strong>unique task identifier in our system in the <a href="https://en.wikipedia.org/wiki/Universally_unique_identifier">UUID</a> format</strong>
          nullable: true
        se:
          type: string
          description: <em>search engine specified when setting the task</em>
          nullable: true
        se_type:
          type: string
          nullable: true
        date_posted:
          type: string
          description: <em>date when the task was posted (in the UTC format)</em>
          nullable: true
        tag:
          type: string
          nullable: true
        endpoint:
          type: string
          description: <em>URL for collecting the results of the task</em>
          nullable: true
    KeywordsDataGoogleTrendsExploreTasksReadyTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/KeywordsDataGoogleTrendsExploreTasksReadyResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    KeywordsDataGoogleTrendsExploreTasksReadyResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/KeywordsDataGoogleTrendsExploreTasksReadyTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    TrendsGraphDataInfo:
      type: object
      properties:
        date_from:
          type: string
          description: '<em>start date of the corresponding time range</em><br>in the UTC format: "yyyy-mm-dd"'
          nullable: true
        date_to:
          type: string
          description: '<em>end date of the corresponding time range</em><br>in the UTC format: "yyyy-mm-dd"'
          nullable: true
        timestamp:
          type: integer
          description: <em>a point in time in the <a href="https://en.wikipedia.org/wiki/Unix_time">Unix time format</a></em>
          nullable: true
        missing_data:
          type: boolean
          description: <em>indicates whether the data is unavailable<em><br>if <code>true<code> the data on the graph in the Google Trends interface is missing and thus labelled with a dotted line
          nullable: true
        values:
          type: array
          items:
            type: number
            nullable: true
          description: '<em>relative keyword popularity rate at a specific timestamp</em><br>represents the keyword popularity rate over the given time range<br><strong>if you specify more than one keyword, the values will be averaged to the highest value across all specified keywords</strong><br>a value of 100 is the peak popularity for the term. A value of 50 means that the term is half as popular. A score of 0 means there was not enough data for this term'
          nullable: true
    GoogleTrendsGoogleTrendsGraphElementItem:
      type: object
      allOf:
        - type: object
          oneOf:
            - $ref: '#/components/schemas/BaseKeywordDataGoogleTrendsItem'
          nullable: true
        - type: object
          properties:
            data:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/TrendsGraphDataInfo'
                nullable: true
              description: <em>Google Trends data for the specified parameters</em>
              nullable: true
            averages:
              type: array
              items:
                type: number
                format: double
                nullable: true
    TrendsMapDataInfo:
      type: object
      properties:
        geo_id:
          type: string
          description: <em>Google Trends location identifier</em><br>you can use this field for matching obtained results with location parameters specified in the request<br>example:<br><code>US-NY</code>
          nullable: true
        geo_name:
          type: string
          description: <em>Google Trends location name</em><br>you can use this field for matching obtained results with location parameters specified in the request
          nullable: true
        values:
          type: array
          items:
            type: number
            nullable: true
          description: '<em>relative keyword popularity rate in a given location</em><br>represents the location-specific keyword popularity rate over the given time range<br><strong>if you specify more than one keyword, the values will be averaged to the highest value across all specified keywords</strong><br>a value of <code>100</code> is the peak popularity for the term<br>a value of <code>50</code> means that the term is half as popular<br>a value of <code>0</code> means there was not enough data for this term'
          nullable: true
        max_value_index:
          type: integer
          description: '<em>max value among comparable terms</em><br>represents the maximum value if you specified more than two keywords in a POST array<br>if you specified only one keyword, the value will be <code>null</code>'
          nullable: true
    GoogleTrendsGoogleTrendsMapElementItem:
      type: object
      allOf:
        - type: object
          oneOf:
            - $ref: '#/components/schemas/BaseKeywordDataGoogleTrendsItem'
          nullable: true
        - type: object
          properties:
            data:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/TrendsMapDataInfo'
                nullable: true
              description: <em>Google Trends data from the corresponding item</em>
              nullable: true
    ListDataInfo:
      type: object
      properties:
        top:
          type: array
          items:
            type: object
            nullable: true
          description: <em>the most popular related topics</em><br>represents the list of the most popular related topics
          nullable: true
        rising:
          type: array
          items:
            type: object
            nullable: true
          description: <em>emerging related topics</em><br>represents the list of related topics with the biggest increase in search frequency since the last time period
          nullable: true
    GoogleTrendsGoogleTrendsQueriesListElementItem:
      type: object
      allOf:
        - type: object
          oneOf:
            - $ref: '#/components/schemas/BaseKeywordDataGoogleTrendsItem'
          nullable: true
        - type: object
          properties:
            data:
              type: object
              oneOf:
                - $ref: '#/components/schemas/ListDataInfo'
              description: <em>Google Trends data from the corresponding item</em>
              nullable: true
    GoogleTrendsGoogleTrendsTopicsListElementItem:
      type: object
      allOf:
        - type: object
          oneOf:
            - $ref: '#/components/schemas/BaseKeywordDataGoogleTrendsItem'
          nullable: true
        - type: object
          properties:
            data:
              type: object
              oneOf:
                - $ref: '#/components/schemas/ListDataInfo'
              description: <em>Google Trends data from the corresponding item</em>
              nullable: true
    KeywordsDataGoogleTrendsExploreTaskGetResultInfo:
      type: object
      properties:
        keywords:
          type: array
          items:
            type: string
            nullable: true
          description: <em>keywords in a POST array</em>
          nullable: true
        type:
          type: string
          description: type of element
          nullable: true
        location_code:
          type: integer
          description: '<em>location code in a POST array</em><br>if there is no data, then the value is_<code>null</code>n'
          nullable: true
        language_code:
          type: string
          description: '<em>language code in a POST array</em><br>if there is no data, then the value is_<code>null</code>n'
          nullable: true
        check_url:
          type: string
          description: <em>direct URL to the Google Trends results</em><br>you can use it to make sure that we provided accurate results
          nullable: true
        datetime:
          type: string
          description: '<em>date and time when the result was received</em><br>in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”<br>example:<br><code class="long-string">2019-11-15 12:57:46 +00:00</code>'
          nullable: true
        items_count:
          type: integer
          description: <em>the number of results returned in the <strong><code>items</code></strong> array</em>
          format: int64
          nullable: true
        items:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/BaseKeywordDataGoogleTrendsItem'
            nullable: true
          description: <em>items on the Google Trends page</em>
          nullable: true
    KeywordsDataGoogleTrendsExploreTaskGetTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/KeywordsDataGoogleTrendsExploreTaskGetResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    KeywordsDataGoogleTrendsExploreTaskGetResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/KeywordsDataGoogleTrendsExploreTaskGetTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    KeywordsDataGoogleTrendsExploreLiveRequestInfo:
      type: object
      properties:
        keywords:
          type: array
          items:
            type: string
          description: '<em>keywords</em><br><strong>required field if you don''t specify `category_code`</strong><br>the maximum number of keywords you can specify: 5<br>the maximum number of characters you can specify in a keyword: 100<br>the minimum number of characters must be greater than 1<br>comma characters (<code>,</code>) in the specified keywords will be unset and ignored<p><strong>Note:</strong> keywords cannot consist of a combination of the following characters: <code>&lt; &gt; |  " - + = ~ ! : * ( ) [ ] { }</code><p><strong>Note:</strong> to obtain <code>google_trends_topics_list</code> and <code>google_trends_queries_list</code> items, specify no more than 1 keyword<p>learn more about rules and limitations of <code>keyword</code> and <code>keywords</code> fields in DataForSEO APIs in this <a href="https://dataforseo.com/help-center/rules-and-limitations-of-keyword-and-keywords-fields-in-dataforseo-apis" rel="noopener noreferrer" target="_blank">Help Center article</a>'
        location_name:
          type: string
          description: '<em>full name of search engine location</em><br>optional field<br>if you don''t use this field, you will recieve global results<br><strong>if you use this field, you don''t need to specify <code>location_code</code></strong><br>you can use this field as an array to set several locations, each corresponding to a specific keyword - <a href="https://dataforseo.com/help-center/multiple-locations-in-google-trends-api" rel="noopener noreferrer" target="_blank">learn more</a>;<br>you can receive the list of available locations of the search engine with their <code>location_name</code> by making a separate request to <code>https://api.dataforseo.com/v3/keywords_data/google_trends/locations</code><br>example:<br><code class="long-string">United Kingdom</code>'
          nullable: true
        location_code:
          type: string
          description: '<em>search engine location code</em><br>optional field<br>if you don''t use this field, you will recieve global results<br><strong>if you use this field, you don''t need to specify <code>location_name</code></strong><br>you can use this field as an array to set several locations, each corresponding to a specific keyword - <a href="https://dataforseo.com/help-center/multiple-locations-in-google-trends-api" rel="noopener noreferrer" target="_blank">learn more</a>;<br>you can receive the list of available locations of the search engines with their <code>location_code</code> by making a separate request to <code>https://api.dataforseo.com/v3/keywords_data/google_trends/locations</code><br>example:<br><code class="long-string">2840</code>'
          nullable: true
        language_name:
          type: string
          description: '<em>full name of search engine language</em><br>optional field<br>default value: <code>English</code><br>if you use this field, you don''t need to specify <code>language_code</code><br>you can receive the list of available languages of the search engine with their <code>language_name</code> by making a separate request to <code>https://api.dataforseo.com/v3/keywords_data/google_trends/languages</code><br>example:<br><code class="long-string">English</code>'
          nullable: true
        language_code:
          type: string
          description: '<em>search engine language code</em><br>optional field<br>default value: <code>en</code><br>if you use this field, you don''t need to specify <code>language_name</code><br>you can receive the list of available languages of the search engine with their <code>language_code</code> by making a separate request to <code>https://api.dataforseo.com/v3/keywords_data/google_trends/languages</code><br>example:<br><code class="long-string">en</code>'
          nullable: true
        type:
          type: string
          description: type of element
          nullable: true
        category_code:
          type: integer
          description: '<em>google trends search category</em><br><strong>required field if you don''t specify `keywords`</strong><br>if you don''t specify `keywords`, the value of this field must be greater than `0`<br>if you specify `keywords` and don''t specify this field, the <code>0</code> value will be applied by default and the search will be carried out across all available categories<br>you can receive the list of available categories with their <code>category_code</code> by making a separate request to the <code>https://api.dataforseo.com/v3/keywords_data/google_trends/categories</code>'
        date_from:
          type: string
          description: '<em>starting date of the time range</em><br>optional field<br>if you don''t specify this field, the current day and month of the preceding year will be used by default<br>minimal value for the <code>web</code> type: <code>2004-01-01</code><br>minimal value for other types: <code>2008-01-01</code><br>date format: <code>"yyyy-mm-dd"</code><br>example:<br><code>"2019-01-15"</code>'
          nullable: true
        date_to:
          type: string
          description: '<em>ending date of the time range</em><br>optional field<br>if you don''t specify this field, the today''s date will be used by default<br>date format: <code>"yyyy-mm-dd"</code><br>example:<br><code>"2019-01-15"</code>'
          nullable: true
        time_range:
          type: string
          description: '<em>preset time ranges</em><br>optional field<br>if you specify <code>date_from</code> or <code>date_to</code> parameters, this field will be ignored when setting a task<br><em>possible values for all <code>type</code> parameters:</em><br><code>past_hour</code>, <code>past_4_hours</code>, <code>past_day</code>, <code>past_7_days</code>, <code>past_30_days</code>, <code>past_90_days</code>, <code>past_12_months</code>, <code>past_5_years</code><br><em>possible values for <code>web</code> only:</em><br><code>2004_present</code><br><em>possible values for <code>news</code>, <code>youtube</code>, <code>images</code>, <code>froogle</code>:</em><br><code>2008_present</code>'
          nullable: true
        item_types:
          type: array
          items:
            type: string
          description: '<em>types of items returned</em><br>optional field<br>to speed up the execution of the request, specify one item at a time;<br>possible values:<br><code>"google_trends_graph"</code>, <code>"google_trends_map"</code>, <code>"google_trends_topics_list"</code>,<code>"google_trends_queries_list"</code><br>default value:<br><code>"google_trends_graph"</code><p><strong>Note:</strong> to obtain <code>google_trends_topics_list</code> and <code>google_trends_queries_list</code> items, specify no more than 1 keyword in the <code>keywords</code> field'
          nullable: true
        tag:
          type: string
          description: <em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response
          nullable: true
      example:
        - location_name: United States
          date_from: '2019-01-01'
          date_to: '2020-01-01'
          type: youtube
          category_code: 3
          keywords:
            - rugby
            - cricket
    GooglePostsSerpElementItem:
      type: object
      allOf:
        - type: object
          oneOf:
            - $ref: '#/components/schemas/BaseSerpApiElementItem'
          nullable: true
        - type: object
          properties:
            rank_group:
              type: integer
              description: "group rank in SERP\nposition within a group of elements with identical type values;\npositions of elements with different type values are omitted from rank_group;\nalways equals 0 for desktop"
              nullable: true
            rank_absolute:
              type: integer
              description: "absolute rank in SERP\nabsolute position among all the elements in SERP\nalways equals 0 for desktop"
              nullable: true
            posts_id:
              type: string
              description: the identifier of the google_posts feature
              nullable: true
            feature:
              type: string
              description: the additional feature of the review
              nullable: true
            cid:
              type: string
              description: google-defined client id
              nullable: true
      deprecated: true
    CoursesElement:
      type: object
      properties:
        type:
          type: string
          description: type of element
          nullable: true
        title:
          type: string
          description: title of the row
          nullable: true
        url:
          type: string
          description: URL of element
          nullable: true
        domain:
          type: string
          description: domain where a link points
          nullable: true
        source:
          type: string
          description: "source of the element\nindicates the source of information included in the top_stories_element"
          nullable: true
        description:
          type: string
          description: description of the results element in SERP
          nullable: true
        date:
          type: string
          description: the date when the page source of the element was published
          nullable: true
        image_url:
          type: string
          description: URL of the image
          nullable: true
        rating:
          type: object
          oneOf:
            - $ref: '#/components/schemas/RatingInfo'
          description: "the element’s rating \nthe popularity rate based on reviews and displayed in SERP"
          nullable: true
    KeywordsDataGoogleTrendsExploreLiveResultInfo:
      type: object
      properties:
        keywords:
          type: array
          items:
            type: string
            nullable: true
          description: <em>keywords in a POST array</em>
          nullable: true
        type:
          type: string
          description: type of element
          nullable: true
        location_code:
          type: integer
          description: '<em>location code in a POST array</em><br>if there is no data, then the value is_<code>null</code>n'
          nullable: true
        language_code:
          type: string
          description: '<em>language code in a POST array</em><br>if there is no data, then the value is_<code>null</code>n'
          nullable: true
        check_url:
          type: string
          description: <em>direct URL to the Google Trends results</em><br>you can use it to make sure that we provided accurate results
          nullable: true
        datetime:
          type: string
          description: '<em>date and time when the result was received</em><br>in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”<br>example:<br><code class="long-string">2019-11-15 12:57:46 +00:00</code>'
          nullable: true
        items_count:
          type: integer
          description: <em>the number of results returned in the <strong><code>items</code></strong> array</em>
          format: int64
          nullable: true
        items:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/BaseKeywordDataGoogleTrendsItem'
            nullable: true
          description: <em>items on the Google Trends page</em>
          nullable: true
    KeywordsDataGoogleTrendsExploreLiveTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/KeywordsDataGoogleTrendsExploreLiveResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    KeywordsDataGoogleTrendsExploreLiveResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/KeywordsDataGoogleTrendsExploreLiveTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    KeywordsDataDataforseoTrendsLocationsResultInfo:
      type: object
      properties:
        location_code:
          type: integer
          description: <em>location code</em>
          nullable: true
        location_name:
          type: string
          description: <em>full name of the location</em>
          nullable: true
        location_code_parent:
          type: integer
          description: '<em>the code of the superordinate location</em><br>example:<br><code>"location_code": 9041134,<br>"location_name": "Vienna International Airport,Lower Austria,Austria",<br>"location_code_parent": 20044</code><br>where <code>location_code_parent</code> corresponds to:<br><code>"location_code": 20044,<br>"location_name": "Lower Austria,Austria"</code>'
          nullable: true
        country_iso_code:
          type: string
          description: <em>ISO country code of the location</em>
          nullable: true
        location_type:
          type: string
          description: <em>location type</em><br>possible values according to <a href="https://developers.google.com/adwords/api/docs/appendix/geotargeting" target="_blank" rel="noopener noreferrer">Google’s target types</a>
          nullable: true
        geo_id:
          type: string
          description: <em>DataForSEO trends location identifier</em><br>you can use this field for matching obtained results with the <code>location_code</code> parameter specified in the request
          nullable: true
    KeywordsDataDataforseoTrendsLocationsTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/KeywordsDataDataforseoTrendsLocationsResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    KeywordsDataDataforseoTrendsLocationsResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/KeywordsDataDataforseoTrendsLocationsTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    KeywordsDataDataforseoTrendsLocationsCountryResultInfo:
      type: object
      properties:
        location_code:
          type: integer
          description: <em>location code</em>
          nullable: true
        location_name:
          type: string
          description: <em>full name of the location</em>
          nullable: true
        location_code_parent:
          type: integer
          description: '<em>the code of the superordinate location</em><br>example:<br><code>"location_code": 9041134,<br>"location_name": "Vienna International Airport,Lower Austria,Austria",<br>"location_code_parent": 20044</code><br>where <code>location_code_parent</code> corresponds to:<br><code>"location_code": 20044,<br>"location_name": "Lower Austria,Austria"</code>'
          nullable: true
        country_iso_code:
          type: string
          description: <em>ISO country code of the location</em>
          nullable: true
        location_type:
          type: string
          description: <em>location type</em><br>possible values according to <a href="https://developers.google.com/adwords/api/docs/appendix/geotargeting" target="_blank" rel="noopener noreferrer">Google’s target types</a>
          nullable: true
        geo_id:
          type: string
          description: <em>DataForSEO trends location identifier</em><br>you can use this field for matching obtained results with the <code>location_code</code> parameter specified in the request
          nullable: true
    KeywordsDataDataforseoTrendsLocationsCountryTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/KeywordsDataDataforseoTrendsLocationsCountryResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    KeywordsDataDataforseoTrendsLocationsCountryResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/KeywordsDataDataforseoTrendsLocationsCountryTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    KeywordsDataDataforseoTrendsExploreLiveRequestInfo:
      type: object
      properties:
        keywords:
          type: array
          items:
            type: string
          description: '<em>keywords</em><br><strong>required field</strong><br>the maximum number of keywords you can specify: 5<p>learn more about rules and limitations of <code>keyword</code> and <code>keywords</code> fields in DataForSEO APIs in this <a href="https://dataforseo.com/help-center/rules-and-limitations-of-keyword-and-keywords-fields-in-dataforseo-apis" rel="noopener noreferrer" target="_blank">Help Center article</a>'
        location_name:
          type: string
          description: '<em>full name of search engine location</em><br>optional field<br>if you don''t use this field, you will recieve global results<br><strong>if you use this field, you don''t need to specify <code>location_code</code></strong><br>you can receive the list of available locations of the search engine with their <code>location_name</code> by making a separate request to <code>https://api.dataforseo.com/v3/keywords_data/dataforseo_trends/locations</code><br><strong>note that the data will be provided for the country the specified <code>location_name</code> belongs to;</strong><br>example:<br><code class="long-string">United Kingdom</code>'
          nullable: true
        location_code:
          type: integer
          description: '<em>search engine location code</em><br>optional field<br>if you don''t use this field, you will recieve global results<br><strong>if you use this field, you don''t need to specify <code>location_name</code></strong><br>you can receive the list of available locations of the search engines with their <code>location_code</code> by making a separate request to <code>https://api.dataforseo.com/v3/keywords_data/dataforseo_trends/locations</code><br><strong>note that the data will be provided for the country the specified <code>location_code</code> belongs to;</strong><br>example:<br><code class="long-string">2840</code>'
          nullable: true
        type:
          type: string
          description: type of element
          nullable: true
        date_from:
          type: string
          description: '<em>starting date of the time range</em><br>optional field<br>if you don''t specify this field, the current day and month of the preceding year will be used by default<br>minimal value for the <code>web</code> type: <code>2004-01-01</code><br>minimal value for other types: <code>2008-01-01</code><br>date format: <code>"yyyy-mm-dd"</code><br>example:<br><code>"2019-01-15"</code>'
          nullable: true
        date_to:
          type: string
          description: '<em>ending date of the time range</em><br>optional field<br>if you don''t specify this field, the today''s date will be used by default<br>date format: <code>"yyyy-mm-dd"</code><br>example:<br><code>"2019-01-15"</code>'
          nullable: true
        time_range:
          type: string
          description: '<em>preset time ranges</em><br>optional field<br>if you specify <code>date_from</code> or <code>date_to</code> parameters, this field will be ignored when setting a task<br><em>possible values for all <code>type</code> parameters:</em><br><code>past_4_hours</code>, <code>past_day</code>, <code>past_7_days</code>, <code>past_30_days</code>, <code>past_90_days</code>, <code>past_12_months</code>, <code>past_5_years</code>'
          nullable: true
        tag:
          type: string
          description: <em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response
          nullable: true
      example:
        - keywords:
            - iphone 14
            - samsung s23
          location_code: 2840
    DataforseoTrendsGraphDataTrendsGraphDataInfo:
      type: object
      properties:
        date_from:
          type: string
          description: '<em>start date of the corresponding time range</em><br>in the UTC format: "yyyy-mm-dd"'
          nullable: true
        date_to:
          type: string
          description: '<em>end date of the corresponding time range</em><br>in the UTC format: "yyyy-mm-dd"'
          nullable: true
        timestamp:
          type: integer
          description: <em>a point in time in the <a href="https://en.wikipedia.org/wiki/Unix_time">Unix time format</a></em>
          nullable: true
        values:
          type: array
          items:
            type: integer
            nullable: true
          description: '<em>relative keyword popularity rate at a specific timestamp</em><br>represents the keyword popularity rate over the given time range<br><strong>if you specify more than one keyword, the values will be averaged to the highest value across all specified keywords</strong><br>a value of 100 is the peak popularity for the term. A value of 50 means that the term is half as popular. A score of 0 means there was not enough data for this term'
          nullable: true
    DataforseoTrendsDataforseoTrendsGraphElementItem:
      type: object
      allOf:
        - type: object
          oneOf:
            - $ref: '#/components/schemas/BaseKeywordDataDataforseoTrendsItem'
          nullable: true
        - type: object
          properties:
            data:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/DataforseoTrendsGraphDataTrendsGraphDataInfo'
                nullable: true
              description: <em>contains the same parameters that you specified in the POST request<br></em>
              nullable: true
            averages:
              type: array
              items:
                type: integer
                nullable: true
              nullable: true
    KeywordsDataDataforseoTrendsExploreLiveResultInfo:
      type: object
      properties:
        keywords:
          type: array
          items:
            type: string
            nullable: true
          description: <em>keywords in a POST array</em>
          nullable: true
        type:
          type: string
          description: type of element
          nullable: true
        location_code:
          type: integer
          description: '<em>location code in a POST array</em><br>if there is no data, then the value is_<code>null</code>n'
          nullable: true
        language_code:
          type: string
          description: '<em>language code in a POST array</em><br>if there is no data, then the value is_<code>null</code>n'
          nullable: true
        datetime:
          type: string
          description: '<em>date and time when the result was received</em><br>in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”<br>example:<br><code class="long-string">2019-11-15 12:57:46 +00:00</code>'
          nullable: true
        items_count:
          type: integer
          description: <em>the number of results returned in the <strong><code>items</code></strong> array</em>
          format: int64
          nullable: true
        items:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/DataforseoTrendsDataforseoTrendsGraphElementItem'
            nullable: true
          description: <em>contains keyword popularity and related data</em>
          nullable: true
    KeywordsDataDataforseoTrendsExploreLiveTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/KeywordsDataDataforseoTrendsExploreLiveResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    KeywordsDataDataforseoTrendsExploreLiveResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/KeywordsDataDataforseoTrendsExploreLiveTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    KeywordsDataDataforseoTrendsSubregionInterestsLiveRequestInfo:
      type: object
      properties:
        keywords:
          type: array
          items:
            type: string
          description: '<em>keywords</em><br><strong>required field</strong><br>the maximum number of keywords you can specify: 5<br>avoid symbols and special characters (e.g., UTF symbols, emojis);<br>specifying non-Latin characters, you’ll get data for the countries where they are used<p>learn more about rules and limitations of <code>keyword</code> and <code>keywords</code> fields in DataForSEO APIs in this <a href="https://dataforseo.com/help-center/rules-and-limitations-of-keyword-and-keywords-fields-in-dataforseo-apis" rel="noopener noreferrer" target="_blank">Help Center article</a>'
        location_name:
          type: string
          description: '<em>full name of search engine location</em><br>optional field<br>if you don''t use this field, you will recieve global results<br><strong>if you use this field, you don''t need to specify <code>location_code</code></strong><br>you can receive the list of available locations of the search engine with their <code>location_name</code> by making a separate request to <code>https://api.dataforseo.com/v3/keywords_data/dataforseo_trends/locations</code><br><strong>note that the data will be provided for the country the specified <code>location_name</code> belongs to;</strong><br>example:<br><code class="long-string">United Kingdom</code>'
          nullable: true
        location_code:
          type: integer
          description: '<em>search engine location code</em><br>optional field<br>if you don''t use this field, you will recieve global results<br><strong>if you use this field, you don''t need to specify <code>location_name</code></strong><br>you can receive the list of available locations of the search engines with their <code>location_code</code> by making a separate request to <code>https://api.dataforseo.com/v3/keywords_data/dataforseo_trends/locations</code><br><strong>note that the data will be provided for the country the specified <code>location_code</code> belongs to;</strong><br>example:<br><code class="long-string">2840</code>'
          nullable: true
        type:
          type: string
          description: type of element
          nullable: true
        date_from:
          type: string
          description: '<em>starting date of the time range</em><br>optional field<br>if you don''t specify this field, the current day and month of the preceding year will be used by default<br>minimal value for the <code>web</code> type: <code>2004-01-01</code><br>minimal value for other types: <code>2008-01-01</code><br>date format: <code>"yyyy-mm-dd"</code><br>example:<br><code>"2019-01-15"</code>'
          nullable: true
        date_to:
          type: string
          description: '<em>ending date of the time range</em><br>optional field<br>if you don''t specify this field, the today''s date will be used by default<br>date format: <code>"yyyy-mm-dd"</code><br>example:<br><code>"2019-01-15"</code>'
          nullable: true
        time_range:
          type: string
          description: '<em>preset time ranges</em><br>optional field<br>if you specify <code>date_from</code> or <code>date_to</code> parameters, this field will be ignored when setting a task<br><em>possible values for all <code>type</code> parameters:</em><br><code>past_4_hours</code>, <code>past_day</code>, <code>past_7_days</code>, <code>past_30_days</code>, <code>past_90_days</code>, <code>past_12_months</code>, <code>past_5_years</code>'
          nullable: true
        tag:
          type: string
          description: <em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response
          nullable: true
      example:
        - keywords:
            - rugby
            - cricket
          date_from: '2023-01-01'
          date_to: '2024-01-01'
          type: web
          location_name: United States
    DataforseoTrendsinterestsValuesInfo:
      type: object
      properties:
        geo_id:
          type: string
          description: <em>location identifier</em><br>you can use this field for matching obtained results with location parameters specified in the request<br>see the full list of available locations with their <code>geo_id</code> <a href="/v3/keywords_data/dataforseo_trends/locations/" rel="noopener noreferrer" target="_blank">here</a> or by making a separate request to <code>https://api.dataforseo.com/v3/keywords_data/dataforseo_trends/locations</code><br>example:<br><code>US-NY</code>
          nullable: true
        geo_name:
          type: string
          description: <em>location name</em><br>you can use this field for matching obtained results with location parameters specified in the request<br>see the full list of available locations with their <code>geo_name</code> <a href="/v3/keywords_data/dataforseo_trends/locations/" rel="noopener noreferrer" target="_blank">here</a> or by making a separate request to <code>https://api.dataforseo.com/v3/keywords_data/dataforseo_trends/locations</code><br>example:<br><code>Andorra</code>
          nullable: true
        value:
          type: integer
          description: '<em>relative keyword popularity rate in a given location</em><br>represents location-specific keyword popularity rate over the specified time range;<br>using this <code>value</code> you can understand how popular a keyword is in one location compared to another location;<br>calculation: we determine the highest popularity value for the relevant keyword across all locations, and then express all other values as a percentage of that highest value (100);<br>a value of <code>100</code> is the highest popularity for the term<br>a value of <code>50</code> means that the term is half as popular<br>a value of <code>0</code> means there was not enough data for this term'
          nullable: true
    DataforseoTrendsinterestsInfo:
      type: object
      properties:
        keyword:
          type: string
          description: <em>relevant keyword</em><br>the data included in the <code>values</code> element is based on this keyword
          nullable: true
        values:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/DataforseoTrendsinterestsValuesInfo'
            nullable: true
          description: <em>contains data on relative keyword popularity by country or region</em>
          nullable: true
    AbsoluteItems:
      type: object
      properties:
        geo_id:
          type: string
          description: <em>location identifier</em><br>you can use this field for matching obtained results with location parameters specified in the request<br>see the full list of available locations with their <code>geo_id</code> <a href="/v3/keywords_data/dataforseo_trends/locations/" rel="noopener noreferrer" target="_blank">here</a> or by making a separate request to <code>https://api.dataforseo.com/v3/keywords_data/dataforseo_trends/locations</code><br>example:<br><code>US-NY</code>
          nullable: true
        geo_name:
          type: string
          description: <em>location name</em><br>you can use this field for matching obtained results with location parameters specified in the request<br>see the full list of available locations with their <code>geo_name</code> <a href="/v3/keywords_data/dataforseo_trends/locations/" rel="noopener noreferrer" target="_blank">here</a> or by making a separate request to <code>https://api.dataforseo.com/v3/keywords_data/dataforseo_trends/locations</code><br>example:<br><code>Andorra</code>
          nullable: true
        values:
          type: array
          items:
            type: string
            nullable: true
          description: <em>contains data on relative keyword popularity by country or region</em>
          nullable: true
    InterestsComparison:
      type: object
      properties:
        items:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/AbsoluteItems'
            nullable: true
          description: <em>contains keyword popularity and related data</em>
          nullable: true
        absolute_items:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/AbsoluteItems'
            nullable: true
          description: <em>keyword popularity rates across all locations</em><br>values in this array represent percentages relative to the maximum value across all locations
          nullable: true
    DataforseoTrendsSubregionInterestsElementItem:
      type: object
      allOf:
        - type: object
          oneOf:
            - $ref: '#/components/schemas/BaseKeywordDataDataforseoTrendsItem'
          nullable: true
        - type: object
          properties:
            interests:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/DataforseoTrendsinterestsInfo'
                nullable: true
              description: <em>subregional keyword popuarity data for each specified term</em>
              nullable: true
            interests_comparison:
              type: object
              oneOf:
                - $ref: '#/components/schemas/InterestsComparison'
              description: '<em>comparison of data on subregional keyword popularity for the specified parameters</em><br>if you specified a single keyword, the value will be <code>null</code>'
              nullable: true
    KeywordsDataDataforseoTrendsSubregionInterestsLiveResultInfo:
      type: object
      properties:
        keywords:
          type: array
          items:
            type: string
            nullable: true
          description: <em>keywords in a POST array</em>
          nullable: true
        type:
          type: string
          description: type of element
          nullable: true
        location_code:
          type: integer
          description: '<em>location code in a POST array</em><br>if there is no data, then the value is_<code>null</code>n'
          nullable: true
        language_code:
          type: string
          description: '<em>language code in a POST array</em><br>if there is no data, then the value is_<code>null</code>n'
          nullable: true
        datetime:
          type: string
          description: '<em>date and time when the result was received</em><br>in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”<br>example:<br><code class="long-string">2019-11-15 12:57:46 +00:00</code>'
          nullable: true
        items_count:
          type: integer
          description: <em>the number of results returned in the <strong><code>items</code></strong> array</em>
          format: int64
          nullable: true
        items:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/DataforseoTrendsSubregionInterestsElementItem'
            nullable: true
          description: <em>contains keyword popularity and related data</em>
          nullable: true
    KeywordsDataDataforseoTrendsSubregionInterestsLiveTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/KeywordsDataDataforseoTrendsSubregionInterestsLiveResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    KeywordsDataDataforseoTrendsSubregionInterestsLiveResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/KeywordsDataDataforseoTrendsSubregionInterestsLiveTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    KeywordsDataDataforseoTrendsDemographyLiveRequestInfo:
      type: object
      properties:
        keywords:
          type: array
          items:
            type: string
          description: '<em>keywords</em><br><strong>required field</strong><br>the maximum number of keywords you can specify: 5<br>avoid symbols and special characters (e.g., UTF symbols, emojis);<br>specifying non-Latin characters, you’ll get data for the countries where they are used<p>learn more about rules and limitations of <code>keyword</code> and <code>keywords</code> fields in DataForSEO APIs in this <a href="https://dataforseo.com/help-center/rules-and-limitations-of-keyword-and-keywords-fields-in-dataforseo-apis" rel="noopener noreferrer" target="_blank">Help Center article</a>'
        location_name:
          type: string
          description: '<em>full name of search engine location</em><br>optional field<br>if you don''t use this field, you will recieve global results<br><strong>if you use this field, you don''t need to specify <code>location_code</code></strong><br>you can receive the list of available locations of the search engine with their <code>location_name</code> by making a separate request to <code>https://api.dataforseo.com/v3/keywords_data/dataforseo_trends/locations</code><br><strong>note that the data will be provided for the country the specified <code>location_name</code> belongs to;</strong><br>example:<br><code class="long-string">United Kingdom</code>'
          nullable: true
        location_code:
          type: integer
          description: '<em>search engine location code</em><br>optional field<br>if you don''t use this field, you will recieve global results<br><strong>if you use this field, you don''t need to specify <code>location_name</code></strong><br>you can receive the list of available locations of the search engines with their <code>location_code</code> by making a separate request to <code>https://api.dataforseo.com/v3/keywords_data/dataforseo_trends/locations</code><br><strong>note that the data will be provided for the country the specified <code>location_code</code> belongs to;</strong><br>example:<br><code class="long-string">2840</code>'
          nullable: true
        type:
          type: string
          description: type of element
          nullable: true
        date_from:
          type: string
          description: '<em>starting date of the time range</em><br>optional field<br>if you don''t specify this field, the current day and month of the preceding year will be used by default<br>minimal value for the <code>web</code> type: <code>2004-01-01</code><br>minimal value for other types: <code>2008-01-01</code><br>date format: <code>"yyyy-mm-dd"</code><br>example:<br><code>"2019-01-15"</code>'
          nullable: true
        date_to:
          type: string
          description: '<em>ending date of the time range</em><br>optional field<br>if you don''t specify this field, the today''s date will be used by default<br>date format: <code>"yyyy-mm-dd"</code><br>example:<br><code>"2019-01-15"</code>'
          nullable: true
        time_range:
          type: string
          description: '<em>preset time ranges</em><br>optional field<br>if you specify <code>date_from</code> or <code>date_to</code> parameters, this field will be ignored when setting a task<br><em>possible values for all <code>type</code> parameters:</em><br><code>past_4_hours</code>, <code>past_day</code>, <code>past_7_days</code>, <code>past_30_days</code>, <code>past_90_days</code>, <code>past_12_months</code>, <code>past_5_years</code>'
          nullable: true
        tag:
          type: string
          description: <em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response
          nullable: true
      example:
        - keywords:
            - rugby
            - cricket
          date_from: '2023-01-01'
          date_to: '2024-01-01'
          type: web
          location_name: United States
    DemographyItemValueInfo:
      type: object
      properties:
        type:
          type: string
          description: type of element
          nullable: true
        value:
          type: integer
          description: '<em>keyword popularity rate within the specified age range</em><br>using this <code>value</code> you can understand how popular a keyword is within each age range; <br>calculation: we determine the highest popularity value for the relevant keyword across all age groups, and then express all other values as a percentage of that highest value (100);<br>a value of <code>100</code> is the highest popularity for the term<br>a value of <code>0</code> means there was not enough data for this term'
          nullable: true
    DataforseoTrendsDataInfo:
      type: object
      properties:
        keyword:
          type: string
          description: <em>relevant keyword for which demographic data is provided</em>
          nullable: true
        values:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/DemographyItemValueInfo'
            nullable: true
          description: <em>contains age range and corresponding keyword popularity values</em>
          nullable: true
    Demography:
      type: object
      properties:
        age:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/DataforseoTrendsDataInfo'
            nullable: true
          description: <em>distribution of keyword popularity by age</em>
          nullable: true
        gender:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/DataforseoTrendsDataInfo'
            nullable: true
          description: <em>distribution of keyword popularity by gender</em>
          nullable: true
    DataforseoTrendsDemographyElementItem:
      type: object
      allOf:
        - type: object
          oneOf:
            - $ref: '#/components/schemas/BaseKeywordDataDataforseoTrendsItem'
          nullable: true
        - type: object
          properties:
            demography:
              type: object
              oneOf:
                - $ref: '#/components/schemas/Demography'
              description: <em>demographic breakdown of keyword popularity data per each specified term</em><br>conains keyword popularity data by age and gender
              nullable: true
            demography_comparison:
              type: object
              oneOf:
                - $ref: '#/components/schemas/DemographyComparisonInfo'
              description: '<em>comparison of demographic data on keyword popularity for the specified parameters</em><br>conains keyword popularity data by age and gender<br>if you specified a single keyword, the value will be <code>null</code>'
              nullable: true
    KeywordsDataDataforseoTrendsDemographyLiveResultInfo:
      type: object
      properties:
        keywords:
          type: array
          items:
            type: string
            nullable: true
          description: <em>keywords in a POST array</em>
          nullable: true
        type:
          type: string
          description: type of element
          nullable: true
        location_code:
          type: integer
          description: '<em>location code in a POST array</em><br>if there is no data, then the value is_<code>null</code>n'
          nullable: true
        language_code:
          type: string
          description: '<em>language code in a POST array</em><br>if there is no data, then the value is_<code>null</code>n'
          nullable: true
        datetime:
          type: string
          description: '<em>date and time when the result was received</em><br>in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”<br>example:<br><code class="long-string">2019-11-15 12:57:46 +00:00</code>'
          nullable: true
        items_count:
          type: integer
          description: <em>the number of results returned in the <strong><code>items</code></strong> array</em>
          format: int64
          nullable: true
        items:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/DataforseoTrendsDemographyElementItem'
            nullable: true
          description: <em>contains keyword popularity and related data</em>
          nullable: true
    KeywordsDataDataforseoTrendsDemographyLiveTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/KeywordsDataDataforseoTrendsDemographyLiveResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    KeywordsDataDataforseoTrendsDemographyLiveResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/KeywordsDataDataforseoTrendsDemographyLiveTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    KeywordsDataDataforseoTrendsMergedDataLiveRequestInfo:
      type: object
      properties:
        keywords:
          type: array
          items:
            type: string
          description: '<em>keywords</em><br><strong>required field</strong><br>the maximum number of keywords you can specify: 5<br>avoid symbols and special characters (e.g., UTF symbols, emojis);<br>specifying non-Latin characters, you’ll get data for the countries where they are used<p>learn more about rules and limitations of <code>keyword</code> and <code>keywords</code> fields in DataForSEO APIs in this <a href="https://dataforseo.com/help-center/rules-and-limitations-of-keyword-and-keywords-fields-in-dataforseo-apis" rel="noopener noreferrer" target="_blank">Help Center article</a>'
        location_name:
          type: string
          description: '<em>full name of search engine location</em><br>optional field<br>if you don''t use this field, you will recieve global results<br><strong>if you use this field, you don''t need to specify <code>location_code</code></strong><br>you can receive the list of available locations of the search engine with their <code>location_name</code> by making a separate request to <code>https://api.dataforseo.com/v3/keywords_data/dataforseo_trends/locations</code><br><strong>note that the data will be provided for the country the specified <code>location_name</code> belongs to;</strong><br>example:<br><code class="long-string">United Kingdom</code>'
          nullable: true
        location_code:
          type: integer
          description: '<em>search engine location code</em><br>optional field<br>if you don''t use this field, you will recieve global results<br><strong>if you use this field, you don''t need to specify <code>location_name</code></strong><br>you can receive the list of available locations of the search engines with their <code>location_code</code> by making a separate request to <code>https://api.dataforseo.com/v3/keywords_data/dataforseo_trends/locations</code><br><strong>note that the data will be provided for the country the specified <code>location_code</code> belongs to;</strong><br>example:<br><code class="long-string">2840</code>'
          nullable: true
        type:
          type: string
          description: type of element
          nullable: true
        date_from:
          type: string
          description: '<em>starting date of the time range</em><br>optional field<br>if you don''t specify this field, the current day and month of the preceding year will be used by default<br>minimal value for the <code>web</code> type: <code>2004-01-01</code><br>minimal value for other types: <code>2008-01-01</code><br>date format: <code>"yyyy-mm-dd"</code><br>example:<br><code>"2019-01-15"</code>'
          nullable: true
        date_to:
          type: string
          description: '<em>ending date of the time range</em><br>optional field<br>if you don''t specify this field, the today''s date will be used by default<br>date format: <code>"yyyy-mm-dd"</code><br>example:<br><code>"2019-01-15"</code>'
          nullable: true
        time_range:
          type: string
          description: '<em>preset time ranges</em><br>optional field<br>if you specify <code>date_from</code> or <code>date_to</code> parameters, this field will be ignored when setting a task<br><em>possible values for all <code>type</code> parameters:</em><br><code>past_4_hours</code>, <code>past_day</code>, <code>past_7_days</code>, <code>past_30_days</code>, <code>past_90_days</code>, <code>past_12_months</code>, <code>past_5_years</code>'
          nullable: true
        tag:
          type: string
          description: <em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response
          nullable: true
      example:
        - keywords:
            - rugby
            - cricket
          date_from: '2023-01-01'
          date_to: '2024-01-01'
          type: web
          location_name: United States
    KeywordsDataDataforseoTrendsMergedDataLiveResultInfo:
      type: object
      properties:
        keywords:
          type: array
          items:
            type: string
            nullable: true
          description: <em>keywords in a POST array</em>
          nullable: true
        type:
          type: string
          description: type of element
          nullable: true
        location_code:
          type: integer
          description: '<em>location code in a POST array</em><br>if there is no data, then the value is_<code>null</code>n'
          nullable: true
        language_code:
          type: string
          description: '<em>language code in a POST array</em><br>if there is no data, then the value is_<code>null</code>n'
          nullable: true
        datetime:
          type: string
          description: '<em>date and time when the result was received</em><br>in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”<br>example:<br><code class="long-string">2019-11-15 12:57:46 +00:00</code>'
          nullable: true
        items_count:
          type: integer
          description: <em>the number of results returned in the <strong><code>items</code></strong> array</em>
          format: int64
          nullable: true
        items:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/BaseKeywordDataDataforseoTrendsItem'
            nullable: true
          description: <em>contains keyword popularity and related data</em>
          nullable: true
    KeywordsDataDataforseoTrendsMergedDataLiveTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/KeywordsDataDataforseoTrendsMergedDataLiveResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    KeywordsDataDataforseoTrendsMergedDataLiveResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/KeywordsDataDataforseoTrendsMergedDataLiveTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    KeywordsDataBingLocationsResultInfo:
      type: object
      properties:
        location_code:
          type: integer
          description: <em>location code</em>
          nullable: true
        location_name:
          type: string
          description: <em>full name of the location</em>
          nullable: true
        location_code_parent:
          type: integer
          description: '<em>the code of the superordinate location</em><br>example:<br><code>"location_code": 9041134,<br>"location_name": "Vienna International Airport,Lower Austria,Austria",<br>"location_code_parent": 20044</code>where <code>location_code_parent</code> corresponds to:<p><code>"location_code": 20044,<br>"location_name": "Lower Austria,Austria"</code>'
          nullable: true
        country_iso_code:
          type: string
          description: <em>ISO country code of the location</em>
          nullable: true
        location_type:
          type: string
          description: <em>location type</em>
          nullable: true
    KeywordsDataBingLocationsTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/KeywordsDataBingLocationsResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    KeywordsDataBingLocationsResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/KeywordsDataBingLocationsTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    KeywordsDataBingLanguagesResultInfo:
      type: object
      properties:
        language_name:
          type: string
          description: <em>language name</em>
          nullable: true
        language_code:
          type: string
          description: <em>language code according to <a href="https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes" target="_blank" rel="noopener noreferrer">ISO 639-1</a></em>
          nullable: true
    KeywordsDataBingLanguagesTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/KeywordsDataBingLanguagesResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    KeywordsDataBingLanguagesResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/KeywordsDataBingLanguagesTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    KeywordsDataBingSearchVolumeTaskPostRequestInfo:
      type: object
      properties:
        keywords:
          type: array
          items:
            type: string
          description: '<em>keywords</em><br><strong>required field</strong><br>The maximum number of keywords you can specify: 1000<br>The maximum number of characters for each keyword: 100<br>the specified keywords will be converted to lowercase, data will be provided in a separate array<p>learn more about rules and limitations of <code>keyword</code> and <code>keywords</code> fields in DataForSEO APIs in this <a href="https://dataforseo.com/help-center/rules-and-limitations-of-keyword-and-keywords-fields-in-dataforseo-apis" rel="noopener noreferrer" target="_blank">Help Center article</a>'
        location_name:
          type: string
          description: '<em>full name of search engine location</em><br><strong>required field if you don''t specify</strong> <code>location_code</code> or <code>location_coordinate</code><br><strong>if you use this field, you don''t need to specify <code>location_code</code> or <code>location_coordinate</code></strong><br>you can receive the list of available locations of the search engine with their <code>location_name</code> by making a separate request to <code>https://api.dataforseo.com/v3/keywords_data/bing/locations</code><br>example:<br><code class="long-string">London,England,United Kingdom</code>'
        location_code:
          type: integer
          description: '<em>search engine location code</em><br><strong>required field if you don''t specify</strong> <code>location_name</code> or <code>location_coordinate</code><br><strong>if you use this field, you don''t need to specify <code>location_name</code> or <code>location_coordinate</code></strong><br>you can receive the list of available locations of the search engines with their <code>location_code</code> by making a separate request to <code>https://api.dataforseo.com/v3/keywords_data/bing/locations</code><br>example:<br><code class="long-string">2840</code>'
        location_coordinate:
          type: string
          description: '<em>GPS coordinates of a location</em><br><strong>required field if you don''t specify</strong> <code>location_name</code> or <code>location_code</code><br><strong>if you use this field, you don''t need to specify <code>location_name</code> or <code>location_code</code></strong><br><code>location_coordinate</code> parameter should be specified in the <em>"latitude,longitude"</em> format<br><strong>the data will be provided for the country the specified coordinates belong to</strong><br>example:<br><code class="long-string">52.6178549,-155.352142</code>'
        language_name:
          type: string
          description: '<em>full name of search engine language</em><br><strong>required field if you don''t specify</strong> <code>language_code</code><br>if you use this field, you don''t need to specify <code>language_code</code><br>supported languages:<br><code>English</code>, <code>French</code>, <code>German</code>'
        language_code:
          type: string
          description: '<em>search engine language code</em><br><strong>required field if you don''t specify</strong> <code>language_name</code><br>if you use this field, you don''t need to specify <code>language_name</code><br>supported languages:<br><code class="long-string">en</code>, <code>fr</code>, <code>de</code>'
        device:
          type: string
          description: '<em>device type</em><br>optional field<br>specify this field if you want to get the data for a particular device typepossible values: <code>all</code>, <code>mobile</code>, <code>desktop</code>, <code>tablet</code><br>default value: <code>all</code>'
          nullable: true
        sort_by:
          type: string
          description: '<em>results sorting parameters</em><br>optional field<br>Use these parameters to sort the results by <code>search_volume</code>, <code>cpc</code>, <code>competition</code> or <code>relevance</code> in the descending order<br>default value: <code>relevance</code>'
          nullable: true
        date_from:
          type: string
          description: '<em>starting date of the time range</em><br>optional field<br>if you don''t specify this field, data will be provided for the last 12 months<br>minimal value: 24 months from today''s date<br>if <a href="/v3/keywords_data/bing/status/" target="_blank" rel="noopener noreferrer">Status endpoint</a> returns <code>false</code> in the <code>actual_data</code> field, <code>date_from</code> can be set to the month before last and prior;<br>if <a href="/v3/keywords_data/bing/status/" target="_blank" rel="noopener noreferrer">Status endpoint</a> returns <code>true</code> in the <code>actual_data</code> field, <code>date_from</code> can be set to the last month and prior;<br>date format: <code>"yyyy-mm-dd"</code><br>example:<br><code>"2020-01-01"</code><p><strong>Note:</strong> we do not recommend using a custom time range for the past year''s dates'
          nullable: true
        date_to:
          type: string
          description: '<em>ending date of the time range</em><br>optional field<br>if you don''t specify this field, data will be provided for the last 12 months;<br>minimum value: two years back from today’s date;<br>maximum value: one month from today''s date;<br><strong>note:</strong> we do not recommend using a custom time range for the past year''s dates;<br>date format: <code>"yyyy-mm-dd"</code><br>example:<br><code>"2020-03-15"</code><p><strong>Note:</strong> we do not recommend using a custom time range for the past year''s dates'
          nullable: true
        postback_url:
          type: string
          description: '<em>URL for sending task results</em><br>optional field<br>once the task is completed, we will send a POST request with its results compressed in the <code>gzip</code> format to the <code>postback_url</code> you specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/postbackscript?id=$id</code><br><code>http://your-server.com/postbackscript?id=$id&amp;tag=$tag</code><br><strong>Note:</strong> special characters in <code>postback_url</code> will be urlencoded;<br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href="https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api" target="_blank" rel="noopener noreferrer">Help Center</a>'
          nullable: true
        pingback_url:
          type: string
          description: '<em>notification URL of a completed task</em><br>optional field<br>when a task is completed we will notify you by GET request sent to the URL you have specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request<br>example:<br><code>http://your-server.com/pingscript?id=$id</code><br><code>http://your-server.com/pingscript?id=$id&amp;tag=$tag</code><br><strong>Note:</strong> special characters in <code>pingback_url</code> will be urlencoded;<br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href="https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api" target="_blank" rel="noopener noreferrer">Help Center</a>'
          nullable: true
        search_partners:
          type: boolean
          description: '<em>Bing search partners type</em><br>optional field<br>if you specify <code class="prettyprint">true</code>, the results will be delivered for owned, operated, and syndicated networks across Bing, Yahoo, AOL and partner sites that host Bing, AOL, and Yahoo search.<br>default value: <code>false</code> - results are returned for Bing, AOL, and Yahoo search networks'
          nullable: true
        tag:
          type: string
          description: <em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response
          nullable: true
      example:
        - location_name: United States
          language_name: English
          keywords:
            - average page rpm adsense
            - adsense blank ads how long
            - leads and prospects
    KeywordsDataBingSearchVolumeTaskPostTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: object
              description: '<em>array of results</em><br>in this case, the value will be <code>null</code>'
              nullable: true
    KeywordsDataBingSearchVolumeTaskPostResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/KeywordsDataBingSearchVolumeTaskPostTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    KeywordsDataBingSearchVolumeTasksReadyResultInfo:
      type: object
      properties:
        id:
          type: string
          description: <em>task identifier of the completed task</em><br><strong>unique task identifier in our system in the <a href="https://en.wikipedia.org/wiki/Universally_unique_identifier">UUID</a> format</strong>
          nullable: true
        se:
          type: string
          description: <em>search engine specified when setting the task</em>
          nullable: true
        se_type:
          type: string
          nullable: true
        date_posted:
          type: string
          description: <em>date when the task was posted (in the UTC format)</em>
          nullable: true
        tag:
          type: string
          nullable: true
        endpoint:
          type: string
          description: <em>URL for collecting the results of the task</em>
          nullable: true
        function:
          type: string
          nullable: true
    KeywordsDataBingSearchVolumeTasksReadyTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/KeywordsDataBingSearchVolumeTasksReadyResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    KeywordsDataBingSearchVolumeTasksReadyResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/KeywordsDataBingSearchVolumeTasksReadyTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    KeywordsDataBingSearchVolumeTaskGetResultInfo:
      type: object
      properties:
        keyword:
          type: string
          description: <em>keyword in a POST array</em>
          nullable: true
        location_code:
          type: integer
          description: <em>location code in a POST array</em>
          nullable: true
        language_code:
          type: string
          description: <em>language code in a POST array</em>
          nullable: true
        search_partners:
          type: boolean
          description: <em>indicates whether data from partner networks included in the response</em>
          nullable: true
        device:
          type: string
          description: '<em>device type in a POST array</em><br>if there is no data, then the value is_<code>null</code>n'
          nullable: true
        competition:
          type: number
          description: '<em>competition</em><br>represents the relative amount of competition associated with the given keyword in paid SERP only. This value is based on Bing Ads data.<br>Possible values: <code>0.1</code>, <code>0.5</code>,<code>0.9</code> <p><code>0.1</code> - low competition,<br><code>0.5</code> - medium competition, <br><code>0.9</code> - high competition;<br>if there is no data the value is <code>null</code>'
          nullable: true
        cpc:
          type: number
          description: <em>cost-per-click</em><br>represents the average cost per click (USD) historically paid for the keyword.<br>if there is no data then the value is_<code>null</code>n
          nullable: true
        search_volume:
          type: integer
          description: <em>monthly average search volume rate</em><br>search volume is rounded to the nearest tens
          format: int64
          nullable: true
        categories:
          type: array
          items:
            type: string
            nullable: true
          description: '<em>product and service categories</em><br>our API doesn''t return categories for this endpoint: the parameter will always equal <code>null</code>'
          nullable: true
        monthly_searches:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/MonthlySearchesInfo'
            nullable: true
          description: '<em>monthly searches</em><br>represents the (approximate) number of searches on this keyword idea (as available for the past twelve months), targeted to the specified geographic locations<br>if there is no data then the value is_<code>null</code>n'
          nullable: true
    KeywordsDataBingSearchVolumeTaskGetTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/KeywordsDataBingSearchVolumeTaskGetResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    KeywordsDataBingSearchVolumeTaskGetResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/KeywordsDataBingSearchVolumeTaskGetTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    KeywordsDataBingSearchVolumeLiveRequestInfo:
      type: object
      properties:
        keywords:
          type: array
          items:
            type: string
          description: '<em>keywords</em><br><strong>required field</strong><br>The maximum number of keywords you can specify: 1000<br>The maximum number of characters for each keyword: 100<br>the specified keywords will be converted to lowercase, data will be provided in a separate arraylearn more about rules and limitations of <code>keyword</code> and <code>keywords</code> fields in DataForSEO APIs in this <a href="https://dataforseo.com/help-center/rules-and-limitations-of-keyword-and-keywords-fields-in-dataforseo-apis" target="_blank" rel="noopener noreferrer">Help Center article</a>'
        location_name:
          type: string
          description: '<em>full name of search engine location</em><br><strong>required field if you don''t specify</strong> <code>location_code</code> or <code>location_coordinate</code><br><strong>if you use this field, you don''t need to specify <code>location_code</code> or <code>location_coordinate</code></strong><br>you can receive the list of available locations of the search engine with their <code>location_name</code> by making a separate request to <code>https://api.dataforseo.com/v3/keywords_data/bing/locations</code><br>example:<br><code class="long-string">London,England,United Kingdom</code>'
        location_code:
          type: integer
          description: '<em>search engine location code</em><br><strong>required field if you don''t specify</strong> <code>location_name</code> or <code>location_coordinate</code><br><strong>if you use this field, you don''t need to specify <code>location_name</code> or <code>location_coordinate</code></strong><br>you can receive the list of available locations of the search engines with their <code>location_code</code> by making a separate request to <code>https://api.dataforseo.com/v3/keywords_data/bing/locations</code><br>example:<br><code class="long-string">2840</code>'
        location_coordinate:
          type: string
          description: '<em>GPS coordinates of a location</em><br><strong>required field if you don''t specify</strong> <code>location_name</code> or <code>location_code</code><br><strong>if you use this field, you don''t need to specify <code>location_name</code> or <code>location_code</code></strong><br><code>location_coordinate</code> parameter should be specified in the <em>"latitude,longitude"</em> format<br><strong>the data will be provided for the country the specified coordinates belong to</strong><br>example:<br><code class="long-string">52.6178549,-155.352142</code>'
        language_name:
          type: string
          description: '<em>full name of search engine language</em><br><strong>required field if you don''t specify</strong> <code>language_code</code><br>if you use this field, you don''t need to specify <code>language_code</code><br>supported languages:<br><code>English</code>, <code>French</code>, <code>German</code>'
        language_code:
          type: string
          description: '<em>search engine language code</em><br><strong>required field if you don''t specify</strong> <code>language_name</code><br>if you use this field, you don''t need to specify <code>language_name</code><br>supported languages:<br><code class="long-string">en</code>, <code>fr</code>, <code>de</code>'
        device:
          type: string
          description: '<em>device type</em><br>optional field<br>specify this field if you want to get the data for a particular device type;<br>possible values: <code>all</code>, <code>mobile</code>, <code>desktop</code>, <code>tablet</code><br>default value: <code>all</code>'
          nullable: true
        sort_by:
          type: string
          description: '<em>results sorting parameters</em><br>optional field<br>Use these parameters to sort the results by <code>search_volume</code>, <code>cpc</code>, <code>competition</code> or <code>relevance</code> in the descending order<br>default value: <code>relevance</code>'
          nullable: true
        date_from:
          type: string
          description: '<em>starting date of the time range</em><br>optional field<br>minimal value: 24 months from today''s date;<br>if you don''t specify this field, data will be provided for the last 12 months;<br>minimum value: two years back from today’s date;<br>if <a href="/v3/keywords_data/bing/status/" target="_blank" rel="noopener noreferrer">Status endpoint</a> returns <code>false</code> in the <code>actual_data</code> field, <code>date_from</code> can be set to the month before last and prior;<br>if <a href="/v3/keywords_data/bing/status/" target="_blank" rel="noopener noreferrer">Status endpoint</a> returns <code>true</code> in the <code>actual_data</code> field, <code>date_from</code> can be set to the last month and prior;<br>date format: <code>"yyyy-mm-dd"</code><br>example:<br><code>"2020-01-01"</code><strong>Note:</strong> we do not recommend using a custom time range for the past year''s dates'
          nullable: true
        date_to:
          type: string
          description: '<em>ending date of the time range</em><br>optional field<br>if you don''t specify this field, data will be provided for the last 12 months;<br>minimum value: two years back from today’s date;<br>maximum value: one month from today''s date;<br><strong>note:</strong> we do not recommend using a custom time range for the past year''s dates;<br>date format: <code>"yyyy-mm-dd"</code><br>example:<br><code>"2020-03-15"</code><strong>Note:</strong> we do not recommend using a custom time range for the past year''s dates'
          nullable: true
        search_partners:
          type: boolean
          description: '<em>Bing search partners type</em><br>optional field<br>if you specify <code class="prettyprint">true</code>, the results will be delivered for owned, operated, and syndicated networks across Bing, Yahoo, AOL and partner sites that host Bing, AOL, and Yahoo search.<br>default value: <code>false</code> - results are returned for Bing, AOL, and Yahoo search networks'
          nullable: true
        tag:
          type: string
          description: <em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response
          nullable: true
      example:
        - location_name: United States
          language_code: en
          keywords:
            - tom and jerry
            - silicon valley
            - spider man
    KeywordsDataBingSearchVolumeLiveResultInfo:
      type: object
      properties:
        keyword:
          type: string
          description: <em>keyword in a POST array</em>
          nullable: true
        location_code:
          type: integer
          description: '<em>location code in a POST array</em><br>if there is no data, then the value is_<code>null</code>n'
          nullable: true
        language_code:
          type: string
          description: '<em>language code in a POST array</em><br>if there is no data, then the value is_<code>null</code>n'
          nullable: true
        search_partners:
          type: boolean
          description: <em>indicates whether data from partner networks included in the response</em>
          nullable: true
        device:
          type: string
          description: '<em>device type in a POST array</em><br>if there is no data, then the value is_<code>null</code>n'
          nullable: true
        competition:
          type: number
          description: '<em>competition</em><br>represents the relative amount of competition associated with the given keyword in paid SERP only. This value is based on Bing Ads data.<br>Possible values: <code>0.1</code>, <code>0.5</code>,<code>0.9</code><code>0.1</code> - low competition,<br><code>0.5</code> - medium competition,<br><code>0.9</code> - high competition;<br>if there is no data the value is <code>null</code>'
          nullable: true
        cpc:
          type: number
          description: <em>cost-per-click</em><br>represents the average cost per click (USD) historically paid for the keyword.<br>if there is no data then the value is_<code>null</code>n
          nullable: true
        search_volume:
          type: integer
          description: '<em>monthly average search volume rate<br></em>represents either the (approximate) number of searches for the given keyword idea on bing search engine depending on the user’s targeting;<br>search volume is rounded to the nearest tens;<br>if there is no data, the value is_<code>null</code>n'
          format: int64
          nullable: true
        categories:
          type: array
          items:
            type: string
            nullable: true
          description: '<em>product and service categories</em><br>our API doesn''t return categories for this endpoint: the parameter will always equal <code>null</code>'
          nullable: true
        monthly_searches:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/MonthlySearchesInfo'
            nullable: true
          description: '<em>monthly searches</em><br>represents the (approximate) number of searches on this keyword idea (as available for the past twelve months), targeted to the specified geographic locations<br>if there is no data then the value is_<code>null</code>n'
          nullable: true
    KeywordsDataBingSearchVolumeLiveTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/KeywordsDataBingSearchVolumeLiveResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    KeywordsDataBingSearchVolumeLiveResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/KeywordsDataBingSearchVolumeLiveTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    KeywordsDataBingAudienceEstimationJobFunctionsResultInfo:
      type: object
      properties:
        job_function_id:
          type: integer
          description: <em>ID of the job function</em>
          format: int64
          nullable: true
        job_function_name:
          type: string
          description: <em>name of the job function</em>
          nullable: true
    KeywordsDataBingAudienceEstimationJobFunctionsTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/KeywordsDataBingAudienceEstimationJobFunctionsResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    KeywordsDataBingAudienceEstimationJobFunctionsResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/KeywordsDataBingAudienceEstimationJobFunctionsTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    KeywordsDataBingAudienceEstimationIndustriesResultInfo:
      type: object
      properties:
        industry_id:
          type: integer
          description: <em>ID of the industry</em>
          format: int64
          nullable: true
        industry_name:
          type: string
          description: <em>name of the industry</em>
          nullable: true
    KeywordsDataBingAudienceEstimationIndustriesTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/KeywordsDataBingAudienceEstimationIndustriesResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    KeywordsDataBingAudienceEstimationIndustriesResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/KeywordsDataBingAudienceEstimationIndustriesTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    KeywordsDataBingAudienceEstimationTaskPostRequestInfo:
      type: object
      properties:
        location_name:
          type: string
          description: '<em>full name of search engine location</em><br><strong>required field if you don''t specify</strong> <code>location_code</code> or <code>location_coordinate</code><br><strong>if you use this field, you don''t need to specify <code>location_code</code> or <code>location_coordinate</code></strong><br>you can receive the list of available locations of the search engine with their <code>location_name</code> by making a separate request to <code>https://api.dataforseo.com/v3/keywords_data/bing/locations</code><br>example:<br><code class="long-string">London,England,United Kingdom</code>'
        location_code:
          type: integer
          description: '<em>search engine location code</em><br><strong>required field if you don''t specify</strong> <code>location_name</code> or <code>location_coordinate</code><br><strong>if you use this field, you don''t need to specify <code>location_name</code> or <code>location_coordinate</code></strong><br>you can receive the list of available locations of the search engines with their <code>location_code</code> by making a separate request to <code>https://api.dataforseo.com/v3/keywords_data/bing/locations</code><br>example:<br><code class="long-string">2840</code>'
        location_coordinate:
          type: string
          description: '<em>GPS coordinates of a location</em><br><strong>required field if you don''t specify</strong> <code>location_name</code> or <code>location_code</code><br><strong>if you use this field, you don''t need to specify <code>location_name</code> or <code>location_code</code></strong><br><code>location_coordinate</code> parameter should be specified in the <em>"latitude,longitude,radius (in km)"</em> format<br><strong>the data will be provided for the country the specified coordinates belong to</strong><br>example:<br><code class="long-string">29.6821525,-82.4098881,100</code>'
        age:
          type: array
          items:
            type: string
          description: '<em>selection of age ranges for targeting</em><br>possible values: <code>eighteen_to_twenty_four</code>, <code>fifty_to_sixty_four</code>, <code>sixty_five_and_above</code>, <code>thirteen_to_seventeen</code>, <code>thirty_five_to_forty_nine</code>, <code>twenty_five_to_thirty_four</code>, <code>unknown</code>, <code>zero_to_twelve</code>'
          nullable: true
        bid:
          type: number
          description: '<em>desired bid setting value in USD</em><br>maximum value: 1000'
          nullable: true
        daily_budget:
          type: number
          description: '<em>daily campaign budget value in USD</em><br>maximum value: 10000'
          nullable: true
        gender:
          type: array
          items:
            type: string
          description: '<em>gender to target</em><br>possible values: <code>male</code>, <code>female</code>, <code>unknown</code>'
          nullable: true
        industry:
          type: array
          items:
            type: string
          description: '<em>industry of LinkedIn profile targeting</em><p>if you use this field, you can receive the list of available industry names  with industry_id by making a separate request to the https://api.dataforseo.com/v3/keywords_data/bing/audience_estimation/industries<p>example: <code>806301758</code>'
          nullable: true
        job_function:
          type: array
          items:
            type: string
          description: '<em>job function of LinkedIn profile targeting</em><p>if you use this field, you can receive the list of available job function names  with job_function_id by making a separate request to the https://api.dataforseo.com/v3/keywords_data/bing/audience_estimation/job_functions<p>example: <code>806300451</code>'
          nullable: true
      example:
        - location_coordinate: '29.6821525,-82.4098881,100'
          age:
            - twenty_five_to_thirty_four
            - eighteen_to_twenty_four
            - unknown
          bid: 1
          daily_budget: 24
          gender:
            - male
          industry:
            - '806303407'
            - '806301758'
          job_function:
            - '806298607'
    KeywordsDataBingAudienceEstimationTaskPostTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: object
              description: '<em>array of results</em><br>in this case, the value will be <code>null</code>'
              nullable: true
    KeywordsDataBingAudienceEstimationTaskPostResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/KeywordsDataBingAudienceEstimationTaskPostTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    KeywordsDataBingAudienceEstimationTasksReadyResultInfo:
      type: object
      properties:
        id:
          type: string
          description: <em>task identifier of the completed task</em><br><strong>unique task identifier in our system in the <a href="https://en.wikipedia.org/wiki/Universally_unique_identifier">UUID</a> format</strong>
          nullable: true
        se:
          type: string
          description: <em>search engine specified when setting the task</em>
          nullable: true
        se_type:
          type: string
          nullable: true
        date_posted:
          type: string
          description: <em>date when the task was posted (in the UTC format)</em>
          nullable: true
        tag:
          type: string
          nullable: true
        endpoint:
          type: string
          description: <em>URL for collecting the results of the task</em>
          nullable: true
    KeywordsDataBingAudienceEstimationTasksReadyTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/KeywordsDataBingAudienceEstimationTasksReadyResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    KeywordsDataBingAudienceEstimationTasksReadyResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/KeywordsDataBingAudienceEstimationTasksReadyTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    AudienceEstimationInfo:
      type: object
      properties:
        high:
          type: number
          description: <em>indicates the upper bound of the range result</em>
          format: double
          nullable: true
        low:
          type: number
          description: <em>indicates the lower bound of the range result</em>
          format: double
          nullable: true
    KeywordsDataBingAudienceEstimationTaskGetResultInfo:
      type: object
      properties:
        est_impressions:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AudienceEstimationInfo'
          description: <em>monthly estimated impressions range</em>
          nullable: true
        est_audience_size:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AudienceEstimationInfo'
          description: <em>monthly estimated reach user count range</em>
          nullable: true
        est_clicks:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AudienceEstimationInfo'
          description: <em>monthly estimated click count range</em>
          nullable: true
        est_spend:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AudienceEstimationInfo'
          description: <em>monthly estimated spending range</em>
          nullable: true
        est_cost_per_event:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AudienceEstimationInfo'
          description: <em>indicates the estimated cost per event with range result</em>
          nullable: true
        est_ctr:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AudienceEstimationInfo'
          description: <em>estimated click-through rate range</em>
          nullable: true
        suggested_bid:
          type: number
          description: <em>suggested bid value under the current targeting</em>
          nullable: true
        suggested_budget:
          type: number
          description: <em>suggested daily budget value under the current targeting and bid</em>
          format: double
          nullable: true
        events_lost_to_bid:
          type: integer
          description: <em>indicates event lost count due to insufficient input bid</em>
          format: int64
          nullable: true
        events_lost_to_budget:
          type: integer
          description: <em>indicates the event lost count due to insufficient input budget</em>
          nullable: true
        est_reach_audience_size:
          type: integer
          description: <em>monthly estimated user count</em>
          format: int64
          nullable: true
        est_reach_impressions:
          type: integer
          description: <em>monthly estimated impressions</em>
          format: int64
          nullable: true
        currency:
          type: string
          description: '<em>currency name</em><p>example: <code>USDollar</code>'
          nullable: true
    KeywordsDataBingAudienceEstimationTaskGetTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/KeywordsDataBingAudienceEstimationTaskGetResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    KeywordsDataBingAudienceEstimationTaskGetResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/KeywordsDataBingAudienceEstimationTaskGetTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    KeywordsDataBingAudienceEstimationLiveRequestInfo:
      type: object
      properties:
        location_name:
          type: string
          description: '<em>full name of search engine location</em><br><strong>required field if you don''t specify</strong> <code>location_code</code> or <code>location_coordinate</code><br><strong>if you use this field, you don''t need to specify <code>location_code</code> or <code>location_coordinate</code></strong><br>you can receive the list of available locations of the search engine with their <code>location_name</code> by making a separate request to <code>https://api.dataforseo.com/v3/keywords_data/bing/locations</code><br>example:<br><code class="long-string">London,England,United Kingdom</code>'
        location_code:
          type: integer
          description: '<em>search engine location code</em><br><strong>required field if you don''t specify</strong> <code>location_name</code> or <code>location_coordinate</code><br><strong>if you use this field, you don''t need to specify <code>location_name</code> or <code>location_coordinate</code></strong><br>you can receive the list of available locations of the search engines with their <code>location_code</code> by making a separate request to <code>https://api.dataforseo.com/v3/keywords_data/bing/locations</code><br>example:<br><code class="long-string">2840</code>'
        location_coordinate:
          type: string
          description: '<em>GPS coordinates of a location</em><br><strong>required field if you don''t specify</strong> <code>location_name</code> or <code>location_code</code><br><strong>if you use this field, you don''t need to specify <code>location_name</code> or <code>location_code</code></strong><br><code>location_coordinate</code> parameter should be specified in the <em>"latitude,longitude,radius (in km)"</em> format<br><strong>the data will be provided for the country the specified coordinates belong to</strong><br>example:<br><code class="long-string">29.6821525,-82.4098881,100</code>'
        age:
          type: array
          items:
            type: string
          description: '<em>selection of age ranges for targeting</em><br>possible values: <code>eighteen_to_twenty_four</code>, <code>fifty_to_sixty_four</code>, <code>sixty_five_and_above</code>, <code>thirteen_to_seventeen</code>, <code>thirty_five_to_forty_nine</code>, <code>twenty_five_to_thirty_four</code>, <code>unknown</code>, <code>zero_to_twelve</code>'
          nullable: true
        bid:
          type: number
          description: '<em>desired bid setting value in USD</em><br>maximum value: 1000'
          nullable: true
        daily_budget:
          type: number
          description: '<em>daily campaign budget value in USD</em><br>maximum value: 10000'
          nullable: true
        gender:
          type: array
          items:
            type: string
          description: '<em>gender to target</em><br>possible values: <code>male</code>, <code>female</code>, <code>unknown</code>'
          nullable: true
        industry:
          type: array
          items:
            type: string
          description: '<em>industry of LinkedIn profile targeting</em><p>if you use this field, you can receive the list of available industry names  with industry_id by making a separate request to the https://api.dataforseo.com/v3/keywords_data/bing/audience_estimation/industries<p>example: <code>806301758</code>'
          nullable: true
        job_function:
          type: array
          items:
            type: string
          description: '<em>job function of LinkedIn profile targeting</em><p>if you use this field, you can receive the list of available job function names  with job_function_id by making a separate request to the https://api.dataforseo.com/v3/keywords_data/bing/audience_estimation/job_functions<p>example: <code>806300451</code>'
          nullable: true
      example:
        - location_coordinate: '29.6821525,-82.4098881,100'
          age:
            - twenty_five_to_thirty_four
            - eighteen_to_twenty_four
            - unknown
          bid: 1
          daily_budget: 24
          gender:
            - male
          industry:
            - '806303407'
            - '806301758'
          job_function:
            - '806298607'
    KeywordsDataBingAudienceEstimationLiveResultInfo:
      type: object
      properties:
        est_impressions:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AudienceEstimationInfo'
          description: <em>monthly estimated impressions range</em>
          nullable: true
        est_audience_size:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AudienceEstimationInfo'
          description: <em>monthly estimated reach user count range</em>
          nullable: true
        est_clicks:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AudienceEstimationInfo'
          description: <em>monthly estimated click count range</em>
          nullable: true
        est_spend:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AudienceEstimationInfo'
          description: <em>monthly estimated spending range</em>
          nullable: true
        est_cost_per_event:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AudienceEstimationInfo'
          description: <em>indicates the estimated cost per event with range result</em>
          nullable: true
        est_ctr:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AudienceEstimationInfo'
          description: <em>estimated click-through rate range</em>
          nullable: true
        suggested_bid:
          type: number
          description: <em>suggested bid value under the current targeting</em>
          nullable: true
        suggested_budget:
          type: number
          description: <em>suggested daily budget value under the current targeting and bid</em>
          format: double
          nullable: true
        events_lost_to_bid:
          type: integer
          description: <em>indicates event lost count due to insufficient input bid</em>
          format: int64
          nullable: true
        events_lost_to_budget:
          type: integer
          description: <em>indicates the event lost count due to insufficient input budget</em>
          nullable: true
        est_reach_audience_size:
          type: integer
          description: <em>monthly estimated user count</em>
          format: int64
          nullable: true
        est_reach_impressions:
          type: integer
          description: <em>monthly estimated impressions</em>
          format: int64
          nullable: true
        currency:
          type: string
          description: '<em>currency name</em><p>example: <code>USDollar</code>'
          nullable: true
    KeywordsDataBingAudienceEstimationLiveTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/KeywordsDataBingAudienceEstimationLiveResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    KeywordsDataBingAudienceEstimationLiveResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/KeywordsDataBingAudienceEstimationLiveTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    KeywordsDataBingKeywordsForSiteTaskPostRequestInfo:
      type: object
      properties:
        target:
          type: string
          description: <em>domain or URL</em><br><strong>required field</strong><br>the URL of the webpage or the domain to scan for possible keywords
        location_name:
          type: string
          description: '<em>full name of search engine location</em><br><strong>required field if you don''t specify</strong> <code>location_code</code> or <code>location_coordinate</code><br><strong>if you use this field, you don''t need to specify <code>location_code</code> or <code>location_coordinate</code></strong><br>you can receive the list of available locations of the search engine with their <code>location_name</code> by making a separate request to <code>https://api.dataforseo.com/v3/keywords_data/bing/locations</code><br>example:<br><code class="long-string">London,England,United Kingdom</code>'
        location_code:
          type: integer
          description: '<em>search engine location code</em><br><strong>required field if you don''t specify</strong> <code>location_name</code> or <code>location_coordinate</code><br><strong>if you use this field, you don''t need to specify <code>location_name</code> or <code>location_coordinate</code></strong><br>you can receive the list of available locations of the search engines with their <code>location_code</code> by making a separate request to <code>https://api.dataforseo.com/v3/keywords_data/bing/locations</code><br>example:<br><code class="long-string">2840</code>'
        location_coordinate:
          type: string
          description: '<em>GPS coordinates of a location</em><br><strong>required field if you don''t specify</strong> <code>location_name</code> or <code>location_code</code><br><strong>if you use this field, you don''t need to specify <code>location_name</code> or <code>location_code</code></strong><br><code>location_coordinate</code> parameter should be specified in the <em>"latitude,longitude"</em> format<br><strong>the data will be provided for the country the specified coordinates belong to</strong><br>example:<br><code class="long-string">52.6178549,-155.352142</code>'
        language_name:
          type: string
          description: '<em>full name of search engine language</em><br><strong>required field if you don''t specify</strong> <code>language_code</code><br>if you use this field, you don''t need to specify <code>language_code</code><br>supported languages:<br><code>English</code>, <code>French</code>, <code>German</code>'
        language_code:
          type: string
          description: '<em>search engine language code</em><br><strong>required field if you don''t specify</strong> <code>language_name</code><br>if you use this field, you don''t need to specify <code>language_name</code><br>supported languages:<br><code class="long-string">en</code>, <code>fr</code>, <code>de</code>'
        keywords_negative:
          type: array
          items:
            type: string
          description: <em>keywords negative array</em><br>optional field<br>These keywords will be ignored in the results array;<br>You can specify <strong>a maximum of 200 terms</strong> that you want to exclude from the results;<br>the specified keywords will be converted to lowercase format
          nullable: true
        device:
          type: string
          description: '<em>device type</em><br>optional field<br>specify this field if you want to get the data for a particular device type<br>possible values: <code>all</code>, <code>mobile</code>, <code>desktop</code>, <code>tablet</code><br>default value: <code>all</code>'
          nullable: true
        sort_by:
          type: string
          description: '<em>results sorting parameters</em><br>optional field<br>Use these parameters to sort the results by <code>search_volume</code>, <code>cpc</code>, <code>competition</code> or <code>relevance</code> in the descending order<br>default value: <code>relevance</code>'
          nullable: true
        date_from:
          type: string
          description: '<em>starting date of the time range</em><br>optional field<br>minimal value: 24 months from today''s date;<br>if you don''t specify this field, data will be provided for the last 12 months;<br>if <a href="/v3/keywords_data/bing/status/" target="_blank" rel="noopener noreferrer">Status endpoint</a> returns <code>false</code> in the <code>actual_data</code> field, <code>date_from</code> can be set to the month before last and prior;<br>if <a href="/v3/keywords_data/bing/status/" target="_blank" rel="noopener noreferrer">Status endpoint</a> returns <code>true</code> in the <code>actual_data</code> field, <code>date_from</code> can be set to the last month and prior;<br>date format: <code>"yyyy-mm-dd"</code><br>example:<br><code>"2020-01-01"</code><p><strong>Note:</strong> we do not recommend using a custom time range for the past year''s dates'
          nullable: true
        date_to:
          type: string
          description: '<em>ending date of the time range</em><br>optional field<br>if you don''t specify this field, data will be provided for the last 12 months;<br>minimum value: two years back from today’s date;<br>maximum value: one month from today''s date;<br>date format: <code>"yyyy-mm-dd"</code><br>example:<br><code>"2020-03-15"</code><p><strong>Note:</strong> we do not recommend using a custom time range for the past year''s dates'
          nullable: true
        postback_url:
          type: string
          description: '<em>URL for sending task results</em><br>optional field<br>once the task is completed, we will send a POST request with its results compressed in the <code>gzip</code> format to the <code>postback_url</code> you specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/postbackscript?id=$id</code><br><code>http://your-server.com/postbackscript?id=$id&amp;tag=$tag</code><br><strong>Note:</strong> special characters in <code>postback_url</code> will be urlencoded;<br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href="https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api" target="_blank" rel="noopener noreferrer">Help Center</a>'
          nullable: true
        pingback_url:
          type: string
          description: '<em>notification URL of a completed task</em><br>optional field<br>when a task is completed we will notify you by GET request sent to the URL you have specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/pingscript?id=$id</code><br><code>http://your-server.com/pingscript?id=$id&amp;tag=$tag</code><br><strong>Note:</strong> special characters in <code>pingback_url</code> will be urlencoded;<br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href="https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api" target="_blank" rel="noopener noreferrer">Help Center</a>'
          nullable: true
        search_partners:
          type: boolean
          description: '<em>Bing search partners type</em><br>optional field<br>if you specify <code class="prettyprint">true</code>, the results will be delivered for owned, operated, and syndicated networks across Bing, Yahoo, AOL and partner sites that host Bing, AOL, and Yahoo search.<br>default value: <code>false</code> - results are returned for Bing, AOL, and Yahoo search networks'
          nullable: true
        tag:
          type: string
          description: <em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response
          nullable: true
      example:
        - language_code: en
          location_code: 2840
          target: dataforseo.com
    KeywordsDataBingKeywordsForSiteTaskPostTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: object
              description: '<em>array of results</em><br>in this case, the value will be <code>null</code>'
              nullable: true
    KeywordsDataBingKeywordsForSiteTaskPostResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/KeywordsDataBingKeywordsForSiteTaskPostTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    KeywordsDataBingKeywordsForSiteTasksReadyResultInfo:
      type: object
      properties:
        id:
          type: string
          description: <em>task identifier of the completed task</em><br><strong>unique task identifier in our system in the <a href="https://en.wikipedia.org/wiki/Universally_unique_identifier">UUID</a> format</strong>
          nullable: true
        se:
          type: string
          description: <em>search engine specified when setting the task</em>
          nullable: true
        se_type:
          type: string
          nullable: true
        date_posted:
          type: string
          description: <em>date when the task was posted (in the UTC format)</em>
          nullable: true
        tag:
          type: string
          nullable: true
        endpoint:
          type: string
          description: <em>URL for collecting the results of the task</em>
          nullable: true
        function:
          type: string
          nullable: true
    KeywordsDataBingKeywordsForSiteTasksReadyTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/KeywordsDataBingKeywordsForSiteTasksReadyResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    KeywordsDataBingKeywordsForSiteTasksReadyResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/KeywordsDataBingKeywordsForSiteTasksReadyTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    KeywordsDataBingKeywordsForSiteTaskGetResultInfo:
      type: object
      properties:
        keyword:
          type: string
          description: <em>keyword in a POST array</em>
          nullable: true
        location_code:
          type: integer
          description: <em>location code in a POST array</em><br>if there is no data the value is <code>null</code>
          nullable: true
        language_code:
          type: string
          description: <em>language code in a POST array</em><br>if there is no data the value is <code>null</code>
          nullable: true
        search_partners:
          type: boolean
          description: <em>indicates whether data from partner networks included in the response</em>
          nullable: true
        device:
          type: string
          description: '<em>device type in a POST array</em><br>if there is no data, then the value is_<code>null</code>n'
          nullable: true
        competition:
          type: number
          description: '<em>competition</em><br>represents the relative amount of competition associated with the given keyword in paid SERP only. This value is based on Bing Ads data.<br>Possible values: <code>0.1</code>, <code>0.5</code>,<code>0.9</code> <p><code>0.1</code> - low competition,<br><code>0.5</code> - medium competition, <br><code>0.9</code> - high competition;<br>if there is no data the value is <code>null</code>'
          nullable: true
        cpc:
          type: number
          description: <em>cost-per-click</em><br>represents the average cost per click (USD) historically paid for the keyword.<br>if there is no data the value is <code>null</code>
          nullable: true
        search_volume:
          type: integer
          description: <em>monthly average search volume rate<br></em>represents the (approximate) number of searches for the given keyword idea on Bing search engine depending on the user’s targeting<br>if there is no data then the value is_<code>null</code>n
          format: int64
          nullable: true
        categories:
          type: array
          items:
            type: string
            nullable: true
          description: '<em>product and service categories</em><br>legacy field, the value will always be <code>null</code>'
          nullable: true
        monthly_searches:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/MonthlySearchesInfo'
            nullable: true
          description: '<em>monthly searches</em><br>represents the (approximate) number of searches on this keyword idea (as available for the past twelve months), targeted to the specified geographic locations<p>search volume is rounded to the closest decimal values<p>if there is no data the value is <code>null</code>'
          nullable: true
    KeywordsDataBingKeywordsForSiteTaskGetTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/KeywordsDataBingKeywordsForSiteTaskGetResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    KeywordsDataBingKeywordsForSiteTaskGetResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/KeywordsDataBingKeywordsForSiteTaskGetTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    KeywordsDataBingKeywordsForSiteLiveRequestInfo:
      type: object
      properties:
        target:
          type: string
          description: <em>domain or URL</em><br><strong>required field</strong><br>the domain name or URL of the target website
        location_name:
          type: string
          description: '<em>full name of search engine location</em><br><strong>required field if you don''t specify</strong> <code>location_code</code> or <code>location_coordinate</code><br><strong>if you use this field, you don''t need to specify <code>location_code</code> or <code>location_coordinate</code></strong><br>you can receive the list of available locations of the search engine with their <code>location_name</code> by making a separate request to <code>https://api.dataforseo.com/v3/keywords_data/bing/locations</code><br>example:<br><code class="long-string">London,England,United Kingdom</code>'
        location_code:
          type: integer
          description: '<em>search engine location code</em><br><strong>required field if you don''t specify</strong> <code>location_name</code> or <code>location_coordinate</code><br><strong>if you use this field, you don''t need to specify <code>location_name</code> or <code>location_coordinate</code></strong><br>you can receive the list of available locations of the search engines with their <code>location_code</code> by making a separate request to <code>https://api.dataforseo.com/v3/keywords_data/bing/locations</code><br>example:<br><code class="long-string">2840</code>'
        location_coordinate:
          type: string
          description: '<em>GPS coordinates of a location</em><br><strong>required field if you don''t specify</strong> <code>location_name</code> or <code>location_code</code><br><strong>if you use this field, you don''t need to specify <code>location_name</code> or <code>location_code</code></strong><br><code>location_coordinate</code> parameter should be specified in the <em>"latitude,longitude"</em> format<br><strong>the data will be provided for the country the specified coordinates belong to</strong><br>example:<br><code class="long-string">52.6178549,-155.352142</code>'
        language_name:
          type: string
          description: '<em>full name of search engine language</em><br><strong>required field if you don''t specify</strong> <code>language_code</code><br>if you use this field, you don''t need to specify <code>language_code</code><br>supported languages:<br><code>English</code>, <code>French</code>, <code>German</code>'
        language_code:
          type: string
          description: '<em>search engine language code</em><br><strong>required field if you don''t specify</strong> <code>language_name</code><br>if you use this field, you don''t need to specify <code>language_name</code><br>supported languages:<br><code class="long-string">en</code>, <code>fr</code>, <code>de</code>'
        keywords_negative:
          type: array
          items:
            type: string
          description: <em>keywords negative array</em><br>optional field<br>These keywords will be ignored in the results array;<br>You can specify <strong>a maximum of 200 terms</strong> that you want to exclude from the results;<br>the specified keywords will be converted to lowercase format
          nullable: true
        device:
          type: string
          description: '<em>device type</em><br>optional field<br>specify this field if you want to get the data for a particular device typepossible values: <code>all</code>, <code>mobile</code>, <code>desktop</code>, <code>tablet</code><br>default value: <code>all</code>'
          nullable: true
        date_from:
          type: string
          description: '<em>starting date of the time range</em><br>optional field<br>minimal value: 24 months from today''s date;<br>if you don''t specify this field, data will be provided for the last 12 months;<br>if <a href="/v3/keywords_data/bing/status/" target="_blank" rel="noopener noreferrer">Status endpoint</a> returns <code>false</code> in the <code>actual_data</code> field, <code>date_from</code> can be set to the month before last and prior;<br>if <a href="/v3/keywords_data/bing/status/" target="_blank" rel="noopener noreferrer">Status endpoint</a> returns <code>true</code> in the <code>actual_data</code> field, <code>date_from</code> can be set to the last month and prior;<br>date format: <code>"yyyy-mm-dd"</code><br>example:<br><code>"2020-01-01"</code><p><strong>Note:</strong> we do not recommend using a custom time range for the past year''s dates'
          nullable: true
        date_to:
          type: string
          description: '<em>ending date of the time range</em><br>optional field<br>if you don''t specify this field, data will be provided for the last 12 months;<br>minimum value: two years back from today’s date;<br>maximum value: one month from today''s date;<br><strong>note:</strong> we do not recommend using a custom time range for the past year''s dates;<br>date format: <code>"yyyy-mm-dd"</code><br>example:<br><code>"2020-03-15"</code><p><strong>Note:</strong> we do not recommend using a custom time range for the past year''s dates'
          nullable: true
        sort_by:
          type: string
          description: '<em>results sorting parameters</em><br>optional field<br>Use these parameters to sort the results by <code>search_volume</code>, <code>cpc</code>, <code>competition</code> or <code>relevance</code> in the descending order<br>default value: <code>relevance</code>'
          nullable: true
        search_partners:
          type: boolean
          description: '<em>Bing search partners type</em><br>optional field<br>if you specify <code class="prettyprint">true</code>, the results will be delivered for owned, operated, and syndicated networks across Bing, Yahoo, AOL and partner sites that host Bing, AOL, and Yahoo search.<br>default value: <code>false</code> - results are returned for Bing, AOL, and Yahoo search networks'
          nullable: true
        tag:
          type: string
          description: <em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response
          nullable: true
      example:
        - language_code: en
          location_code: 2840
          target: dataforseo.com
    KeywordsDataBingKeywordsForSiteLiveResultInfo:
      type: object
      properties:
        keyword:
          type: string
          description: <em>keyword in a POST array</em>
          nullable: true
        location_code:
          type: integer
          description: <em>location code in a POST array</em>
          nullable: true
        language_code:
          type: string
          description: <em>language code in a POST array</em>
          nullable: true
        search_partners:
          type: boolean
          description: <em>indicates whether data from partner networks included in the response</em>
          nullable: true
        device:
          type: string
          description: '<em>device type in a POST array</em><br>if there is no data, then the value is_<code>null</code>n'
          nullable: true
        competition:
          type: number
          description: '<em>competition</em><br>represents the relative amount of competition associated with the given keyword in paid SERP only. This value is based on Bing Ads data.<br>Possible values: <code>0.1</code>, <code>0.5</code>,<code>0.9</code><code>0.1</code> - low competition,<br><code>0.5</code> - medium competition,<br><code>0.9</code> - high competition;<br>if there is no data the value is <code>null</code>'
          nullable: true
        cpc:
          type: number
          description: '<em>cost-per-click</em><br>represents the average cost per click (USD) historically paid for the keyword.<br>if there is no data, then the value is_<code>null</code>n'
          nullable: true
        search_volume:
          type: integer
          description: '<em>monthly average search volume rate<br></em>represents the (approximate) number of searches for the keyword on the Bing search engine, depending on the user’s targetingsearch volume is rounded to the closest decimal valuesif there is no data, then the value is_<code>null</code>n'
          format: int64
          nullable: true
        categories:
          type: array
          items:
            type: string
            nullable: true
          description: '<em>product and service categories</em><br>legacy field, the value will always be <code>null</code>'
          nullable: true
        monthly_searches:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/MonthlySearchesInfo'
            nullable: true
          description: '<em>monthly searches</em><br>represents the (approximate) number of searches on this keyword (as available for the past twelve months), targeted to the specified geographic locations.<br>if there is no data, then the value is_<code>null</code>n'
          nullable: true
    KeywordsDataBingKeywordsForSiteLiveTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/KeywordsDataBingKeywordsForSiteLiveResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    KeywordsDataBingKeywordsForSiteLiveResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/KeywordsDataBingKeywordsForSiteLiveTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    KeywordsDataBingKeywordsForKeywordsTaskPostRequestInfo:
      type: object
      properties:
        keywords:
          type: array
          items:
            type: string
          description: '<em>keywords</em><br><strong>required field</strong><br>you can specify <strong>the maximum of 200 keywords</strong> with each keyword containing no more than <strong>100 characters</strong>;<br>the specified keywords will be converted to lowercase, data will be provided in a separate array<p>learn more about rules and limitations of <code>keyword</code> and <code>keywords</code> fields in DataForSEO APIs in this <a href="https://dataforseo.com/help-center/rules-and-limitations-of-keyword-and-keywords-fields-in-dataforseo-apis" rel="noopener noreferrer" target="_blank">Help Center article</a>'
        location_name:
          type: string
          description: '<em>full name of search engine location</em><br><strong>required field if you don''t specify</strong> <code>location_code</code> or <code>location_coordinate</code><br><strong>if you use this field, you don''t need to specify <code>location_code</code> or <code>location_coordinate</code></strong><br>you can receive the list of available locations of the search engine with their <code>location_name</code> by making a separate request to <code>https://api.dataforseo.com/v3/keywords_data/bing/locations</code><br>example:<br><code class="long-string">London,England,United Kingdom</code>'
        location_code:
          type: integer
          description: '<em>search engine location code</em><br><strong>required field if you don''t specify</strong> <code>location_name</code> or <code>location_coordinate</code><br><strong>if you use this field, you don''t need to specify <code>location_name</code> or <code>location_coordinate</code></strong><br>you can receive the list of available locations of the search engines with their <code>location_code</code> by making a separate request to <code>https://api.dataforseo.com/v3/keywords_data/bing/locations</code><br>example:<br><code class="long-string">2840</code>'
        location_coordinate:
          type: string
          description: '<em>GPS coordinates of a location</em><br><strong>required field if you don''t specify</strong> <code>location_name</code> or <code>location_code</code><br><strong>if you use this field, you don''t need to specify <code>location_name</code> or <code>location_code</code></strong><br><code>location_coordinate</code> parameter should be specified in the <em>"latitude,longitude"</em> format<br><strong>the data will be provided for the country the specified coordinates belong to</strong><br>example:<br><code class="long-string">52.6178549,-155.352142</code>'
        language_name:
          type: string
          description: '<em>full name of search engine language</em><br><strong>required field if you don''t specify</strong> <code>language_code</code><br>if you use this field, you don''t need to specify <code>language_code</code><br>supported languages:<br><code>English</code>, <code>French</code>, <code>German</code>'
        language_code:
          type: string
          description: '<em>search engine language code</em><br><strong>required field if you don''t specify</strong> <code>language_name</code><br>if you use this field, you don''t need to specify <code>language_name</code><br>supported languages:<br><code class="long-string">en</code>, <code>fr</code>, <code>de</code>'
        sort_by:
          type: string
          description: '<em>results sorting parameters</em><br>optional field<br>Use these parameters to sort the results by <code>search_volume</code>, <code>cpc</code>, <code>competition</code> or <code>relevance</code> in the descending order<br>default value: <code>relevance</code>'
          nullable: true
        keywords_negative:
          type: array
          items:
            type: string
          description: <em>keywords negative array</em><br>optional field<br>These keywords will be ignored in the results array;<br>You can specify <strong>a maximum of 200 terms</strong> that you want to exclude from the results;<br>the specified keywords will be converted to lowercase format
          nullable: true
        device:
          type: string
          description: '<em>device type</em><br>optional field<br>specify this field if you want to get the data for a particular device type;<br>possible values: <code>all</code>, <code>mobile</code>, <code>desktop</code>, <code>tablet</code><br>default value: <code>all</code>'
          nullable: true
        date_from:
          type: string
          description: '<em>starting date of the time range</em><br>optional field<br>minimal value: 24 months from today''s date;<br>if you don''t specify this field, data will be provided for the last 12 months;<br>if <a href="/v3/keywords_data/bing/status/" target="_blank" rel="noopener noreferrer">Status endpoint</a> returns <code>false</code> in the <code>actual_data</code> field, <code>date_from</code> can be set to the month before last and prior;<br>if <a href="/v3/keywords_data/bing/status/" target="_blank" rel="noopener noreferrer">Status endpoint</a> returns <code>true</code> in the <code>actual_data</code> field, <code>date_from</code> can be set to the last month and prior;<br>date format: <code>"yyyy-mm-dd"</code><br>example:<br><code>"2020-01-01"</code><p><strong>Note:</strong> we do not recommend using a custom time range for the past year''s dates'
          nullable: true
        date_to:
          type: string
          description: '<em>ending date of the time range</em><br>optional field<br>if you don''t specify this field, data will be provided for the last 12 months;<br>minimum value: two years back from today’s date;<br>maximum value: one month from today''s date;<br>date format: <code>"yyyy-mm-dd"</code><br>example:<br><code>"2020-03-15"</code><p><strong>Note:</strong> we do not recommend using a custom time range for the past year''s dates'
          nullable: true
        search_partners:
          type: boolean
          description: '<em>Bing search partners type</em><br>optional field<br>if you specify <code class="prettyprint">true</code>, the results will be delivered for owned, operated, and syndicated networks across Bing, Yahoo, AOL and partner sites that host Bing, AOL, and Yahoo search.<br>default value: <code>false</code> - results are returned for Bing, AOL, and Yahoo search networks'
          nullable: true
        postback_url:
          type: string
          description: '<em>URL for sending task results</em><br>optional field<br>once the task is completed, we will send a POST request with its results compressed in the <code>gzip</code> format to the <code>postback_url</code> you specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/postbackscript?id=$id</code><br><code>http://your-server.com/postbackscript?id=$id&amp;tag=$tag</code><br><strong>Note:</strong> special characters in <code>postback_url</code> will be urlencoded;<br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href="https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api" target="_blank" rel="noopener noreferrer">Help Center</a>'
          nullable: true
        pingback_url:
          type: string
          description: '<em>notification URL of a completed task</em><br>optional field<br>when a task is completed we will notify you by GET request sent to the URL you have specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/pingscript?id=$id</code><br><code>http://your-server.com/pingscript?id=$id&amp;tag=$tag</code><br><strong>Note:</strong> special characters in <code>pingback_url</code> will be urlencoded;<br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href="https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api" target="_blank" rel="noopener noreferrer">Help Center</a>'
          nullable: true
        tag:
          type: string
          description: <em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response
          nullable: true
      example:
        - location_code: 2840
          language_code: en
          keywords:
            - average page rpm adsense
            - adsense blank ads how long
            - leads and prospects
    KeywordsDataBingKeywordsForKeywordsTaskPostTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: object
              description: '<em>array of results</em><br>in this case, the value will be <code>null</code>'
              nullable: true
    KeywordsDataBingKeywordsForKeywordsTaskPostResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/KeywordsDataBingKeywordsForKeywordsTaskPostTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    KeywordsDataBingKeywordsForKeywordsTasksReadyResultInfo:
      type: object
      properties:
        id:
          type: string
          description: <em>task identifier of the completed task</em><br><strong>unique task identifier in our system in the <a href="https://en.wikipedia.org/wiki/Universally_unique_identifier">UUID</a> format</strong>
          nullable: true
        se:
          type: string
          description: <em>search engine specified when setting the task</em>
          nullable: true
        se_type:
          type: string
          nullable: true
        date_posted:
          type: string
          description: <em>date when the task was posted (in the UTC format)</em>
          nullable: true
        tag:
          type: string
          nullable: true
        endpoint:
          type: string
          description: <em>URL for collecting the results of the task</em>
          nullable: true
        function:
          type: string
          description: type of the task
          nullable: true
    KeywordsDataBingKeywordsForKeywordsTasksReadyTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/KeywordsDataBingKeywordsForKeywordsTasksReadyResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    KeywordsDataBingKeywordsForKeywordsTasksReadyResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/KeywordsDataBingKeywordsForKeywordsTasksReadyTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    KeywordsDataBingKeywordsForKeywordsTaskGetResultInfo:
      type: object
      properties:
        keyword:
          type: string
          description: <em>keyword in a POST array</em>
          nullable: true
        location_code:
          type: integer
          nullable: true
        language_code:
          type: string
          nullable: true
        search_partners:
          type: boolean
          description: <em>indicates whether data from partner networks included in the response</em>
          nullable: true
        device:
          type: string
          description: '<em>device type</em><br>indicates for what device type the data is provided;<br>possible values: <code>all</code>, <code>mobile</code>, <code>desktop</code>, <code>tablet</code>'
          nullable: true
        competition:
          type: number
          description: '<em>competition</em><br>represents the relative amount of competition associated with the given keyword in paid SERP only. This value is based on Bing Ads data.<br>Possible values: <code>0.1</code>, <code>0.5</code>,<code>0.9</code> <p><code>0.1</code> - low competition,<br><code>0.5</code> - medium competition, <br><code>0.9</code> - high competition;<br>if there is no data the value is <code>null</code>'
          nullable: true
        cpc:
          type: number
          description: '<em>cost-per-click</em><br>represents the average cost per click (USD) historically paid for the keyword.<br>if there is no data, then the value is_<code>null</code>n'
          nullable: true
        search_volume:
          type: integer
          description: '<em>monthly average search volume rate</em><br>represents the (approximate) number of searches for the keyword on the Bing search engine, depending on the user’s targeting<p>search volume is rounded to the closest decimal values<p>if there is no data, then the value is_<code>null</code>n'
          format: int64
          nullable: true
        categories:
          type: array
          items:
            type: string
            nullable: true
          description: '<em>product and service categories</em><br>legacy field, the value will always be <code>null</code>'
          nullable: true
        monthly_searches:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/MonthlySearchesInfo'
            nullable: true
          description: '<em>monthly searches</em><br>represents the (approximate) number of searches on this keyword (as available for the past twelve months), targeted to the specified geographic locations.<br>if there is no data, then the value is_<code>null</code>n'
          nullable: true
    KeywordsDataBingKeywordsForKeywordsTaskGetTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/KeywordsDataBingKeywordsForKeywordsTaskGetResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    KeywordsDataBingKeywordsForKeywordsTaskGetResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/KeywordsDataBingKeywordsForKeywordsTaskGetTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    KeywordsDataBingKeywordsForKeywordsLiveRequestInfo:
      type: object
      properties:
        keywords:
          type: array
          items:
            type: string
          description: '<em>keywords</em><br><strong>required field</strong><br>you can specify <strong>the maximum of 200 keywords</strong> with each keyword containing no more than <strong>100 characters</strong>;<br>the specified keywords will be converted to lowercase, data will be provided in a separate array<p>learn more about rules and limitations of <code>keyword</code> and <code>keywords</code> fields in DataForSEO APIs in this <a href="https://dataforseo.com/help-center/rules-and-limitations-of-keyword-and-keywords-fields-in-dataforseo-apis" rel="noopener noreferrer" target="_blank">Help Center article</a>'
        location_name:
          type: string
          description: '<em>full name of search engine location</em><br><strong>required field if you don''t specify</strong> <code>location_code</code> or <code>location_coordinate</code><br><strong>if you use this field, you don''t need to specify <code>location_code</code> or <code>location_coordinate</code></strong><br>you can receive the list of available locations of the search engine with their <code>location_name</code> by making a separate request to <code>https://api.dataforseo.com/v3/keywords_data/bing/locations</code><br>example:<br><code class="long-string">London,England,United Kingdom</code>'
        location_code:
          type: integer
          description: '<em>search engine location code</em><br><strong>required field if you don''t specify</strong> <code>location_name</code> or <code>location_coordinate</code><br><strong>if you use this field, you don''t need to specify <code>location_name</code> or <code>location_coordinate</code></strong><br>you can receive the list of available locations of the search engines with their <code>location_code</code> by making a separate request to <code>https://api.dataforseo.com/v3/keywords_data/bing/locations</code><br>example:<br><code class="long-string">2840</code>'
        location_coordinate:
          type: string
          description: '<em>GPS coordinates of a location</em><br><strong>required field if you don''t specify</strong> <code>location_name</code> or <code>location_code</code><br><strong>if you use this field, you don''t need to specify <code>location_name</code> or <code>location_code</code></strong><br><code>location_coordinate</code> parameter should be specified in the <em>"latitude,longitude"</em> format<br><strong>the data will be provided for the country the specified coordinates belong to</strong><br>example:<br><code class="long-string">52.6178549,-155.352142</code>'
        language_name:
          type: string
          description: '<em>full name of search engine language</em><br><strong>required field if you don''t specify</strong> <code>language_code</code><br>if you use this field, you don''t need to specify <code>language_code</code><br>supported languages:<br><code>English</code>, <code>French</code>, <code>German</code>'
        language_code:
          type: string
          description: '<em>search engine language code</em><br><strong>required field if you don''t specify</strong> <code>language_name</code><br>if you use this field, you don''t need to specify <code>language_name</code><br>supported languages:<br><code class="long-string">en</code>, <code>fr</code>, <code>de</code>'
        sort_by:
          type: string
          description: '<em>results sorting parameters</em><br>optional field<br>Use these parameters to sort the results by <code>search_volume</code>, <code>cpc</code>, <code>competition</code> or <code>relevance</code> in the descending order<br>default value: <code>relevance</code>'
          nullable: true
        keywords_negative:
          type: array
          items:
            type: string
          description: <em>keywords negative array</em><br>optional field<br>These keywords will be ignored in the results array;<br>You can specify <strong>a maximum of 200 terms</strong> that you want to exclude from the results;<br>the specified keywords will be converted to lowercase format
          nullable: true
        device:
          type: string
          description: '<em>device type</em><br>optional field<br>specify this field if you want to get the data for a particular device type;<br>possible values: <code>all</code>, <code>mobile</code>, <code>desktop</code>, <code>tablet</code><br>default value: <code>all</code>'
          nullable: true
        date_from:
          type: string
          description: '<em>starting date of the time range</em><br>optional field<br>minimal value: 24 months from today''s date;<br>if you don''t specify this field, data will be provided for the last 12 months;<br>if <a href="/v3/keywords_data/bing/status/" target="_blank" rel="noopener noreferrer">Status endpoint</a> returns <code>false</code> in the <code>actual_data</code> field, <code>date_from</code> can be set to the month before last and prior;<br>if <a href="/v3/keywords_data/bing/status/" target="_blank" rel="noopener noreferrer">Status endpoint</a> returns <code>true</code> in the <code>actual_data</code> field, <code>date_from</code> can be set to the last month and prior;<br>date format: <code>"yyyy-mm-dd"</code><br>example:<br><code>"2020-01-01"</code><p><strong>Note:</strong> we do not recommend using a custom time range for the past year''s dates'
          nullable: true
        date_to:
          type: string
          description: '<em>ending date of the time range</em><br>optional field<br>if you don''t specify this field, data will be provided for the last 12 months;<br>minimum value: two years back from today’s date;<br>maximum value: one month from today''s date;<br>date format: <code>"yyyy-mm-dd"</code><br>example:<br><code>"2020-03-15"</code><p><strong>Note:</strong> we do not recommend using a custom time range for the past year''s dates'
          nullable: true
        search_partners:
          type: boolean
          description: '<em>Bing search partners type</em><br>optional field<br>if you specify <code class="prettyprint">true</code>, the results will be delivered for owned, operated, and syndicated networks across Bing, Yahoo, AOL and partner sites that host Bing, AOL, and Yahoo search.<br>default value: <code>false</code> - results are returned for Bing, AOL, and Yahoo search networks'
          nullable: true
        tag:
          type: string
          description: <em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response
          nullable: true
      example:
        - location_name: United States
          language_name: English
          keywords:
            - average page rpm adsense
            - adsense blank ads how long
            - leads and prospects
    KeywordsDataBingKeywordsForKeywordsLiveResultInfo:
      type: object
      properties:
        keyword:
          type: string
          description: <em>keyword in a POST array</em>
          nullable: true
        location_code:
          type: integer
          description: '<em>location code in a POST array</em><br>if there is no data, then the value is_<code>null</code>n'
          nullable: true
        language_code:
          type: string
          description: '<em>language code in a POST array</em><br>if there is no data, then the value is_<code>null</code>n'
          nullable: true
        search_partners:
          type: boolean
          description: <em>indicates whether data from partner networks is included in the response</em>
          nullable: true
        device:
          type: string
          description: '<em>device type</em><br>indicates for what device type the data is provided;<br>possible values: <code>all</code>, <code>mobile</code>, <code>desktop</code>, <code>tablet</code>'
          nullable: true
        competition:
          type: number
          description: '<em>competition</em><br>represents the relative amount of competition associated with the given keyword in paid SERP only. This value is based on Bing Ads data.<br>Possible values: <code>0.1</code>, <code>0.5</code>,<code>0.9</code><code>0.1</code> - low competition,<br><code>0.5</code> - medium competition,<br><code>0.9</code> - high competition;<br>if there is no data the value is <code>null</code>'
          nullable: true
        cpc:
          type: number
          description: '<em>cost-per-click</em><br>represents the average cost per click (USD) historically paid for the keyword.<br>if there is no data, then the value is_<code>null</code>n'
          nullable: true
        search_volume:
          type: integer
          description: '<em>monthly average search volume rate</em><br>represents the (approximate) number of searches for the keyword on the Bing search engine, depending on the user’s targetingsearch volume is rounded to the closest decimal values<p>if there is no data, then the value is_<code>null</code>n'
          format: int64
          nullable: true
        categories:
          type: array
          items:
            type: string
            nullable: true
          description: '<em>product and service categories</em><br>legacy field, the value will always be <code>null</code>'
          nullable: true
        monthly_searches:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/MonthlySearchesInfo'
            nullable: true
          description: '<em>monthly searches</em><br>represents the (approximate) number of searches on this keyword (as available for the past twelve months), targeted to the specified geographic locations.<br>if there is no data, then the value is_<code>null</code>n'
          nullable: true
    KeywordsDataBingKeywordsForKeywordsLiveTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/KeywordsDataBingKeywordsForKeywordsLiveResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    KeywordsDataBingKeywordsForKeywordsLiveResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/KeywordsDataBingKeywordsForKeywordsLiveTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    AvailableLocations:
      type: object
      properties:
        location_code:
          type: integer
          description: <em>location code</em>
          nullable: true
        location_name:
          type: string
          description: <em>location name</em>
          nullable: true
        country_iso_code:
          type: string
          description: <em>ISO country code of the location</em>
          nullable: true
        location_type:
          type: string
          description: '<em>location type</em><br>possible values:<br><code>Country</code>, <code>Region</code>'
          nullable: true
    KeywordsDataBingKeywordPerformanceLocationsAndLanguagesResultInfo:
      type: object
      properties:
        language_name:
          type: string
          description: <em>language name</em>
          nullable: true
        language_code:
          type: string
          description: <em>language code</em>
          nullable: true
        available_locations:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/AvailableLocations'
            nullable: true
          description: <em>supported locations</em><br>contains locations supported in combination with a specific language
          nullable: true
    KeywordsDataBingKeywordPerformanceLocationsAndLanguagesTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/KeywordsDataBingKeywordPerformanceLocationsAndLanguagesResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    KeywordsDataBingKeywordPerformanceLocationsAndLanguagesResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/KeywordsDataBingKeywordPerformanceLocationsAndLanguagesTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    KeywordsDataBingKeywordPerformanceTaskPostRequestInfo:
      type: object
      properties:
        keywords:
          type: array
          items:
            type: string
          description: '<em>keywords</em><br><strong>required field</strong><br>The maximum number of keywords you can specify: 1000<br>The maximum number of characters for each keyword: 80<br>The maximum number of words for each keyword phrase: 10<br>the specified keywords will be converted to lowercase, data will be provided in a separate array<p>learn more about rules and limitations of <code>keyword</code> and <code>keywords</code> fields in DataForSEO APIs in this <a href="https://dataforseo.com/help-center/rules-and-limitations-of-keyword-and-keywords-fields-in-dataforseo-apis" rel="noopener noreferrer" target="_blank">Help Center article</a>'
        device:
          type: string
          description: '<em>device type</em><br>optional field<br>specify this field if you want to get the data for a particular device typepossible values: <code>desktop</code>, <code>mobile</code>, <code>tablet</code>, <code>all</code><br>default value: <code>all</code>'
          nullable: true
        match:
          type: string
          description: <em>keywords match type</em><br>optional field<br>can take the following values:<br><code>aggregate</code> returns data across all match types;<br><code>broad</code> returns data for all user queries containing the specified keyword with varying word order;<br><code>phrase</code> returns data for all user queries containing the specified keyword with identical word order;<br><code>exact</code> returns data for user query that matches the specified keyword;<strong>Note:</strong> the <code>aggregate</code> match type is applied by default
          nullable: true
        location_name:
          type: string
          description: '<em>full name of search engine location</em><br><strong>required field if you don''t specify</strong> <code>location_code</code> or <code>location_coordinate</code><br><strong>if you use this field, you don''t need to specify <code>location_code</code> or <code>location_coordinate</code></strong><br>you can receive the list of available locations and languages by making a separate request to <code>https://api.dataforseo.com/v3/keywords_data/bing/keyword_performance/locations_and_languages</code><br>example:<br><code>"United States"</code>'
        location_code:
          type: integer
          description: '<em>search engine location code</em><br><strong>required field if you don''t specify</strong> <code>location_name</code> or <code>location_coordinate</code><br><strong>if you use this field, you don''t need to specify <code>location_name</code> or <code>location_coordinate</code></strong><br>you can receive the list of available locations and languages by making a separate request to <code>https://api.dataforseo.com/v3/keywords_data/bing/keyword_performance/locations_and_languages</code><br>example:<br><code>2840</code>'
        location_coordinate:
          type: string
          description: '<em>GPS coordinates of a location</em><br><strong>required field if you don''t specify</strong> <code>location_name</code> or <code>location_code</code><br><strong>if you use this field, you don''t need to specify <code>location_name</code> or <code>location_code</code></strong><br><code>location_coordinate</code> parameter should be specified in the <em>"latitude,longitude"</em> format<br><strong>the data will be provided for the country the specified coordinates belong to</strong><br>example:<br><code class="long-string">52.6178549,-155.352142</code>'
        language_name:
          type: string
          description: '<em>full name of search engine language</em><br><strong>required field if you don''t specify</strong> <code>language_code</code><br><strong>if you use this field, you don''t need to specify <code>language_code</code></strong><br>you can receive the list of available locations and languages by making a separate request to <code>https://api.dataforseo.com/v3/keywords_data/bing/keyword_performance/locations_and_languages</code><br>example:<br><code class="long-string">English</code>'
        language_code:
          type: string
          description: <em>search engine language code</em><br><strong>required field if you don't specify</strong> <code>language_name</code><br>you can receive the list of available locations and languages by making a separate request to <code>https://api.dataforseo.com/v3/keywords_data/bing/keyword_performance/locations_and_languages</code><br>example:<br><code>"en"</code>
        postback_url:
          type: string
          description: '<em>URL for sending task results</em><br>optional field<br>once the task is completed, we will send a POST request with its results compressed in the <code>gzip</code> format to the <code>postback_url</code> you specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/postbackscript?id=$id</code><br><code>http://your-server.com/postbackscript?id=$id&amp;tag=$tag</code><br><strong>Note:</strong> special characters in <code>postback_url</code> will be urlencoded;<br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href="https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api" target="_blank" rel="noopener noreferrer">Help Center</a>'
          nullable: true
        pingback_url:
          type: string
          description: '<em>notification URL of a completed task</em><br>optional field<br>when a task is completed we will notify you by GET request sent to the URL you have specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request<br>example:<br><code>http://your-server.com/pingscript?id=$id</code><br><code>http://your-server.com/pingscript?id=$id&amp;tag=$tag</code><br><strong>Note:</strong> special characters in <code>pingback_url</code> will be urlencoded;<br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href="https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api" target="_blank" rel="noopener noreferrer">Help Center</a>'
          nullable: true
        tag:
          type: string
          description: <em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response
          nullable: true
      example:
        - location_code: 2840
          language_code: en
          keywords:
            - dataforseo
            - seo
            - ranking
    KeywordsDataBingKeywordPerformanceTaskPostTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: object
              description: '<em>array of results</em><br>in this case, the value will be <code>null</code>'
              nullable: true
    KeywordsDataBingKeywordPerformanceTaskPostResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/KeywordsDataBingKeywordPerformanceTaskPostTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    KeywordsDataBingKeywordPerformanceTasksReadyResultInfo:
      type: object
      properties:
        id:
          type: string
          description: <em>task identifier of the completed task</em><br><strong>unique task identifier in our system in the <a href="https://en.wikipedia.org/wiki/Universally_unique_identifier">UUID</a> format</strong>
          nullable: true
        se:
          type: string
          description: <em>search engine specified when setting the task</em>
          nullable: true
        se_type:
          type: string
          nullable: true
        date_posted:
          type: string
          description: <em>date when the task was posted (in the UTC format)</em>
          nullable: true
        tag:
          type: string
          nullable: true
        endpoint:
          type: string
          description: <em>URL for collecting the results of the task</em>
          nullable: true
        function:
          type: string
          nullable: true
    KeywordsDataBingKeywordPerformanceTasksReadyTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/KeywordsDataBingKeywordPerformanceTasksReadyResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    KeywordsDataBingKeywordPerformanceTasksReadyResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/KeywordsDataBingKeywordPerformanceTasksReadyTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    KeywordKpiItemInfo:
      type: object
      properties:
        ad_position:
          type: string
          description: '<em>represents the position of the relevant ad in SERP</em><br>can take the following values:<br><code>FirstPage1</code>: The first ad to appear on the right side of the first search results page<br><code>FirstPage2</code>: The second ad to appear on the right side of the first search results page<br><code>FirstPage3</code>: The third ad to appear on the right side of the first search results page<br><code>FirstPage4</code>: The fourth ad to appear on the right side of the first search results page<br><code>FirstPage5</code>: The fifth ad to appear on the right side of the first search results page<br><code>FirstPage6</code>: The sixth ad to appear on the right side of the first search results page<br><code>FirstPage7</code>: The seventh ad to appear on the right side of the first search results page<br><code>FirstPage8</code>: The eighth ad to appear on the right side of the first search results page<br><code>FirstPage9</code>: The ninth ad to appear on the right side of the first search results page<br><code>FirstPage10</code>: The tenth ad to appear on the right side of the first search results page<br><code>MainLine1</code>: The first ad to appear at the top of the search results page<br><code>MainLine2</code>: The second ad to appear at the top of the search results page<br><code>MainLine3</code>: The third ad to appear at the top of the search results page<br><code>MainLine4</code>: The fourth ad to appear at the top of the search results page'
          nullable: true
        clicks:
          type: integer
          description: <em>ad clicks</em><br>the number of clicks that the keyword and match type generated during the last month
          nullable: true
        impressions:
          type: integer
          description: <em>ad impressions</em><br>the number of impressions that the keyword and match type generated during the last month
          nullable: true
        average_cpc:
          type: number
          description: '<em>average cost per click, USD</em><br>calculated by dividing the cost of all clicks by the number of clicks'
          format: double
          nullable: true
        ctr:
          type: number
          description: <em>click-through rate as a percentage</em><br>calculated by dividing the number of clicks by the number of impressions and multiplying the result by 100
          format: double
          nullable: true
        total_cost:
          type: number
          description: '<em>total cost of an ad, USD</em><br>the cost of using the specified keyword and match type during the last month'
          format: int64
          nullable: true
        average_bid:
          type: number
          description: <em>average bid of the keyword</em>
          format: double
          nullable: true
    KeywordKpi:
      type: object
      properties:
        desktop:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/KeywordKpiItemInfo'
            nullable: true
          description: '<em>keyword data aggregated for desktop devices</em><br>if there is no data, then the value is_<code>null</code>n'
          nullable: true
        mobile:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/KeywordKpiItemInfo'
            nullable: true
          description: '<em>keyword data aggregated for mobile devices</em><br>if there is no data, then the value is_<code>null</code>n'
          nullable: true
        tablet:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/KeywordKpiItemInfo'
            nullable: true
          description: '<em>keyword data aggregated for tablet devices</em><br>if there is no data, then the value is_<code>null</code>n'
          nullable: true
    KeywordsDataBingKeywordPerformanceTaskGetResultInfo:
      type: object
      properties:
        keyword:
          type: string
          description: <em>keyword in a POST array</em>
          nullable: true
        location_code:
          type: integer
          description: '<em>location code in a POST array</em><br>if there is no data, then the value is_<code>null</code>n'
          nullable: true
        language_code:
          type: string
          description: '<em>language code in a POST array</em><br>if there is no data, then the value is_<code>null</code>n'
          nullable: true
        year:
          type: integer
          description: <em>indicates the year for which the data is provided for</em><br>example:<br><code>2020</code><p>_ _ _ _ _ _ <code>month</code>n
          nullable: true
        month:
          type: integer
          nullable: true
        keyword_kpi:
          type: object
          oneOf:
            - $ref: '#/components/schemas/KeywordKpi'
          description: '<em>object containing keyword metrics</em><br>if there is no data, then the value is_<code>null</code>n'
          nullable: true
    KeywordsDataBingKeywordPerformanceTaskGetTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/KeywordsDataBingKeywordPerformanceTaskGetResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    KeywordsDataBingKeywordPerformanceTaskGetResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/KeywordsDataBingKeywordPerformanceTaskGetTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    KeywordsDataBingKeywordPerformanceLiveRequestInfo:
      type: object
      properties:
        keywords:
          type: array
          items:
            type: string
          description: '<em>keywords</em><br><strong>required field</strong><br>The maximum number of keywords you can specify: 1000<br>The maximum number of characters for each keyword: 80<br>The maximum number of words for each keyword phrase: 10<br>the specified keywords will be converted to lowercase, data will be provided in a separate array<p>learn more about rules and limitations of <code>keyword</code> and <code>keywords</code> fields in DataForSEO APIs in this <a href="https://dataforseo.com/help-center/rules-and-limitations-of-keyword-and-keywords-fields-in-dataforseo-apis" rel="noopener noreferrer" target="_blank">Help Center article</a>'
        device:
          type: string
          description: '<em>device type</em><br>optional field<br>specify this field if you want to get the data for a particular device typepossible values: <code>desktop</code>, <code>mobile</code>, <code>tablet</code>, <code>all</code><br>default value: <code>all</code>'
          nullable: true
        match:
          type: string
          description: <em>keywords match type</em><br>optional field<br>can take the following values:<br><code>aggregate</code> returns data across all match types;<br><code>broad</code> returns data for all user queries containing the specified keyword with varying word order;<br><code>phrase</code> returns data for all user queries containing the specified keyword with identical word order;<br><code>exact</code> returns data for user query that matches the specified keyword;<strong>Note:</strong> the <code>aggregate</code> match type is applied by default
          nullable: true
        location_name:
          type: string
          description: '<em>full name of search engine location</em><br><strong>required field if you don''t specify</strong> <code>location_code</code> or <code>location_coordinate</code><br><strong>if you use this field, you don''t need to specify <code>location_code</code> or <code>location_coordinate</code></strong><br>you can receive the list of available locations and languages by making a separate request to <code>https://api.dataforseo.com/v3/keywords_data/bing/keyword_performance/locations_and_languages</code><br>example:<br><code>"United States"</code>'
        location_code:
          type: integer
          description: '<em>search engine location code</em><br><strong>required field if you don''t specify</strong> <code>location_name</code> or <code>location_coordinate</code><br><strong>if you use this field, you don''t need to specify <code>location_name</code> or <code>location_coordinate</code></strong><br>you can receive the list of available locations and languages by making a separate request to <code>https://api.dataforseo.com/v3/keywords_data/bing/keyword_performance/locations_and_languages</code><br>example:<br><code>2840</code>'
        location_coordinate:
          type: string
          description: '<em>GPS coordinates of a location</em><br><strong>required field if you don''t specify</strong> <code>location_name</code> or <code>location_code</code><br><strong>if you use this field, you don''t need to specify <code>location_name</code> or <code>location_code</code></strong><br><code>location_coordinate</code> parameter should be specified in the <em>"latitude,longitude"</em> format<br><strong>the data will be provided for the country the specified coordinates belong to</strong><br>example:<br><code class="long-string">52.6178549,-155.352142</code>'
        language_name:
          type: string
          description: '<em>full name of search engine language</em><br><strong>required field if you don''t specify</strong> <code>language_code</code><br><strong>if you use this field, you don''t need to specify <code>language_code</code></strong><br>you can receive the list of available locations and languages by making a separate request to <code>https://api.dataforseo.com/v3/keywords_data/bing/keyword_performance/locations_and_languages</code><br>example:<br><code class="long-string">English</code>'
        language_code:
          type: string
          description: <em>search engine language code</em><br><strong>required field if you don't specify</strong> <code>language_name</code><br>you can receive the list of available locations and languages by making a separate request to <code>https://api.dataforseo.com/v3/keywords_data/bing/keyword_performance/locations_and_languages</code><br>example:<br><code>"en"</code>
        tag:
          type: string
          description: <em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response
          nullable: true
      example:
        - location_code: 2840
          language_code: en
          keywords:
            - dataforseo
            - seo
            - ranking
    KeywordsDataBingKeywordPerformanceLiveResultInfo:
      type: object
      properties:
        keyword:
          type: string
          description: <em>keyword in a POST array</em>
          nullable: true
        location_code:
          type: integer
          description: '<em>location code in a POST array</em><br>if there is no data, then the value is_<code>null</code>n'
          nullable: true
        language_code:
          type: string
          description: '<em>language code in a POST array</em><br>if there is no data, then the value is_<code>null</code>n'
          nullable: true
        year:
          type: integer
          description: <em>indicates the year for which the data is provided for</em><br>example:<br><code>2020</code>
          nullable: true
        month:
          type: integer
          description: <em>indicates the month for which the data is provided for</em><br>example:<br><code>10</code>
          nullable: true
        keyword_kpi:
          type: object
          oneOf:
            - $ref: '#/components/schemas/KeywordKpi'
          description: '<em>object containing keyword metrics</em><br>if there is no data, then the value is_<code>null</code>n'
          nullable: true
    KeywordsDataBingKeywordPerformanceLiveTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/KeywordsDataBingKeywordPerformanceLiveResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    KeywordsDataBingKeywordPerformanceLiveResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/KeywordsDataBingKeywordPerformanceLiveTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    KeywordsDataBingSearchVolumeHistoryLocationsAndLanguagesResultInfo:
      type: object
      properties:
        language_name:
          type: string
          description: <em>language name</em>
          nullable: true
        language_code:
          type: string
          description: <em>language code according to <a href="https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes" target="_blank" rel="noopener noreferrer">ISO 639-1</a></em>
          nullable: true
        available_locations:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/AvailableLocations'
            nullable: true
          description: <em>array of available locations for a certain language</em>
          nullable: true
    KeywordsDataBingSearchVolumeHistoryLocationsAndLanguagesTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/KeywordsDataBingSearchVolumeHistoryLocationsAndLanguagesResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    KeywordsDataBingSearchVolumeHistoryLocationsAndLanguagesResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/KeywordsDataBingSearchVolumeHistoryLocationsAndLanguagesTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    KeywordsDataBingSearchVolumeHistoryTaskPostRequestInfo:
      type: object
      properties:
        keywords:
          type: array
          items:
            type: string
          description: '<em>keywords</em><br><strong>required field</strong><br>The maximum number of keywords you can specify: 1000<br>The maximum number of characters for each keyword: 100<br>the specified keywords will be converted to lowercase, data will be provided in a separate array<p>learn more about rules and limitations of <code>keyword</code> and <code>keywords</code> fields in DataForSEO APIs in this <a href="https://dataforseo.com/help-center/rules-and-limitations-of-keyword-and-keywords-fields-in-dataforseo-apis" rel="noopener noreferrer" target="_blank">Help Center article</a>'
        location_name:
          type: string
          description: '<em>full name of search engine location</em><br><strong>required field if you don''t specify</strong> <code>location_code</code> or <code>location_coordinate</code><br><strong>if you use this field, you don''t need to specify <code>location_code</code> or <code>location_coordinate</code></strong><br>you can receive the list of available locations of the search engine with their <code>location_name</code> by making a separate request to <code>https://api.dataforseo.com/v3/keywords_data/bing/search_volume_history/locations_and_languages</code><br>example:<br><code class="long-string">London,England,United Kingdom</code>'
        location_code:
          type: integer
          description: '<em>search engine location code</em><br><strong>required field if you don''t specify</strong> <code>location_name</code> or <code>location_coordinate</code><br><strong>if you use this field, you don''t need to specify <code>location_name</code> or <code>location_coordinate</code></strong><br>you can receive the list of available locations of the search engines with their <code>location_code</code> by making a separate request to <code>https://api.dataforseo.com/v3/keywords_data/bing/search_volume_history/locations_and_languages</code><br>example:<br><code class="long-string">2840</code>'
        location_coordinate:
          type: string
          description: '<em>GPS coordinates of a location</em><br><strong>required field if you don''t specify</strong> <code>location_name</code> or <code>location_code</code><br><strong>if you use this field, you don''t need to specify <code>location_name</code> or <code>location_code</code></strong><br><code>location_coordinate</code> parameter should be specified in the <em>"latitude,longitude"</em> format<br><strong>the data will be provided for the country the specified coordinates belong to</strong><br>example:<br><code class="long-string">52.6178549,-155.352142</code>'
        language_name:
          type: string
          nullable: true
        language_code:
          type: string
          nullable: true
        device:
          type: array
          items:
            type: string
          description: '<em>device types</em><br>optional field<br>specify this field if you want to get the data for a particular device types<br>possible values: <code>mobile</code>, <code>desktop</code>, <code>tablet</code>, <code>non_smartphones</code><br>default value:  <code>["mobile", "desktop", "tablet", "non_smartphones"]</code>'
          nullable: true
        period:
          type: string
          description: '<em>aggregates the returned data to a certain time period</em><br>optional field<br>specify this field if you want to get the data in monthly, weekly or daily format<p>possible values: <code>monthly</code>, <code>weekly</code>, <code>daily</code><p><code>monthly</code> - returns data up to past 24 months<br><code>weekly</code> - returns data up to past 15 weeks<br><code>daily</code> - returns data up to past 45 days<p>default value:  <code>monthly</code>'
          nullable: true
        date_from:
          type: string
          description: '<em>starting date of the time range</em><br>optional field<br>minimum value: two years back from today’s date<br>if <a href="/v3/keywords_data/bing/status/" target="_blank" rel="noopener noreferrer">Status endpoint</a> returns <code>false</code> in the <code>actual_data</code> field, <code>date_from</code> can be set to the month before last and prior;<br>if <a href="/v3/keywords_data/bing/status/" target="_blank" rel="noopener noreferrer">Status endpoint</a> returns <code>true</code> in the <code>actual_data</code> field, <code>date_from</code> can be set to the last month and prior;<br>date format: <code>"yyyy-mm-dd"</code><br>example:<br><code>"2020-01-01"</code><p><strong>Note:</strong> we do not recommend using a custom time range<p><strong>Note 2:</strong> if <code>date_from</code> and <code>date_to</code> parameters are not specified, the data will be returned for the past 24 months<p>if you specify the <code>period</code> parameter:<p>with value <code>weekly</code>, you will get results for the past 15 weeks<br>with value <code>daily</code>, you will get results for the past 45 days'
          nullable: true
        date_to:
          type: string
          description: '<em>ending date of the time range</em><br>optional field<p>minimum value: two years back from today’s date;<br>maximum value: one day from today''s date;<br>date format: <code>"yyyy-mm-dd"</code><br>example:<br><code>"2020-03-15"</code><p><strong>Note:</strong> we do not recommend using a custom time range<p><strong>Note 2:</strong> if <code>date_from</code> and <code>date_to</code> parameters are not specified, the data will be returned for the past 24 months<p>if you specify the <code>period</code> parameter:<p>with value <code>weekly</code>, you will get results for the past 15 weeks<br>with value <code>daily</code>, you will get results for the past 45 days'
          nullable: true
        postback_url:
          type: string
          description: '<em>URL for sending task results</em><br>optional field<br>once the task is completed, we will send a POST request with its results compressed in the <code>gzip</code> format to the <code>postback_url</code> you specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/postbackscript?id=$id</code><br><code>http://your-server.com/postbackscript?id=$id&amp;tag=$tag</code><br><strong>Note:</strong> special characters in <code>postback_url</code> will be urlencoded;<br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href="https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api" target="_blank" rel="noopener noreferrer">Help Center</a>'
          nullable: true
        pingback_url:
          type: string
          description: '<em>notification URL of a completed task</em><br>optional field<br>when a task is completed we will notify you by GET request sent to the URL you have specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request<br>example:<br><code>http://your-server.com/pingscript?id=$id</code><br><code>http://your-server.com/pingscript?id=$id&amp;tag=$tag</code><br><strong>Note:</strong> special characters in <code>pingback_url</code> will be urlencoded;<br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href="https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api" target="_blank" rel="noopener noreferrer">Help Center</a>'
          nullable: true
        tag:
          type: string
          description: <em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response
          nullable: true
      example:
        - location_code: 2840
          language_code: en
          keywords:
            - 10 minute timer
    KeywordsDataBingSearchVolumeHistoryTaskPostTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: object
              description: '<em>array of results</em><br>in this case, the value will be <code>null</code>'
              nullable: true
    KeywordsDataBingSearchVolumeHistoryTaskPostResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/KeywordsDataBingSearchVolumeHistoryTaskPostTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    KeywordsDataBingSearchVolumeHistoryTasksReadyResultInfo:
      type: object
      properties:
        id:
          type: string
          description: <em>task identifier of the completed task</em><br><strong>unique task identifier in our system in the <a href="https://en.wikipedia.org/wiki/Universally_unique_identifier">UUID</a> format</strong>
          nullable: true
        se:
          type: string
          description: <em>search engine specified when setting the task</em>
          nullable: true
        se_type:
          type: string
          nullable: true
        date_posted:
          type: string
          description: <em>date when the task was posted (in the UTC format)</em>
          nullable: true
        tag:
          type: string
          nullable: true
        endpoint:
          type: string
          description: <em>URL for collecting the results of the task</em>
          nullable: true
    KeywordsDataBingSearchVolumeHistoryTasksReadyTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/KeywordsDataBingSearchVolumeHistoryTasksReadyResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    KeywordsDataBingSearchVolumeHistoryTasksReadyResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/KeywordsDataBingSearchVolumeHistoryTasksReadyTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    SearchVolumeHistoryItemInfo:
      type: object
      properties:
        year:
          type: integer
          description: <em>year</em>
          nullable: true
        month:
          type: integer
          description: <em>month</em>
          nullable: true
        day:
          type: integer
          description: <em>day of the month</em>
          nullable: true
        search_volume:
          type: integer
          description: <em>search volume rate</em>
          format: int64
          nullable: true
      description: "device type = desktop\ncontains historical search volume data for searches made from desktop devices"
    SearchVolumeHistorySearchInfo:
      type: object
      properties:
        desktop:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/SearchVolumeHistoryItemInfo'
            nullable: true
          description: <em>device type = <strong>desktop</strong></em><br>contains historical search volume data for searches made from desktop devices
          nullable: true
        non_smartphones:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/SearchVolumeHistoryItemInfo'
            nullable: true
          description: <em>device type = <strong>non-smartphones</strong></em><br>contains historical search volume data for searches made from feature phones (non-smartphone mobile devices)
          nullable: true
        mobile:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/SearchVolumeHistoryItemInfo'
            nullable: true
          description: <em>device type = <strong>mobile</strong></em><br>contains historical search volume data for searches made from mobile devices
          nullable: true
        tablet:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/SearchVolumeHistoryItemInfo'
            nullable: true
          description: <em>device type = <strong>tablet</strong></em><br>contains historical search volume data for searches made from tablets
          nullable: true
    KeywordsDataBingSearchVolumeHistoryTaskGetResultInfo:
      type: object
      properties:
        keyword:
          type: string
          description: <em>keyword in a POST array</em>
          nullable: true
        location_code:
          type: integer
          description: '<em>location code in a POST array</em><br>if there is no data, then the value is_<code>null</code>n'
          nullable: true
        language_code:
          type: string
          description: '<em>language code in a POST array</em><br>if there is no data, then the value is_<code>null</code>n'
          nullable: true
        device:
          type: array
          items:
            type: string
            nullable: true
          nullable: true
        period:
          type: string
          nullable: true
        searches:
          type: object
          oneOf:
            - $ref: '#/components/schemas/SearchVolumeHistorySearchInfo'
          nullable: true
    KeywordsDataBingSearchVolumeHistoryTaskGetTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/KeywordsDataBingSearchVolumeHistoryTaskGetResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    KeywordsDataBingSearchVolumeHistoryTaskGetResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/KeywordsDataBingSearchVolumeHistoryTaskGetTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    KeywordsDataBingSearchVolumeHistoryLiveRequestInfo:
      type: object
      properties:
        keywords:
          type: array
          items:
            type: string
          description: '<em>keywords</em><br><strong>required field</strong><br>The maximum number of keywords you can specify: 1000<br>The maximum number of characters for each keyword: 100<br>the specified keywords will be converted to lowercase, data will be provided in a separate arraylearn more about rules and limitations of <code>keyword</code> and <code>keywords</code> fields in DataForSEO APIs in this <a href="https://dataforseo.com/help-center/rules-and-limitations-of-keyword-and-keywords-fields-in-dataforseo-apis" target="_blank" rel="noopener noreferrer">Help Center article</a>'
        location_name:
          type: string
          description: '<em>full name of search engine location</em><br><strong>required field if you don''t specify</strong> <code>location_code</code> or <code>location_coordinate</code><br><strong>if you use this field, you don''t need to specify <code>location_code</code> or <code>location_coordinate</code></strong><br>you can receive the list of available locations of the search engine with their <code>location_name</code> by making a separate request to <code>https://api.dataforseo.com/v3/keywords_data/bing/search_volume_history/locations_and_languages</code><br>example:<br><code class="long-string">London,England,United Kingdom</code>'
        location_code:
          type: integer
          description: '<em>search engine location code</em><br><strong>required field if you don''t specify</strong> <code>location_name</code> or <code>location_coordinate</code><br><strong>if you use this field, you don''t need to specify <code>location_name</code> or <code>location_coordinate</code></strong><br>you can receive the list of available locations of the search engines with their <code>location_code</code> by making a separate request to <code>https://api.dataforseo.com/v3/keywords_data/bing/search_volume_history/locations_and_languages</code><br>example:<br><code class="long-string">2840</code>'
        location_coordinate:
          type: string
          description: '<em>GPS coordinates of a location</em><br><strong>required field if you don''t specify</strong> <code>location_name</code> or <code>location_code</code><br><strong>if you use this field, you don''t need to specify <code>location_name</code> or <code>location_code</code></strong><br><code>location_coordinate</code> parameter should be specified in the <em>"latitude,longitude"</em> format<br><strong>the data will be provided for the country the specified coordinates belong to</strong><br>example:<br><code class="long-string">52.6178549,-155.352142</code>'
        language_name:
          type: string
          description: '<em>full name of search engine language</em><br><strong>required field if you don''t specify</strong> <code>language_code</code><br>if you use this field, you don''t need to specify <code>language_code</code><br>you can receive the list of available languages of the search engines with their <code>language_code</code> by making a separate request to <code>https://api.dataforseo.com/v3/keywords_data/bing/search_volume_history/locations_and_languages</code>'
        language_code:
          type: string
          description: '<em>search engine language code</em><br><strong>required field if you don''t specify</strong> <code>language_name</code><br>if you use this field, you don''t need to specify <code>language_name</code><br>you can receive the list of available languages of the search engines with their <code>language_code</code> by making a separate request to <code>https://api.dataforseo.com/v3/keywords_data/bing/search_volume_history/locations_and_languages</code>'
        device:
          type: array
          items:
            type: string
          description: '<em>device types</em><br>optional field<br>specify this field if you want to get the data for a particular device types<br>possible values: <code>mobile</code>, <code>desktop</code>, <code>tablet</code>, <code>non_smartphones</code><br>default value: <code>["mobile", "desktop", "tablet", "non_smartphones"]</code>'
          nullable: true
        period:
          type: string
          description: '<em>aggregates the returned data to a certain time period</em><br>optional field<br>specify this field if you want to get the data in monthly, weekly or daily formatpossible values: <code>monthly</code>, <code>weekly</code>, <code>daily</code><p><code>monthly</code> - returns data up to past 24 months<br><code>weekly</code> - returns data up to past 15 weeks<br><code>daily</code> - returns data up to past 45 days<p>default value: <code>monthly</code>'
          nullable: true
        date_from:
          type: string
          description: '<em>starting date of the time range</em><br>optional field<br>minimum value: 24 months back from today’s date;<br>if <a href="/v3/keywords_data/bing/status/" target="_blank" rel="noopener noreferrer">Status endpoint</a> returns <code>false</code> in the <code>actual_data</code> field, <code>date_from</code> can be set to the month before last and prior;<br>if <a href="/v3/keywords_data/bing/status/" target="_blank" rel="noopener noreferrer">Status endpoint</a> returns <code>true</code> in the <code>actual_data</code> field, <code>date_from</code> can be set to the last month and prior;<p>date format: <code>"yyyy-mm-dd"</code><br>example:<br><code>"2020-01-01"</code><strong>Note:</strong> we do not recommend using a custom time range;<p><strong>Note 2:</strong> if <code>date_from</code> and <code>date_to</code> parameters are not specified, the data will be returned for the past 24 months;<p>if you specify the <code>period</code> parameter:<p>with value <code>weekly</code>, you will get results for the past 15 weeks;<br>with value <code>daily</code>, you will get results for the past 45 days'
          nullable: true
        date_to:
          type: string
          description: '<em>ending date of the time range</em><br>optional fieldminimum value: two years back from today’s date;<br>maximum value: one day from today''s date;<br>date format: <code>"yyyy-mm-dd"</code><br>example:<br><code>"2020-03-15"</code><p><strong>Note:</strong> we do not recommend using a custom time range<p><strong>Note 2:</strong> if <code>date_from</code> and <code>date_to</code> parameters are not specified, the data will be returned for the past 24 months<p>if you specify the <code>period</code> parameter:<p>with value <code>weekly</code>, you will get results for the past 15 weeks<br>with value <code>daily</code>, you will get results for the past 45 days'
          nullable: true
        tag:
          type: string
          description: <em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response
          nullable: true
      example:
        - location_code: 2840
          language_code: en
          keywords:
            - 10 minute timer
    KeywordsDataBingSearchVolumeHistoryLiveResultInfo:
      type: object
      properties:
        keyword:
          type: string
          description: <em>keyword in a POST array</em>
          nullable: true
        location_code:
          type: integer
          description: '<em>location code in a POST array</em><br>if there is no data, then the value is_<code>null</code>n'
          nullable: true
        language_code:
          type: string
          description: '<em>language code in a POST array</em><br>if there is no data, then the value is_<code>null</code>n'
          nullable: true
        device:
          type: array
          items:
            type: string
            nullable: true
          nullable: true
        period:
          type: string
          description: <em>time period</em><br>indicates if returned data is aggregated to a certain time period<br>default value <code>monthly</code>
          nullable: true
        searches:
          type: object
          oneOf:
            - $ref: '#/components/schemas/SearchVolumeHistorySearchInfo'
          description: '<em>contains results distributed by device type</em><br>if the <code>device</code> parameter is not specified, the data will be returned for all available device types'
          nullable: true
    KeywordsDataBingSearchVolumeHistoryLiveTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/KeywordsDataBingSearchVolumeHistoryLiveResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    KeywordsDataBingSearchVolumeHistoryLiveResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/KeywordsDataBingSearchVolumeHistoryLiveTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    KeywordsDataClickstreamDataLocationsAndLanguagesResultInfo:
      type: object
      properties:
        location_code:
          type: integer
          description: <em>location code</em>
          nullable: true
        location_name:
          type: string
          description: <em>full name of the location</em>
          nullable: true
        location_code_parent:
          type: string
          description: <em>the code of the superordinate location</em><br>the value will be <code>null</code> as <code>Country</code> is the only supported <code>location_type</code> for this API
          nullable: true
        country_iso_code:
          type: string
          description: <em>ISO country code of the location</em>
          nullable: true
        location_type:
          type: string
          description: <em>location type</em><br>possible values:<br><code>Country</code>
          nullable: true
        available_languages:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/AvailableLanguages'
            nullable: true
          description: <em>supported languages</em><br>contains the languages which are supported for a specific location
          nullable: true
    KeywordsDataClickstreamDataLocationsAndLanguagesTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/KeywordsDataClickstreamDataLocationsAndLanguagesResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    KeywordsDataClickstreamDataLocationsAndLanguagesResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/KeywordsDataClickstreamDataLocationsAndLanguagesTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    KeywordsDataClickstreamDataDataforseoSearchVolumeLiveRequestInfo:
      type: object
      properties:
        keywords:
          type: array
          items:
            type: string
          description: '<em>target keywords</em><br><strong>required field</strong><br>UTF-8 encoding<br>maximum number of keywords you can specify in this array: 1000<br>the keywords will be converted to lowercase format<p><strong>Note:</strong> certain symbols and characters (e.g., UTF symbols, emojis) are not allowed<br>to learn more about which symbols and characters can be used, please refer to <a href="https://dataforseo.com/help-center/using-symbols-in-keywords-when-setting-a-google-ads-task" target="_blank" rel="noopener noreferrer">this article</a><p>learn more about rules and limitations of <code>keyword</code> and <code>keywords</code> fields in DataForSEO APIs in this <a href="https://dataforseo.com/help-center/rules-and-limitations-of-keyword-and-keywords-fields-in-dataforseo-apis" rel="noopener noreferrer" target="_blank">Help Center article</a>'
        location_name:
          type: string
          description: <em>full name of search engine location</em><br><strong>required field if you don’t specify <code>location_code </code></strong><br>you can receive the list of available locations with <code>location_name</code> by making a separate request to <code>https://api.dataforseo.com/v3/keywords_data/clickstream_data/locations_and_languages</code><br>example:<br><code class="long-string">United Kingdom</code>
        location_code:
          type: integer
          description: '<em>search engine location code</em><br><strong>required field if you don’t specify <code>location_name</code></strong><br>if you use this field, you can receive the list of available locations with <code>location_code</code> by making a separate request to the <code>https://api.dataforseo.com/v3/keywords_data/clickstream_data/locations_and_languages</code><br>example:<br><code class="long-string">2826</code>'
        language_name:
          type: string
          description: <em>full name of search engine language</em><br><strong>required field if don’t specify <code>language_code</code></strong><br>you can receive the list of available languages with their <code>language_name</code> by making a separate request to the <code>https://api.dataforseo.com/v3/keywords_data/clickstream_data/locations_and_languages</code><br>example:<br><code class="long-string">English</code>
        language_code:
          type: string
          description: <em>search engine language code</em><br><strong>required field if don’t specify <code>language_name</code></strong><br>you can receive the list of available languages with their <code>language_code</code> by making a separate request to the <code>https://api.dataforseo.com/v3/keywords_data/clickstream_data/locations_and_languages</code><br>example:<br><code class="long-string">en</code>
        use_clickstream:
          type: boolean
          description: '<em>use clickstream data to provide results</em><br>optional field<br>if set to <code>true</code>, you will get DataForSEO search volume values based on clickstream data;<br>if set to <code>false</code>, Bing search volume data will be used to calculate DataForSEO search volume;<br>default value: <code>true</code>;<br><strong>Note:</strong> Bing search volume is available for locations provided in <a href="https://docs.dataforseo.com/v3/keywords_data/bing/search_volume_history/locations_and_languages/?bash" rel="noopener noreferrer" target="_blank">Bing Search Volume History Locations</a> and <a href="https://docs.dataforseo.com/v3/keywords_data/bing/locations/?bash" rel="noopener noreferrer" target="_blank">Bing Ads Locations</a> endpoints; search volume values for any other location are calculated based on clickstream data even if you set this parameter to <code>false</code>'
          nullable: true
        tag:
          type: string
          description: <em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response
          nullable: true
      example:
        - location_code: 2840
          language_code: en
          tag: test-tag
          keywords:
            - you tube
            - youtube
            - youtub
    KeywordsDataClickstreamDataSearchVolumeLiveItem:
      type: object
      properties:
        keyword:
          type: string
          description: <em>keyword provided in the POST array</em>
          nullable: true
        search_volume:
          type: integer
          description: <em>current search volume rate of a keyword</em>
          format: int64
          nullable: true
        monthly_searches:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/MonthlySearchesInfo'
            nullable: true
          description: <em>monthly search volume rates</em><br>array of objects with search volume rates in a certain month of a year
          nullable: true
    KeywordsDataClickstreamDataDataforseoSearchVolumeLiveResultInfo:
      type: object
      properties:
        location_code:
          type: integer
          description: '<em>location code in a POST array</em><br>if there is no data, then the value is <code>null</code>'
          nullable: true
        language_code:
          type: string
          description: '<em>language code in a POST array<br></em><br><strong>Note:</strong>if the keyword in the POST array appears to be misspelled, data will be returned for the correctly spelled keyword;<br>we use the functionality of Google Ads API to check and validate the spelling of keywords, <a href="https://support.google.com/google-ads/answer/7476658" target="_blank" rel="noopener noreferrer">learn more by this link</a>'
          nullable: true
        use_clickstream:
          type: boolean
          description: '<em>indicates if the <code>use_clickstream</code> parameter is active</em><br>possible values: <code>true</code>, <code>false</code>'
          nullable: true
        items_count:
          type: integer
          description: <em>ithe number of results returned in the <code>items</code> array</em>
          nullable: true
        items:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/KeywordsDataClickstreamDataSearchVolumeLiveItem'
            nullable: true
          description: <em>array of keywords</em><br>contains keywords and their search volume rates
          nullable: true
    KeywordsDataClickstreamDataDataforseoSearchVolumeLiveTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/KeywordsDataClickstreamDataDataforseoSearchVolumeLiveResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    KeywordsDataClickstreamDataDataforseoSearchVolumeLiveResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/KeywordsDataClickstreamDataDataforseoSearchVolumeLiveTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    KeywordsDataClickstreamDataGlobalSearchVolumeLiveRequestInfo:
      type: object
      properties:
        keywords:
          type: array
          items:
            type: string
          description: '<em>target keywords</em><br><strong>required field</strong><br>UTF-8 encoding<br>maximum number of keywords you can specify in this array: 1000;<br>each keyword should be at least 3 characters long;<br>the keywords will be converted to lowercase format;<br><strong>Note:</strong> certain symbols and characters (e.g., UTF symbols, emojis) are not allowed<br>to learn more about which symbols and characters can be used, please refer to <a href="https://dataforseo.com/help-center/using-symbols-in-keywords-when-setting-a-google-ads-task" target="_blank" rel="noopener noreferrer">this article</a><p>learn more about rules and limitations of <code>keyword</code> and <code>keywords</code> fields in DataForSEO APIs in this <a href="https://dataforseo.com/help-center/rules-and-limitations-of-keyword-and-keywords-fields-in-dataforseo-apis" rel="noopener noreferrer" target="_blank">Help Center article</a>'
        tag:
          type: string
          description: <em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response
          nullable: true
      example:
        - tag: test-tag
          keywords:
            - you tube
            - youtube
            - youtub
    CountryDistribution:
      type: object
      properties:
        country_iso_code:
          type: string
          description: <em>country ISO code</em>
          nullable: true
        search_volume:
          type: integer
          description: <em>clickstream-based average monthly search volume rate</em><br>represents the (approximate) number of searches for the given keyword idea based on clickstream<br>you can learn more about clickstream search volume in <a href="https://dataforseo.com/help-center/what-is-clickstream-search-volume-and-how-to-get-it-with-dataforseo">this Help Center article</a>
          format: int64
          nullable: true
        percentage:
          type: number
          description: <em>percentage of global search volume</em>
          nullable: true
    KeywordsDataClickstreamDataGlobalSearchVolumeLiveItem:
      type: object
      properties:
        keyword:
          type: string
          description: <em>keyword</em><br><strong>keyword is returned with decoded %## (plus symbol '+' will be decoded to a space character)</strong>
          nullable: true
        search_volume:
          type: integer
          description: <em>clickstream-based average monthly search volume rate</em><br>represents the (approximate) number of searches for the given keyword idea based on clickstream<br>you can learn more about clickstream search volume in <a href="https://dataforseo.com/help-center/what-is-clickstream-search-volume-and-how-to-get-it-with-dataforseo">this Help Center article</a>
          format: int64
          nullable: true
        country_distribution:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/CountryDistribution'
            nullable: true
          description: '<em>distribution of clickstream by countries</em><br>represents clickstream-based search volume in available countries, as well as its respective percentage of global search volume'
          nullable: true
    KeywordsDataClickstreamDataGlobalSearchVolumeLiveResultInfo:
      type: object
      properties:
        items_count:
          type: integer
          description: <em>the number of results returned in the <code>items</code> array</em>
          format: int64
          nullable: true
        items:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/KeywordsDataClickstreamDataGlobalSearchVolumeLiveItem'
            nullable: true
          description: <em>contains keywords and related data</em>
          nullable: true
    KeywordsDataClickstreamDataGlobalSearchVolumeLiveTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/KeywordsDataClickstreamDataGlobalSearchVolumeLiveResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    KeywordsDataClickstreamDataGlobalSearchVolumeLiveResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/KeywordsDataClickstreamDataGlobalSearchVolumeLiveTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    KeywordsDataClickstreamDataBulkSearchVolumeLiveRequestInfo:
      type: object
      properties:
        keywords:
          type: array
          items:
            type: string
          description: '<em>target keywords</em><br><strong>required field</strong><br>UTF-8 encoding<br>maximum number of keywords you can specify in this array: 1000;<br>each keyword should be at least 3 characters long;<br>the keywords will be converted to lowercase format;<br><strong>Note:</strong> certain symbols and characters (e.g., UTF symbols, emojis) are not allowed<br>to learn more about which symbols and characters can be used, please refer to <a href="https://dataforseo.com/help-center/using-symbols-in-keywords-when-setting-a-google-ads-task" target="_blank" rel="noopener noreferrer">this article</a><p>learn more about rules and limitations of <code>keyword</code> and <code>keywords</code> fields in DataForSEO APIs in this <a href="https://dataforseo.com/help-center/rules-and-limitations-of-keyword-and-keywords-fields-in-dataforseo-apis" rel="noopener noreferrer" target="_blank">Help Center article</a>'
        location_name:
          type: string
          description: <em>full name of the location</em><br><strong>required field if you don't specify</strong> <code>location_code</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_name</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/keywords_data/clickstream_data/locations_and_languages</code><br>example:<br><code class="long-string">United Kingdom</code>
        location_code:
          type: integer
          description: <em>location code</em><br><strong>required field if you don't specify</strong> <code>location_name</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_code</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/keywords_data/clickstream_data/locations_and_languages</code><br>example:<br><code class="long-string">2840</code>
        tag:
          type: string
          description: <em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response
          nullable: true
      example:
        - location_code: 2840
          tag: test-tag
          keywords:
            - you tube
            - youtube
            - youtub
    KeywordsDataClickstreamDataBulkSearchVolumeLiveResultInfo:
      type: object
      properties:
        location_code:
          type: integer
          description: <em>location code in a POST array</em>
          nullable: true
        items_count:
          type: integer
          description: <em>the number of results returned in the <code>items</code> array</em>
          format: int64
          nullable: true
        items:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/KeywordsDataClickstreamDataSearchVolumeLiveItem'
            nullable: true
          description: <em>contains keywords and related data</em>
          nullable: true
    KeywordsDataClickstreamDataBulkSearchVolumeLiveTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/KeywordsDataClickstreamDataBulkSearchVolumeLiveResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    KeywordsDataClickstreamDataBulkSearchVolumeLiveResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/KeywordsDataClickstreamDataBulkSearchVolumeLiveTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    BacklinksIdListRequestInfo:
      type: object
      properties:
        datetime_from:
          type: string
          description: '<em>start time for filtering results</em><br><strong>required field</strong><br>if <code>include_metadata</code> is set to <code>true</code>, maximum value: a month from current datetime;<br>if <code>include_metadata</code> is set to <code>false</code>, maximum value: six months from current datetime;<br>must be specified in the UTC format: "yyyy-mm-dd hh-mm-ss +00:00"<br>example:<br><code>2023-01-15 12:57:46 +00:00</code>'
        datetime_to:
          type: string
          description: '<em>finish time for filtering results</em><br><strong>required field</strong><br>maximum value: current datetime;<br>must be specified in the UTC format: "yyyy-mm-dd hh-mm-ss +00:00"<br>example:<br><code>2023-01-31 13:57:46 +00:00</code>'
        limit:
          type: integer
          description: '<em>the maximum number of returned task IDs</em><br>optional field<br>default value: <code>1000</code><br>maximum value: <code>1000</code>'
          nullable: true
        offset:
          type: integer
          description: '<em>offset in the results array of returned task IDs</em><br>optional field<br>default value: <code>0</code><br>if you specify the <code>10</code> value, the first ten tasks in the results array will be omitted'
          nullable: true
        sort:
          type: string
          description: '<em>sorting by task execution time</em><br>optional field<br>possible values: <code>"asc"</code>, <code>"desc"</code><br>default value: <code>"asc"</code>'
          nullable: true
        include_metadata:
          type: boolean
          description: '<em>include task metadata in the respond</em><br>optional field<br>default value: <code>false</code>'
          nullable: true
      example:
        - datetime_from: '2026-09-10 11:12:35'
          datetime_to: '2026-09-20 11:12:35'
          limit: 10
          include_metadata: true
    BacklinksIdListResultInfo:
      type: object
      properties:
        id:
          type: string
          description: <em>task identifier</em><br><strong>unique task identifier in our system in the <a href="https://en.wikipedia.org/wiki/Universally_unique_identifier">UUID</a> format</strong>
          nullable: true
        url:
          type: string
          description: <em>URL of the task</em><br>URL you used for making an API call
          nullable: true
        datetime_posted:
          type: string
          description: '<em>date and time when the task was made</em><br>in the UTC format: "yyyy-mm-dd hh-mm-ss +00:00"<br>example:<br><code>2023-01-15 12:57:46 +00:00</code>'
          nullable: true
        datetime_done:
          type: string
          description: '<em>date and time when the task was completed</em><br>in the UTC format: "yyyy-mm-dd hh-mm-ss +00:00"<br>example:<br><code>2023-01-15 12:57:46 +00:00</code>'
          nullable: true
        status:
          type: string
          description: <em>informational message of the task</em><br>you can find the full list of general informational messages <a href="/v3/appendix-errors/">here</a>
          nullable: true
        cost:
          type: number
          description: '<em>total tasks cost, USD</em>'
          nullable: true
        metadata:
          type: object
          additionalProperties:
            type: object
            nullable: true
          description: <em>contains parameters you specified in the POST request</em>
          nullable: true
    BacklinksIdListTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/BacklinksIdListResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    BacklinksIdListResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/BacklinksIdListTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    BacklinksErrorsRequestInfo:
      type: object
      properties:
        limit:
          type: integer
          description: '<em>the maximum number of returned tasks that responded with an error</em><br>optional field<br>default value: <code>1000</code><br>maximum value: <code>1000</code>'
          nullable: true
        offset:
          type: integer
          description: '<em>offset in the results array of returned tasks</em><br>optional field<br>default value: <code>0</code><br>if you specify the <code>10</code> value, the first ten tasks in the results array will be omitted and the data will be provided for the successive tasks'
          nullable: true
        filtered_function:
          type: string
          description: '<em>return tasks with a certain function</em><br>use this field to obtain a list of tasks that returned an error filtered by a certain function<br>you can filter the results by the values you receive in the <code>function</code> fields of the API response<br>i.e., once you receive unfiltered results, you can call this API again to filter them by <code>function</code> <br>example: <code>backlinks/live</code>'
          nullable: true
        datetime_from:
          type: string
          description: '<em>start time for filtering results</em><br>optional field<br>allows filtering results by the <code>datetime</code> parameter within the range of the last 7 days;<br>must be specified in the UTC format: "yyyy-mm-dd hh-mm-ss +00:00"<br>example:<br><code>2021-11-15 12:57:46 +00:00</code>'
          nullable: true
        datetime_to:
          type: string
          description: '<em>finish time for filtering results</em><br>optional field<br>allows filtering results by the <code>datetime</code> parameter within the range of the last 7 days;<br>must be specified in the UTC format: "yyyy-mm-dd hh-mm-ss +00:00"<br>example:<br><code>2021-11-15 13:57:46 +00:00</code>'
          nullable: true
      example:
        - limit: 10
    BacklinksErrorsResultInfo:
      type: object
      properties:
        id:
          type: string
          description: <em>task identifier</em><br><strong>unique task identifier in our system in the <a href="https://en.wikipedia.org/wiki/Universally_unique_identifier">UUID</a> format</strong>
          nullable: true
        datetime:
          type: string
          description: '<em>date and time when an error occurred</em><br>in the UTC format: "yyyy-mm-dd hh-mm-ss +00:00"<br>example:<br><code>2019-11-15 12:57:46 +00:00</code>'
          nullable: true
        function:
          type: string
          description: <em>corresponding API function</em>
          nullable: true
        error_code:
          type: integer
          description: <em>error code</em>
          nullable: true
        error_message:
          type: string
          description: <em>error message or error URL</em><br>error message <a href="https://docs.dataforseo.com/v3/appendix/errors/" rel="noopener noreferrer" target="_blank">(see full list)</a> or URL that caused an error
          nullable: true
        http_url:
          type: string
          description: <em>URL that caused an error</em><br>URL you used for making an API call
          nullable: true
        http_method:
          type: string
          description: <em>HTTP method</em>
          nullable: true
        http_code:
          type: integer
          description: <em>HTTP status code</em>
          nullable: true
        http_time:
          type: number
          description: <em>time taken by HTTP request</em>
          nullable: true
        http_response:
          type: string
          description: <em>HTTP response</em><br>server response
          nullable: true
    BacklinksErrorsTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/BacklinksErrorsResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    BacklinksErrorsResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/BacklinksErrorsTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    BacklinksAvailableFiltersResultInfo:
      type: object
      properties:
        content_duplicates:
          type: object
          additionalProperties:
            type: string
            nullable: true
          nullable: true
        backlinks:
          type: object
          additionalProperties:
            type: string
            nullable: true
          description: 'filters available for the backlinks endpoint:'
          nullable: true
        domain_pages:
          type: object
          additionalProperties:
            type: string
            nullable: true
          nullable: true
        anchors:
          type: object
          additionalProperties:
            type: string
            nullable: true
          nullable: true
        referring_domains:
          type: object
          additionalProperties:
            type: string
            nullable: true
          nullable: true
        domain_intersection:
          type: object
          additionalProperties:
            type: string
            nullable: true
          nullable: true
        page_intersection:
          type: object
          additionalProperties:
            type: string
            nullable: true
          description: 'filters available for the page intersection endpoint:'
          nullable: true
        referring_networks:
          type: object
          additionalProperties:
            type: string
            nullable: true
          nullable: true
        domain_pages_summary:
          type: object
          additionalProperties:
            type: string
            nullable: true
          nullable: true
        competitors:
          type: object
          additionalProperties:
            type: string
            nullable: true
          nullable: true
    BacklinksAvailableFiltersTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/BacklinksAvailableFiltersResultInfo'
                nullable: true
              nullable: true
    BacklinksAvailableFiltersResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/BacklinksAvailableFiltersTaskInfo'
                nullable: true
              nullable: true
    IndexHistory:
      type: object
      properties:
        date:
          type: string
          description: '<em>date for which index volume data is provided</em><br>in the UTC format: "yyyy-mm-dd"<br>example:<br><code>2021-10-01</code>'
          nullable: true
        total_backlinks:
          type: integer
          description: <em>total number of backlinks our database contained on the given <code>date</code></em>
          format: int64
          nullable: true
        total_pages:
          type: integer
          description: <em>total number of pages our database contained on the given <code>date</code></em>
          format: int64
          nullable: true
    BacklinksIndexResultInfo:
      type: object
      properties:
        total_backlinks:
          type: integer
          description: <em>total number of backlinks our database contains for the moment of checking</em>
          format: int64
          nullable: true
        total_pages:
          type: integer
          description: <em>total number of pages our database contains for the moment of checking</em>
          format: int64
          nullable: true
        index_history:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/IndexHistory'
            nullable: true
          description: <em>index volume data for the past 12 months</em>
          nullable: true
    BacklinksIndexTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/BacklinksIndexResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    BacklinksIndexResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/BacklinksIndexTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    BacklinksSummaryLiveRequestInfo:
      type: object
      properties:
        target:
          type: string
          description: '<em>domain, subdomain or webpage to get data for</em><br><strong>required field</strong><br>a domain or a subdomain should be specified without <code>https://</code> and <code>www.</code><br>a page should be specified with absolute URL (including <code>http://</code> or <code>https://</code>)'
        include_subdomains:
          type: boolean
          description: '<em>indicates if the subdomains of the <code>target</code> will be included in the search</em><br>optional field<br>if set to <code>false</code>, the subdomains will be ignored<br>default value: <code>true</code>'
          nullable: true
        include_indirect_links:
          type: boolean
          description: '<em>indicates if indirect links to the <code>target</code> will be included in the results</em><br>optional field<br>if set to <code>true</code>, the results will include data on indirect links pointing to a page that either redirects to the target, or points to a canonical page<br>if set to <code>false</code>, indirect links will be ignored<br>default value: <code>true</code>'
          nullable: true
        exclude_internal_backlinks:
          type: boolean
          description: '<em>indicates if internal backlinks from subdomains to the <code>target</code> will be excluded from the results</em><br>optional field<br>if set to <code>true</code>, the results will not include data on internal backlinks from subdomains of the same domain as <code>target</code><br>if set to <code>false</code>, internal links will be included in the results<br>default value: <code>true</code>'
          nullable: true
        internal_list_limit:
          type: integer
          description: '<em>maximum number of elements within internal arrays</em><br>optional field<br>you can use this field to limit the number of elements within the following arrays:<br><code>referring_links_tld</code><br><code>referring_links_types</code><br><code>referring_links_attributes</code><br><code>referring_links_platform_types</code><br><code>referring_links_semantic_locations</code><p>default value: <code>10</code><br>maximum value: <code>1000</code>'
          nullable: true
        backlinks_status_type:
          type: string
          description: '<em>set what backlinks to return and count</em><br>optional field<br>you can use this field to choose what backlinks will be returned and used for aggregated metrics for your <code>target</code>;<br>possible values: <br><code>all</code> - all backlinks will be returned and counted;<br><code>live</code> - backlinks found during the last check will be returned and counted;<br><code>lost</code> - lost backlinks will be returned and counted;<p>default value: <code>live</code>'
          nullable: true
        backlinks_filters:
          type: array
          items:
            type: object
            nullable: true
          description: '<em>filter the backlinks of your <code>target</code></em><br>optional field<br>you can use this field to filter the initial backlinks that will be included in the dataset for aggregated metrics for your <code>target</code><br>you can filter the backlinks by all fields available in the response of <a href="/v3/backlinks/backlinks/live">this endpoint</a><br>using this parameter, you can include only dofollow backlinks in the response and create a flexible backlinks dataset to calculate the metrics for<br>example:<br><code>"backlinks_filters": ["dofollow", "=", true]</code>'
          nullable: true
        rank_scale:
          type: string
          description: '<em>defines the scale used for calculating and displaying the <code>rank</code>, <code>domain_from_rank</code>, and <code>page_from_rank</code> values</em><br>optional field<p>you can use this parameter to choose whether rank values are presented on a 0–100 or 0–1000 scale<p>possible values:<br><code>one_hundred</code> — rank values are displayed on a 0–100 scale<br><code>one_thousand</code> — rank values are displayed on a 0–1000 scale<p>default value: <code>one_thousand</code><p>learn more about how this parameter works and how ranking metrics are calculated in <a href="https://dataforseo.com/help-center/what_is_rank_in_backlinks_api#rank_scale">this Help Center article</a>'
          nullable: true
        tag:
          type: string
          description: <em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response
          nullable: true
      example:
        - target: explodingtopics.com
          internal_list_limit: 10
          include_subdomains: true
          backlinks_filters:
            - dofollow
            - =
            - true
          backlinks_status_type: all
    TargetInfo:
      type: object
      properties:
        server:
          type: string
          description: <em>server</em>
          nullable: true
        cms:
          type: string
          description: <em>content management system</em>
          nullable: true
        platform_type:
          type: array
          items:
            type: string
            nullable: true
          description: <em>platform type</em>
          nullable: true
        ip_address:
          type: string
          description: <em>IP address of the <code>target</code></em>
          nullable: true
        country:
          type: string
          description: <em>country code that the <code>target</code> domain is determined to belong to</em>
          nullable: true
        is_ip:
          type: boolean
          description: '<em>indicates if the <code>target</code> is IP</em><br>if <code>true</code>, the domain, subdomain or webpage functions as an IP address and does not have a domain name'
          nullable: true
        target_spam_score:
          type: integer
          description: '<em>spam score of the <code>target</code></em><br>if the <code>target</code> is a domain/subdomain, this fields indicates the average spam score of all pages of that domain/subdomain;<br>learn more about how the metric is calculated on <a href="https://dataforseo.com/help-center/what-is-spam-score-and-how-is-it-calculated" rel="noopener noreferrer" target="_blank">this help center page</a>'
          nullable: true
    BacklinksSummaryLiveResultInfo:
      type: object
      properties:
        target:
          type: string
          description: <em><code>target</code> in a POST array</em>
          nullable: true
        first_seen:
          type: string
          description: '<em>date and time when our crawler found the backlink for the <code>target</code> for the first time</em><br>in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”<br>example:<br><code>2019-11-15 12:57:46 +00:00</code>'
          nullable: true
        lost_date:
          type: string
          description: '<em>date and time when the backlink was lost</em><br>indicates the date and time when our crawler visited the target and it responded with a 4xx or 5xx status code or when its last backlink was removed<br>in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”<br>example:<br><code>2019-11-15 12:57:46 +00:00</code>'
          nullable: true
        rank:
          type: integer
          description: <code>target</code> rank<br>learn more about the metric and how it is calculated in <a href="https://dataforseo.com/help-center/what_is_rank_in_backlinks_api" rel="noopener noreferrer" target="_blank">this help center article</a>
          nullable: true
        backlinks:
          type: integer
          description: <em>indicates the number of backlinks</em>
          format: int64
          nullable: true
        backlinks_spam_score:
          type: integer
          description: '<em>spam score of the backlinks</em><br>displays the total spam score of all backlinks pointing to the <code>target</code> domain, subdomain, or webpage;<br>to learn more about how the metric is calculated, refer to <a href="https://dataforseo.com/help-center/what-is-spam-score-and-how-is-it-calculated" rel="noopener noreferrer" target="_blank">this Help Center page</a>'
          format: int64
          nullable: true
        crawled_pages:
          type: integer
          description: <em>number of crawled pages for the <code>target</code></em>
          nullable: true
        info:
          type: object
          oneOf:
            - $ref: '#/components/schemas/TargetInfo'
          description: <em>information about the <code>target</code></em>
          nullable: true
        internal_links_count:
          type: integer
          description: <em>number of internal links</em><br>calculated as the sum of internal links on the pages of the specified <code>target</code>
          format: int64
          nullable: true
        external_links_count:
          type: integer
          description: <em>number of external links on the page</em><br>calculated as the sum of external links on the pages of the specified <code>target</code>
          format: int64
          nullable: true
        broken_backlinks:
          type: integer
          description: <em>number of broken backlinks</em><br>number of broken backlinks pointing to the <code>target</code>
          format: int64
          nullable: true
        broken_pages:
          type: integer
          description: '<em>number of broken pages</em><br>number of pages on the <code>target</code> that respond with 4xx or 5xx status codes<p>note that the number of broken pages includes pages on the <code>target</code> discovered by following external links, but it may also include pages discovered by following the target''s sitemap'
          nullable: true
        referring_domains:
          type: integer
          description: <em>indicates the number of referring domains</em><br>referring domains include subdomains that are counted as separate domains for this metric
          format: int64
          nullable: true
        referring_domains_nofollow:
          type: integer
          description: <em>number of domains pointing at least one nofollow link to the <code>target</code></em>
          format: int64
          nullable: true
        referring_main_domains:
          type: integer
          description: <em>indicates the number of referring main domains</em>
          format: int64
          nullable: true
        referring_main_domains_nofollow:
          type: integer
          description: <em>number of main domains pointing at least one nofollow link to the <code>target</code></em>
          format: int64
          nullable: true
        referring_ips:
          type: integer
          description: <em>number of referring IP addresses</em><br>number of IP addresses pointing to this page
          format: int64
          nullable: true
        referring_subnets:
          type: integer
          description: <em>number of referring subnetworks</em>
          format: int64
          nullable: true
        referring_pages:
          type: integer
          description: <em>indicates the number of pages pointing to the target</em>
          format: int64
          nullable: true
        referring_pages_nofollow:
          type: integer
          description: <em>number of referring pages pointing at least one nofollow link to the <code>target</code></em>
          format: int64
          nullable: true
        referring_links_tld:
          type: object
          additionalProperties:
            type: integer
            format: int64
            nullable: true
          description: <em>top-level domains of the referring links</em><br>contains top level domains and referring link count per each
          nullable: true
        referring_links_types:
          type: object
          additionalProperties:
            type: integer
            format: int64
            nullable: true
          description: '<em>types of referring links</em><br>indicates the types of the referring links and link count per each type<br>possible values:<br><code>anchor</code>, <code>image</code>, <code>link</code>, <code>meta</code>, <code>canonical</code>, <code>alternate</code>, <code>redirect</code>'
          nullable: true
        referring_links_attributes:
          type: object
          additionalProperties:
            type: integer
            format: int64
            nullable: true
          description: '<em>link attributes of the referring links</em><br>indicates link attributes of the referring links and link count per each attribute<br>example values:<br><code>nofollow</code>, <code>noopener</code>, <code>noreferrer</code>, <code>external</code>, <code>ugc</code>, <code>sponsored</code>'
          nullable: true
        referring_links_platform_types:
          type: object
          additionalProperties:
            type: integer
            format: int64
            nullable: true
          description: '<em>types of referring platforms</em><br>indicates referring platform types and and link count per each platform<p>possible values: <code>cms</code>, <code>blogs</code>, <code>ecommerce</code>, <code>message-boards</code>, <code>wikis</code>, <code>news</code>, <code>organization</code>'
          nullable: true
        referring_links_semantic_locations:
          type: object
          additionalProperties:
            type: integer
            format: int64
            nullable: true
          description: '<em>semantic locations of the referring links</em><br>indicates semantic elements in HTML where the referring links are located and link count per each semantic location<p>you can get the full list of semantic elements <a href="https://www.w3schools.com/html/html5_semantic_elements.asp" target="_blank" rel="noopener noreferrer">here</a><br>example values:<br><code>article</code>, <code>section</code>, <code>summary</code>, <code>""</code>'
          nullable: true
        referring_links_countries:
          type: object
          additionalProperties:
            type: integer
            format: int64
            nullable: true
          description: <em>ISO country codes of the referring links</em><br>indicates ISO country codes of the domains where the referring links are located and the link count per each country
          nullable: true
    BacklinksSummaryLiveTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/BacklinksSummaryLiveResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    BacklinksSummaryLiveResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/BacklinksSummaryLiveTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    BacklinksHistoryLiveRequestInfo:
      type: object
      properties:
        target:
          type: string
          description: <em>domain</em><br><strong>required field</strong><br>a domain should be specified without <code>https://</code> and <code>www.</code>
        date_from:
          type: string
          description: '<em>starting date of the time range</em><br>optional field<br>minimum value <code>2019-01-01</code><br>if you don''t specify this field, the minimum value will be used by default<br>date format: <code>"yyyy-mm-dd"</code><br>example:<br><code>"2019-01-15"</code>'
          nullable: true
        date_to:
          type: string
          description: '<em>ending date of the time range</em><br>optional field<br>if you don''t specify this field, the today''s date will be used by default<br>date format: <code>"yyyy-mm-dd"</code><br>example:<br><code>"2019-01-15"</code>'
          nullable: true
        rank_scale:
          type: string
          description: '<em>defines the scale used for calculating and displaying the <code>rank</code>, <code>domain_from_rank</code>, and <code>page_from_rank</code> values</em><br>optional field<p>you can use this parameter to choose whether rank values are presented on a 0–100 or 0–1000 scale<p>possible values:<br><code>one_hundred</code> — rank values are displayed on a 0–100 scale<br><code>one_thousand</code> — rank values are displayed on a 0–1000 scale<p>default value: <code>one_thousand</code><p>learn more about how this parameter works and how ranking metrics are calculated in <a href="https://dataforseo.com/help-center/what_is_rank_in_backlinks_api#rank_scale">this Help Center article</a>'
          nullable: true
        tag:
          type: string
          description: <em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response
          nullable: true
      example:
        - target: cnn.com
          date_from: '2020-01-01'
          date_to: '2021-01-01'
    BacklinksHistoryLiveItem:
      type: object
      properties:
        type:
          type: string
          description: type of element
          nullable: true
        date:
          type: string
          description: '<em>date and time when the data for the target was stored</em><br>in the UTC format: "yyyy-mm-dd hh-mm-ss +00:00"<br>example:<br><code>2019-11-15 12:57:46 +00:00</code>'
          nullable: true
        rank:
          type: integer
          description: <em>domain rank on the given <code>date</code></em><br>learn more about the metric and how it is calculated in <a href="https://dataforseo.com/help-center/what_is_rank_in_backlinks_api" rel="noopener noreferrer" target="_blank">this help center article</a>
          nullable: true
        backlinks:
          type: integer
          description: <em>number of backlinks</em>
          format: int64
          nullable: true
        new_backlinks:
          type: integer
          description: '<em>number of new backlinks for the <code>target</code></em><br>data is provided based in a comparison with the previous period<br><strong>Note:</strong> this data is available from May 2021;<br>if the date range specified in the POST request precedes May 2021, the field will equal <code>0</code>'
          format: int64
          nullable: true
        lost_backlinks:
          type: integer
          description: '<em>number of lost backlinks for the <code>target</code></em><br>data is provided based in a comparison with the previous period<br><strong>Note:</strong> this data is available from May 2021;<br>if the date range specified in the POST request precedes May 2021, the field will equal <code>0</code>'
          format: int64
          nullable: true
        new_referring_domains:
          type: integer
          description: '<em>number of new referring domains for the <code>target</code></em><br>data is provided based in a comparison with the previous period<br><strong>Note:</strong> this data is available from May 2021;<br>if the date range specified in the POST request precedes May 2021, the field will equal <code>0</code>'
          format: int64
          nullable: true
        lost_referring_domains:
          type: integer
          description: '<em>number of lost referring domains for the <code>target</code></em><br>data is provided based in a comparison with the previous period<br><strong>Note:</strong> this data is available from May 2021;<br>if the date range specified in the POST request precedes May 2021, the field will equal <code>0</code>'
          format: int64
          nullable: true
        crawled_pages:
          type: integer
          description: <em>number of crawled pages for the <code>target</code></em>
          nullable: true
        info:
          type: object
          oneOf:
            - $ref: '#/components/schemas/TargetInfo'
          description: <em>information about the <code>target</code></em>
          nullable: true
        internal_links_count:
          type: integer
          description: <em>number of internal links</em><br>calculated as the sum of internal links on the pages of the specified <code>target</code>
          format: int64
          nullable: true
        external_links_count:
          type: integer
          description: <em>number of external links on the page</em><br>calculated as the sum of external links on the pages of the specified <code>target</code>
          format: int64
          nullable: true
        broken_backlinks:
          type: integer
          description: <em>number of broken backlinks</em><br>number of broken backlinks pointing to the <code>target</code>
          format: int64
          nullable: true
        broken_pages:
          type: integer
          description: <em>number of broken pages</em><br>number of pages that receive backlinks but respond with 4xx or 5xx status codes
          nullable: true
        referring_domains:
          type: integer
          description: <em>number of referring domains</em><br>referring domains include subdomains that are counted as separate domains for this metric
          format: int64
          nullable: true
        referring_domains_nofollow:
          type: integer
          description: <em>number of domains pointing at least one nofollow link to the <code>target</code></em>
          format: int64
          nullable: true
        referring_main_domains:
          type: integer
          description: <em>number of referring main domains</em>
          format: int64
          nullable: true
        referring_main_domains_nofollow:
          type: integer
          description: <em>number of main domains pointing at least one nofollow link to the <code>target</code></em>
          format: int64
          nullable: true
        referring_ips:
          type: integer
          description: <em>number of referring IP addresses</em><br>number of IP addresses pointing to this page
          format: int64
          nullable: true
        referring_subnets:
          type: integer
          description: <em>number of referring subnetworks</em>
          format: int64
          nullable: true
        referring_pages:
          type: integer
          description: <em>number of pages pointing to the <code>target</code></em>
          format: int64
          nullable: true
        referring_pages_nofollow:
          type: integer
          description: <em>number of referring pages pointing at least one nofollow link to the <code>target</code></em>
          format: int64
          nullable: true
        referring_links_tld:
          type: object
          additionalProperties:
            type: integer
            format: int64
            nullable: true
          description: <em>top-level domains of the referring links</em><br>contains top-level domains and referring link count per each
          nullable: true
        referring_links_types:
          type: object
          additionalProperties:
            type: integer
            format: int64
            nullable: true
          description: '<em>types of referring links</em><br>indicates the types of the referring links and link count per each type<br>possible values:<br><code>anchor</code>, <code>image</code>, <code>link</code>, <code>meta</code>, <code>canonical</code>, <code>alternate</code>, <code>redirect</code>'
          nullable: true
        referring_links_attributes:
          type: object
          additionalProperties:
            type: integer
            format: int64
            nullable: true
          description: <em>link attributes of the referring links</em><br>indicates link attributes of the referring links and link count per each attribute
          nullable: true
        referring_links_platform_types:
          type: object
          additionalProperties:
            type: integer
            format: int64
            nullable: true
          description: '<em>types of referring platforms</em><br>indicates referring platform types and and link count per each platform<p>possible values: <code>cms</code>, <code>blogs</code>, <code>ecommerce</code>, <code>message-boards</code>, <code>wikis</code>, <code>news</code>, <code>organization</code>'
          nullable: true
        referring_links_semantic_locations:
          type: object
          additionalProperties:
            type: integer
            format: int64
            nullable: true
          description: '<em>semantic locations of the referring links</em><br>indicates semantic elements in HTML where the referring links are located and link count per each semantic location<br>you can get the full list of semantic elements <a href="https://www.w3schools.com/html/html5_semantic_elements.asp" target="_blank" rel="noopener noreferrer">here</a><br>examples:<br><code>article</code>, <code>section</code>, <code>summary</code>'
          nullable: true
        referring_links_countries:
          type: object
          additionalProperties:
            type: integer
            format: int64
            nullable: true
          description: <em>ISO country codes of the referring links</em><br>indicates ISO country codes of the domains where the referring links are located and the link count per each country
          nullable: true
    BacklinksHistoryLiveResultInfo:
      type: object
      properties:
        target:
          type: string
          description: <em><code>target</code> from the POST array</em>
          nullable: true
        date_from:
          type: string
          description: '<em>starting date of the time range</em><br>in the UTC format: “yyyy-mm-dd”<br>example:<br><code>2019-01-01</code>'
          nullable: true
        date_to:
          type: string
          description: '<em>ending date of the time range</em><br>in the UTC format: <code>"yyyy-mm-dd"</code><br>example:<br><code>"2019-01-15"</code>'
          nullable: true
        items_count:
          type: integer
          description: <em>the number of results returned in the <code>items</code> array</em>
          format: int64
          nullable: true
        items:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/BacklinksHistoryLiveItem'
            nullable: true
          description: <em>contains historical backlink data for the specified domain</em><br>the data is provided month-by-month;<br>the metrics are aggregated according to the backlinks the specified domain had on the first day of each given month
          nullable: true
    BacklinksHistoryLiveTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/BacklinksHistoryLiveResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    BacklinksHistoryLiveResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/BacklinksHistoryLiveTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    BacklinksBacklinksLiveRequestInfo:
      type: object
      properties:
        target:
          type: string
          description: '<em>domain, subdomain or webpage to get backlinks for</em><br><strong>required field</strong><br>a domain or a subdomain should be specified without <code>https://</code> and <code>www.</code><br>a page should be specified with absolute URL (including <code>http://</code> or <code>https://</code>)'
        mode:
          type: string
          description: '<em>results grouping type</em><br>optional field<br>possible grouping types:<br><code>as_is</code> - returns all backlinks<br><code>one_per_domain</code> - returns one backlink per domain<br><code>one_per_anchor</code> - returns one backlink per anchor<p>default value: <code>as_is</code>'
          nullable: true
        custom_mode:
          type: object
          additionalProperties:
            type: object
            nullable: true
          description: '<em>detailed results grouping type</em><br>optional field<br>use this object to get a specific number of backlinks per <code>field</code><br>if you use <code>custom_mode</code>, then <code>mode</code> will be ignored<br>example:<br><code>"custom_mode": {"field": "domain", "value": 100}</code>'
          nullable: true
        filters:
          type: array
          items:
            type: object
            nullable: true
          description: '<em>array of results filtering parameters</em><br>optional field<br><strong>you can add several filters at once (8 filters maximum)</strong><br>you should set a logical operator <code>and</code>, <code>or</code> between the conditions<br>the following operators are supported:<br><code>=</code>, <code>&lt;&gt;</code>, <code>in</code>, <code>not_in</code>, <code>like</code>, <code>not_like</code>, <code>ilike</code>, <code>not_ilike</code>, <code>regex</code>, <code>not_regex</code>, <code>match</code>, <code>not_match</code><br>you can use the <code>%</code> operator with <code>like</code> and <code>not_like</code> to match any string of zero or more characters<br>example:<br><code>["rank","&gt;","80"]</code><p><code>[["page_from_rank","&gt;","55"],<br>"and",<br>["dofollow","=",true]]</code><p><code>[["first_seen",">","2017-10-23 11:31:45 +00:00"],<br>"and",<br>[["anchor","like","%seo%"],"or",["text_pre","like","%seo%"]]]</code><p>The full list of possible filters is available <a href="/v3/backlinks/filters/?bash" rel="noopener noreferrer" target="_blank">here.</a>'
          nullable: true
        order_by:
          type: array
          items:
            type: string
          description: '<em>results sorting rules</em><br>optional field<br>you can use the same values as in the <code>filters</code> array to sort the results<br>possible sorting types:<br><code>asc</code> - results will be sorted in the ascending order<br><code>desc</code> - results will be sorted in the descending order<br>you should use a comma to set up a sorting type<br>example:<br><code>["rank,desc"]</code><br><strong>note that you can set no more than three sorting rules in a single request</strong><br>you should use a comma to separate several sorting rules<br>example:<br><code>["domain_from_rank,desc","page_from_rank,asc"]</code>'
          nullable: true
        offset:
          type: integer
          description: '<em>offset in the results array of the returned backlinks</em><br>optional field<p>default value: <code>0</code><br>if you specify the <code>10</code> value, the first ten backlinks in the results array will be omitted and the data will be provided for the successive backlinks;<br><strong>Note:</strong> the maximum value is <code>20,000</code>, use the <code>search_after_token</code> if you would like to offset more results'
          nullable: true
        search_after_token:
          type: string
          description: '<em>token for subsequent requests</em><br>optional field<br>provided in the identical filed of the response to each request;<br>use this parameter to avoid timeouts while trying to obtain over <code>20,000</code> results in a single request;<br>by specifying the unique <code>search_after_token</code> value from the response array, you will get the subsequent results of the initial task;<br><code>search_after_token</code> values are unique for each subsequent task ;<br><strong>Note:</strong> if the <code>search_after_token</code> is specified in the request, all other parameters should be identical to the previous request'
          nullable: true
        limit:
          type: integer
          description: '<em>the maximum number of returned backlinks</em><br>optional field<p>default value: <code>100</code><br>maximum value: <code>1000</code>'
          nullable: true
        backlinks_status_type:
          type: string
          description: '<em>set what backlinks to return and count</em><br>optional field<br>you can use this field to choose what backlinks will be returned and used for aggregated metrics for your <code>target</code>;<br>possible values: <br><code>all</code> - all backlinks will be returned and counted;<br><code>live</code> - backlinks found during the last check will be returned and counted;<br><code>lost</code> - lost backlinks will be returned and counted;<p>default value: <code>live</code>'
          nullable: true
        include_subdomains:
          type: boolean
          description: '<em>indicates if the subdomains of the <code>target</code> will be included in the search</em><br>optional field<br>if set to <code>false</code>, the subdomains will be ignored<br>default value: <code>true</code>'
          nullable: true
        exclude_internal_backlinks:
          type: boolean
          description: '<em>indicates if internal backlinks from subdomains to the <code>target</code> will be excluded from the results</em><br>optional field<br>if set to <code>true</code>, the results will not include data on internal backlinks from subdomains of the same domain as <code>target</code><br>if set to <code>false</code>, internal links will be included in the results<br>default value: <code>true</code>'
          nullable: true
        rank_scale:
          type: string
          description: '<em>defines the scale used for calculating and displaying the <code>rank</code>, <code>domain_from_rank</code>, and <code>page_from_rank</code> values</em><br>optional field<p>you can use this parameter to choose whether rank values are presented on a 0–100 or 0–1000 scale<p>possible values:<br><code>one_hundred</code> — rank values are displayed on a 0–100 scale<br><code>one_thousand</code> — rank values are displayed on a 0–1000 scale<p>default value: <code>one_thousand</code><p>learn more about how this parameter works and how ranking metrics are calculated in <a href="https://dataforseo.com/help-center/what_is_rank_in_backlinks_api#rank_scale">this Help Center article</a>'
          nullable: true
        tag:
          type: string
          description: <em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response
          nullable: true
      example:
        - target: forbes.com
          mode: as_is
          filters:
            - dofollow
            - =
            - true
          limit: 5
    RankedKeywordsInfo:
      type: object
      properties:
        page_from_keywords_count_top_3:
          type: integer
          format: int64
          nullable: true
        page_from_keywords_count_top_10:
          type: integer
          format: int64
          nullable: true
        page_from_keywords_count_top_100:
          type: integer
          format: int64
          nullable: true
    BacklinksRedirectInfo:
      type: object
      properties:
        type:
          type: string
          description: type of element
          nullable: true
        status_code:
          type: integer
          description: <i>general status code</i><br>you can find the full list of the response codes <a href="/v3/appendix/errors">here</a><br><strong>Note:</strong> we strongly recommend designing a necessary system for handling related exceptional or error conditions
          nullable: true
        url:
          type: string
          description: <em>indirect link URL</em>
          nullable: true
    BacklinksBacklinksLiveItem:
      type: object
      properties:
        type:
          type: string
          description: type of element
          nullable: true
        domain_from:
          type: string
          description: <em>domain referring to the target domain or webpage</em>
          nullable: true
        url_from:
          type: string
          description: <em>URL of the page where the backlink is found</em>
          nullable: true
        url_from_https:
          type: boolean
          description: '<em>indicates whether the referring URL is secured with HTTPS</em><br>if <code>true</code>, the referring URL is secured with HTTPS'
          nullable: true
        domain_to:
          type: string
          description: <em>domain the backlink is pointing to</em>
          nullable: true
        url_to:
          type: string
          description: <em>URL the backlink is pointing to</em>
          nullable: true
        url_to_https:
          type: boolean
          description: '<em>indicates if the URL the backlink is pointing to is secured with HTTPS</em><br>if <code>true</code>, the URL is secured with HTTPS'
          nullable: true
        tld_from:
          type: string
          description: <em>top-level domain of the referring URL</em>
          nullable: true
        is_new:
          type: boolean
          description: '<em>indicates whether the backlink is new</em><br>if <code>true</code>, the backlink was found on the page last time our crawler visited it'
          nullable: true
        is_lost:
          type: boolean
          description: '<em>indicates whether the backlink was removed</em><br>if <code>true</code>, the backlink or the entire page was removed'
          nullable: true
        backlink_spam_score:
          type: integer
          description: <em>spam score of the backlink</em><br>learn more about how the metric is calculated on <a href="https://dataforseo.com/help-center/what-is-spam-score-and-how-is-it-calculated" rel="noopener noreferrer" target="_blank">this help center page</a>
          nullable: true
        rank:
          type: integer
          description: <em>backlink rank</em><br>rank that the given backlink passes to the <code>target</code><br><code>rank</code> is calculated based on the method for node ranking in a linked database - a principle used in the original Google PageRank algorithm<br>learn more about the metric and how it is calculated in <a href="https://dataforseo.com/help-center/what_is_rank_in_backlinks_api" rel="noopener noreferrer" target="_blank">this help center article</a>
          nullable: true
        page_from_rank:
          type: integer
          description: <em>page rank of the referring page</em><br><code>page_from_rank</code> is calculated based on the method for node ranking in a linked database - a principle used in the original Google PageRank algorithm<br>learn more about the metric and how it is calculated in <a href="https://dataforseo.com/help-center/what_is_rank_in_backlinks_api" rel="noopener noreferrer" target="_blank">this help center article</a>
          nullable: true
        domain_from_rank:
          type: integer
          description: <em>domain rank of the referring domain</em><br><code>domain_from_rank</code> is calculated based on the method for node ranking in a linked database - a principle used in the original Google PageRank algorithm<br>learn more about the metric and how it is calculated in <a href="https://dataforseo.com/help-center/what_is_rank_in_backlinks_api" rel="noopener noreferrer" target="_blank">this help center article</a>
          nullable: true
        domain_from_platform_type:
          type: array
          items:
            type: string
            nullable: true
          description: '<em>platform types of the referring domain</em><p>possible values: <code>cms</code>, <code>blogs</code>, <code>ecommerce</code>, <code>message-boards</code>, <code>wikis</code>, <code>news</code>, <code>organization</code>'
          nullable: true
        domain_from_is_ip:
          type: boolean
          description: '<em>indicates if the domain is IP</em><br>if <code>true</code>, the domain functions as an IP address and does not have a domain name'
          nullable: true
        domain_from_ip:
          type: string
          description: <em>IP address of the referring domain</em>
          nullable: true
        domain_from_country:
          type: string
          description: <em>ISO country code of the referring domain</em>
          nullable: true
        page_from_external_links:
          type: integer
          description: <em>number of external links found on the referring page</em>
          nullable: true
        page_from_internal_links:
          type: integer
          description: <em>number of internal links found on the referring page</em>
          nullable: true
        page_from_size:
          type: integer
          description: '<em>size of the referring page, in bytes</em><br>example:<br><code>63357</code>'
          nullable: true
        page_from_encoding:
          type: string
          description: <em>character encoding of the referring page</em><br>example:<br><code>utf-8</code>
          nullable: true
        page_from_language:
          type: string
          description: <em>language of the referring page</em><br>in ISO 639-1 format<br>example:<br><code>en</code>
          nullable: true
        page_from_title:
          type: string
          description: <em>title of the referring page</em>
          nullable: true
        page_from_status_code:
          type: integer
          description: <em>HTTP status code returned by the referring page</em><br>example:<br><code>200</code>
          nullable: true
        first_seen:
          type: string
          description: '<em>date and time when our crawler found the backlink for the first time</em><br>in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”<br>example:<br><code>2019-11-15 12:57:46 +00:00</code>'
          nullable: true
        prev_seen:
          type: string
          description: '<em>previous to the most recent date when our crawler visited the backlink</em><br>in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”<br>example:<br><code>2019-11-15 12:57:46 +00:00</code>'
          nullable: true
        last_seen:
          type: string
          description: '<em>most recent date when our crawler visited the backlink</em><br>in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”<br>example:<br><code>2019-11-15 12:57:46 +00:00</code>'
          nullable: true
        item_type:
          type: string
          description: '<em>link type</em><br>possible values:<br><code>anchor</code>, <code>image</code>, <code>meta</code>, <code>canonical</code>, <code>alternate</code>, <code>redirect</code>'
          nullable: true
        attributes:
          type: array
          items:
            type: string
            nullable: true
          description: <em>link attributes of the referring links</em><br>example:<br><code>nofollow</code>
          nullable: true
        dofollow:
          type: boolean
          description: '<em>indicates whether the backlink is dofollow</em><br>if <code>false</code>, the backlink is nofollow'
          nullable: true
        original:
          type: boolean
          description: <em>indicates whether the backlink was present on the referring page when our crawler first visited it</em>
          nullable: true
        alt:
          type: string
          description: <em>alternative text of the image</em><br>this field will be <code>null</code> if backlink <code>type</code> is not image
          nullable: true
        image_url:
          type: string
          description: <em>URL of the image</em><br>the URL leading to the image on the original resource or DataForSEO storage (in case the original source is not available)
          nullable: true
        anchor:
          type: string
          description: <em>anchor text of the backlink</em>
          nullable: true
        text_pre:
          type: string
          description: <em>snippet before the anchor text</em>
          nullable: true
        text_post:
          type: string
          description: <em>snippet after the anchor text</em>
          nullable: true
        semantic_location:
          type: string
          description: '<em>indicates semantic element in HTML where the backlink is found</em><br>you can get the full list of semantic elements <a href="https://www.w3schools.com/html/html5_semantic_elements.asp" target="_blank" rel="noopener noreferrer">here</a><br>examples:<br><code>article</code>, <code>section</code>, <code>summary</code>'
          nullable: true
        links_count:
          type: integer
          description: <em>number of identical backlinks found on the referring page</em>
          format: int64
          nullable: true
        group_count:
          type: integer
          description: '<em>indicates total number of backlinks from this domain</em><br>for example, if <code>mode</code> is set to <code>one_per_domain</code>, this field will indicate the total number of backlinks coming from this domain'
          format: int64
          nullable: true
        is_broken:
          type: boolean
          description: '<em>indicates whether the backlink is broken</em><br>if <code>true</code>, the backlink is pointing to a page responding with a 4xx or 5xx status code'
          nullable: true
        url_to_status_code:
          type: integer
          description: '<em>status code of the referenced page</em><br>if the value is <code>null</code>, our crawler hasn''t yet visited the webpage the link is pointing to<br>example:<br><code>200</code>'
          nullable: true
        url_to_spam_score:
          type: integer
          description: '<em>spam score of the referenced page</em><br>if the value is <code>null</code>, our crawler hasn''t yet visited the webpage the link is pointing to;<br>learn more about how the metric is calculated on <a href="https://dataforseo.com/help-center/what-is-spam-score-and-how-is-it-calculated" rel="noopener noreferrer" target="_blank">this help center page</a>'
          nullable: true
        url_to_redirect_target:
          type: string
          description: <em>target url of the redirect</em><br>target page the redirect is pointing to
          nullable: true
        ranked_keywords_info:
          type: object
          oneOf:
            - $ref: '#/components/schemas/RankedKeywordsInfo'
          nullable: true
        is_indirect_link:
          type: boolean
          description: '<em>indicates whether the backlink is an indirect link</em><br>if <code>true</code>, the backlink is an indirect link pointing to a page that either redirects to <code>url_to</code>, or points to a canonical page'
          nullable: true
        indirect_link_path:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/BacklinksRedirectInfo'
            nullable: true
          description: <em>indirect link path</em><br>indicates a URL or a sequence of URLs that lead to <code>url_to</code>
          nullable: true
    BacklinksBacklinksLiveResultInfo:
      type: object
      properties:
        target:
          type: string
          description: <em>target domain in a POST array</em>
          nullable: true
        mode:
          type: string
          description: <em>mode specified in a POST array</em>
          nullable: true
        custom_mode:
          type: object
          additionalProperties:
            type: object
            nullable: true
          description: <em>custom mode specified in a POST array</em>
          nullable: true
        total_count:
          type: integer
          description: <em>total amount of results relevant the request</em>
          format: int64
          nullable: true
        items_count:
          type: integer
          description: <em>the number of results returned in the <code>items</code> array</em>
          format: int64
          nullable: true
        items:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/BacklinksBacklinksLiveItem'
            nullable: true
          description: <em>contains relevant backlinks and referring domains data</em>
          nullable: true
        search_after_token:
          type: string
          description: '<em>token for subsequent requests</em><br>by specifying the unique <code>search_after_token</code> when setting a new task, you will get the subsequent results of the initial task;<br><code>search_after_token</code> values are unique for each subsequent task'
          nullable: true
    BacklinksBacklinksLiveTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/BacklinksBacklinksLiveResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    BacklinksBacklinksLiveResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/BacklinksBacklinksLiveTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    BacklinksAnchorsLiveRequestInfo:
      type: object
      properties:
        target:
          type: string
          description: '<em>domain, subdomain or webpage to get anchors for</em><br><strong>required field</strong><br>a domain or a subdomain should be specified without <code>https://</code> and <code>www.</code><br>a page should be specified with absolute URL (including <code>http://</code> or <code>https://</code>)'
        limit:
          type: integer
          description: '<em>the maximum number of returned anchors</em><br>optional field<br>default value: <code>100</code><br>maximum value: <code>1000</code>'
          nullable: true
        offset:
          type: integer
          description: '<em>offset in the results array of returned anchors</em><br>optional field<br>default value: <code>0</code><br>if you specify the <code>10</code> value, the first ten anchors in the results array will be omitted and the data will be provided for the successive anchors'
          nullable: true
        internal_list_limit:
          type: integer
          description: '<em>maximum number of elements within internal arrays</em><br>optional field<br>you can use this field to limit the number of elements within the following arrays:<br><code>referring_links_tld</code><br><code>referring_links_types</code><br><code>referring_links_attributes</code><br><code>referring_links_platform_types</code><br><code>referring_links_semantic_locations</code><p>default value: <code>10</code><br>maximum value: <code>1000</code>'
          nullable: true
        backlinks_status_type:
          type: string
          description: '<em>set what backlinks to return and count</em><br>optional field<br>you can use this field to choose what backlinks will be returned and used for aggregated metrics for your <code>target</code>;<br>possible values: <br><code>all</code> - all backlinks will be returned and counted;<br><code>live</code> - backlinks found during the last check will be returned and counted;<br><code>lost</code> - lost backlinks will be returned and counted;<p>default value: <code>live</code>'
          nullable: true
        filters:
          type: array
          items:
            type: object
            nullable: true
          description: '<em>array of results filtering parameters</em><br>optional field<br><strong>you can add several filters at once (8 filters maximum)</strong><br>you should set a logical operator <code>and</code>, <code>or</code> between the conditions<br>the following operators are supported:<br><code>regex</code>, <code>not_regex</code>, <code>=</code>, <code>&lt;&gt;</code>, <code>in</code>, <code>not_in</code>, <code>like</code>, <code>not_like</code>, <code>ilike</code>, <code>not_ilike</code>, <code>match</code>, <code>not_match</code><br>you can use the <code>%</code> operator with <code>like</code> and <code>not_like</code> to match any string of zero or more characters<br>example:<br><code>["referring_links_types.anchors","&gt;","1"]</code><p><code>[["broken_pages","&gt;","2"],<br>"and",<br>["backlinks","&gt;","10"]]</code><p><code>[["first_seen",">","2017-10-23 11:31:45 +00:00"],<br>"and",<br>[["anchor","like","%seo%"],"or",["referring_domains","&gt;","10"]]]</code><p>The full list of possible filters is available <a href="/v3/backlinks/filters/?bash">here.</a>'
          nullable: true
        order_by:
          type: array
          items:
            type: string
          description: '<em>results sorting rules</em><br>optional field<br>you can use the same values as in the <code>filters</code> array to sort the results<br>possible sorting types:<br><code>asc</code> - results will be sorted in the ascending order<br><code>desc</code> - results will be sorted in the descending order<br>you should use a comma to set up a sorting type<br>example:<br><code>["backlinks,desc"]</code><br><strong>note that you can set no more than three sorting rules in a single request</strong><br>you should use a comma to separate several sorting rules<br>example:<br><code>["backlinks,desc","rank,asc"]</code>'
          nullable: true
        backlinks_filters:
          type: array
          items:
            type: object
            nullable: true
          description: '<em>filter the backlinks of your <code>target</code></em><br>optional field<br>you can use this field to filter the initial backlinks that will be included in the dataset for aggregated metrics for your <code>target</code><br>you can filter the backlinks by all fields available in the response of <a href="/v3/backlinks/backlinks/live/">this endpoint</a><br>using this parameter, you can include only dofollow backlinks in the response and create a flexible backlinks dataset to calculate the metrics for<br>example:<br><code>"backlinks_filters": [["dofollow", "=", true]]</code>'
          nullable: true
        include_subdomains:
          type: boolean
          description: '<em>indicates if the subdomains of the <code>target</code> will be included in the search</em><br>optional field<br>if set to <code>false</code>, the subdomains will be ignored<br>default value: <code>true</code>'
          nullable: true
        include_indirect_links:
          type: boolean
          description: '<em>indicates if indirect links to the <code>target</code> will be included in the results</em><br>optional field<br>if set to <code>true</code>, the results will include data on indirect links pointing to a page that either redirects to the target, or points to a canonical page<br>if set to <code>false</code>, indirect links will be ignored<br>default value: <code>true</code>'
          nullable: true
        exclude_internal_backlinks:
          type: boolean
          description: '<em>indicates whether the backlinks from subdomains of the <code>target</code> are excluded</em><br>optional field<br>if set to <code>false</code>, the backlinks from subdomains of the <code>target</code> will be ommited and you won''t receive the same domain in the response;<br>default value: <code>true</code>'
          nullable: true
        rank_scale:
          type: string
          description: '<em>defines the scale used for calculating and displaying the <code>rank</code>, <code>domain_from_rank</code>, and <code>page_from_rank</code> values</em><br>optional field<p>you can use this parameter to choose whether rank values are presented on a 0–100 or 0–1000 scale<p>possible values:<br><code>one_hundred</code> — rank values are displayed on a 0–100 scale<br><code>one_thousand</code> — rank values are displayed on a 0–1000 scale<p>default value: <code>one_thousand</code><p>learn more about how this parameter works and how ranking metrics are calculated in <a href="https://dataforseo.com/help-center/what_is_rank_in_backlinks_api#rank_scale">this Help Center article</a>'
          nullable: true
        tag:
          type: string
          description: <em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response
          nullable: true
      example:
        - target: forbes.com
          limit: 4
          order_by:
            - 'backlinks,desc'
          filters:
            - anchor
            - like
            - '%news%'
    BacklinksAnchorsLiveItem:
      type: object
      properties:
        type:
          type: string
          description: type of element
          nullable: true
        anchor:
          type: string
          description: <em>anchor of the backlink</em>
          nullable: true
        rank:
          type: integer
          description: <em>rank of the anchor links</em><br>rank volume that referring websites pass to the <code>target</code> through links with a particular anchor<br><code>rank</code> is calculated based on the method for node ranking in a linked database - a principle used in the original Google PageRank algorithm<br>learn more about the metric and how it is calculated in <a href="https://dataforseo.com/help-center/what_is_rank_in_backlinks_api" rel="noopener noreferrer" target="_blank">this help center article</a>
          nullable: true
        backlinks:
          type: integer
          description: <em>indicates the number of backlinks</em>
          format: int64
          nullable: true
        first_seen:
          type: string
          description: '<em>date and time when our crawler found the backlink with this anchor for the first time</em><br>in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”<br>example:<br><code>2019-11-15 12:57:46 +00:00</code>'
          nullable: true
        lost_date:
          type: string
          description: '<em>date and time when the last backlink with this anchor was lost</em><br>indicates the date and time when our crawler visited the page and it responded with 4xx or 5xx status code or the last backlink was removed<br>in the UTC format: "yyyy-mm-dd hh-mm-ss +00:00"<br>example:<br><code>2017-01-24 13:20:59 +00:00</code>'
          nullable: true
        backlinks_spam_score:
          type: integer
          description: <em>average spam score of all backlinks with this anchor</em><br>learn more about how the metric is calculated on <a href="https://dataforseo.com/help-center/what-is-spam-score-and-how-is-it-calculated" rel="noopener noreferrer" target="_blank">this help center page</a>
          format: int64
          nullable: true
        broken_backlinks:
          type: integer
          description: <em>number of broken backlinks</em><br>number of broken backlinks pointing to the <code>target</code>
          format: int64
          nullable: true
        broken_pages:
          type: integer
          description: <em>number of broken pages</em><br>number of pages that respond with 4xx or 5xx status codes where backlinks are pointing to
          nullable: true
        referring_domains:
          type: integer
          description: <em>indicates the number of referring domains</em>
          format: int64
          nullable: true
        referring_domains_nofollow:
          type: integer
          description: <em>number of domains pointing at least one nofollow link to the <code>target</code></em>
          format: int64
          nullable: true
        referring_main_domains:
          type: integer
          description: <em>indicates the number of referring main domains</em>
          format: int64
          nullable: true
        referring_main_domains_nofollow:
          type: integer
          description: <em>number of main domains pointing at least one nofollow link to the <code>target</code></em>
          format: int64
          nullable: true
        referring_ips:
          type: integer
          description: <em>number of referring IP addresses</em><br>number of IP addresses pointing to this page
          format: int64
          nullable: true
        referring_subnets:
          type: integer
          description: <em>number of referring subnetworks</em>
          format: int64
          nullable: true
        referring_pages:
          type: integer
          description: <em>indicates the number of pages pointing to <code>target</code> with this anchor</em>
          format: int64
          nullable: true
        referring_pages_nofollow:
          type: integer
          description: <em>number of referring pages pointing at least one nofollow link to the <code>target</code> with this anchor</em>
          format: int64
          nullable: true
        referring_links_tld:
          type: object
          additionalProperties:
            type: integer
            format: int64
            nullable: true
          description: <em>top-level domains of the referring links</em><br>contains top level domains and referring link count per each
          nullable: true
        referring_links_types:
          type: object
          additionalProperties:
            type: integer
            format: int64
            nullable: true
          description: '<em>types of referring links</em><br>indicates the types of the referring links and link count per each type<br>possible values:<br><code>anchor</code>, <code>image</code>, <code>link</code>, <code>meta</code>, <code>canonical</code>, <code>alternate</code>, <code>redirect</code>'
          nullable: true
        referring_links_attributes:
          type: object
          additionalProperties:
            type: integer
            format: int64
            nullable: true
          description: <em>link attributes of the referring links</em><br>indicates link attributes of the referring links and link count per each attribute
          nullable: true
        referring_links_platform_types:
          type: object
          additionalProperties:
            type: integer
            format: int64
            nullable: true
          description: '<em>types of referring platforms</em><br>indicates referring platform types and and link count per each platform<p>possible values: <code>cms</code>, <code>blogs</code>, <code>ecommerce</code>, <code>message-boards</code>, <code>wikis</code>, <code>news</code>, <code>organization</code>'
          nullable: true
        referring_links_semantic_locations:
          type: object
          additionalProperties:
            type: integer
            format: int64
            nullable: true
          description: '<em>semantic locations of the referring links</em><br>indicates semantic elements in HTML where the referring links are located and link count per each semantic location<p>you can get the full list of semantic elements <a href="https://www.w3schools.com/html/html5_semantic_elements.asp" target="_blank" rel="noopener noreferrer">here</a><br>examples:<br><code>article</code>, <code>section</code>, <code>summary</code>'
          nullable: true
        referring_links_countries:
          type: object
          additionalProperties:
            type: integer
            format: int64
            nullable: true
          description: <em>ISO country codes of the referring links</em><br>indicates ISO country codes of the domains where the referring links are located and the link count per each country
          nullable: true
    BacklinksAnchorsLiveResultInfo:
      type: object
      properties:
        target:
          type: string
          description: <em>target in the post array</em>
          nullable: true
        total_count:
          type: integer
          description: <em>total number of relevant items in the database</em>
          format: int64
          nullable: true
        items_count:
          type: integer
          description: <em>number of items in the results array</em>
          format: int64
          nullable: true
        items:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/BacklinksAnchorsLiveItem'
            nullable: true
          description: <em>items array</em>
          nullable: true
    BacklinksAnchorsLiveTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/BacklinksAnchorsLiveResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    BacklinksAnchorsLiveResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/BacklinksAnchorsLiveTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    BacklinksDomainPagesLiveRequestInfo:
      type: object
      properties:
        target:
          type: string
          description: <em>domain or subdomain</em><br><strong>required field</strong><br>a domain or a subdomain should be specified without <code>https://</code> and <code>www.</code><br>example:<br><code>forbes.com</code>
        limit:
          type: integer
          description: '<em>the maximum number of returned pages</em><br>optional field<br>default value: <code>100</code><br>maximum value: <code>1000</code>'
          nullable: true
        offset:
          type: integer
          description: '<em>offset in the results array of returned pages</em><br>optional field<br>default value: <code>0</code><br>if you specify the <code>10</code> value, the first ten pages in the results array will be omitted and the data will be provided for the successive pages'
          nullable: true
        internal_list_limit:
          type: integer
          description: '<em>maximum number of elements within internal arrays</em><br>optional field<br>you can use this field to limit the number of elements within the following arrays:<br><code>referring_links_tld</code><br><code>referring_links_types</code><br><code>referring_links_attributes</code><br><code>referring_links_platform_types</code><br><code>referring_links_semantic_locations</code><p>default value: <code>10</code><br>maximum value: <code>1000</code>'
          nullable: true
        backlinks_status_type:
          type: string
          description: '<em>set what backlinks to return and count</em><br>optional field<br>you can use this field to choose what backlinks will be returned and used for aggregated metrics;<br>possible values: <br><code>all</code> - all backlinks will be returned and counted;<br><code>live</code> - backlinks found during the last check will be returned and counted;<br><code>lost</code> - lost backlinks will be returned and counted;<p>default value: <code>live</code>'
          nullable: true
        filters:
          type: array
          items:
            type: object
            nullable: true
          description: '<em>array of results filtering parameters</em><br>optional field<br><strong>you can add several filters at once (8 filters maximum)</strong><br>you should set a logical operator <code>and</code>, <code>or</code> between the conditions<br>the following operators are supported:<br><code>regex</code>, <code>not_regex</code>, <code>=</code>, <code>&lt;&gt;</code>, <code>in</code>, <code>not_in</code>, <code>like</code>, <code>not_like</code>, <code>ilike</code>, <code>not_ilike</code>, <code>match</code>, <code>not_match</code><br>you can use the <code>%</code> operator with <code>like</code> and <code>not_like</code> to match any string of zero or more characters<br>example:<br><code>["meta.internal_links_count","&gt;","1"]</code><p><code>[["meta.external_links_count","&gt;","2"],<br>"and",<br>["backlinks","&gt;","10"]]</code><p><code>[["first_visited",">","2017-10-23 11:31:45 +00:00"],<br>"and",<br>[["title","like","%seo%"],"or",["referring_domains","&gt;","10"]]]</code><p>The full list of possible filters is available <a href="/v3/backlinks/filters/?bash" rel="noopener noreferrer" target="_blank">here.</a>'
          nullable: true
        order_by:
          type: array
          items:
            type: string
          description: '<em>results sorting rules</em><br>optional field<br>you can use the same values as in the <code>filters</code> array to sort the results<br>possible sorting types:<br><code>asc</code> - results will be sorted in the ascending order<br><code>desc</code> - results will be sorted in the descending order<br>you should use a comma to set up a sorting type<br>example:<br><code>["page_summary.backlinks,desc"]</code><br><strong>note that you can set no more than three sorting rules in a single request</strong><br>you should use a comma to separate several sorting rules<br>example:<br><code>["page_summary.backlinks,desc","page_summary.rank,asc"]</code>'
          nullable: true
        backlinks_filters:
          type: array
          items:
            type: object
            nullable: true
          description: '<em>filter the backlinks of your <code>target</code></em><br>optional field<br>you can use this field to filter the initial backlinks that will be included in the dataset for aggregated metrics for your <code>target</code><br>you can filter the backlinks by all fields available in the response of <a href="/v3/backlinks/backlinks/live">this endpoint</a><br>using this parameter, you can include only dofollow backlinks in the response and create a flexible backlinks dataset to calculate the metrics for<br>example:<br><code>"backlinks_filters": ["dofollow", "=", true]</code>'
          nullable: true
        include_subdomains:
          type: boolean
          description: '<em>indicates if the subdomains of the <code>target</code> will be included in the search</em><br>optional field<br>if set to <code>false</code>, the subdomains will be ignored<br>default value: <code>true</code>'
          nullable: true
        exclude_internal_backlinks:
          type: boolean
          description: '<em>indicates if internal backlinks from subdomains to the <code>target</code> will be excluded from the results</em><br>optional field<br>if set to <code>true</code>, the results will not include data on internal backlinks from subdomains of the same domain as <code>target</code><br>if set to <code>false</code>, internal links will be included in the results<br>default value: <code>true</code>'
          nullable: true
        rank_scale:
          type: string
          description: '<em>defines the scale used for calculating and displaying the <code>rank</code>, <code>domain_from_rank</code>, and <code>page_from_rank</code> values</em><br>optional field<p>you can use this parameter to choose whether rank values are presented on a 0–100 or 0–1000 scale<p>possible values:<br><code>one_hundred</code> — rank values are displayed on a 0–100 scale<br><code>one_thousand</code> — rank values are displayed on a 0–1000 scale<p>default value: <code>one_thousand</code><p>learn more about how this parameter works and how ranking metrics are calculated in <a href="https://dataforseo.com/help-center/what_is_rank_in_backlinks_api#rank_scale">this Help Center article</a>'
          nullable: true
        tag:
          type: string
          description: <em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response
          nullable: true
      example:
        - target: forbes.com
          limit: 5
          filters:
            - 
              - page_summary.backlinks
              - '>'
              - 5
            - and
            - 
              - page
              - like
              - '%sites%'
    BacklinksPageMeta:
      type: object
      properties:
        title:
          type: string
          description: <em>page title</em>
          nullable: true
        canonical:
          type: string
          description: <em>canonical page</em>
          nullable: true
        internal_links_count:
          type: integer
          description: <em>number of internal links on the page</em>
          format: int64
          nullable: true
        external_links_count:
          type: integer
          description: <em>number of external links on the page</em>
          format: int64
          nullable: true
        images_count:
          type: integer
          description: <em>number of images on the page</em>
          format: int64
          nullable: true
        words_count:
          type: integer
          description: <em>number of words on the page</em>
          format: int64
          nullable: true
        page_spam_score:
          type: integer
          description: <em>spam score of the page</em><br>learn more about how the metric is calculated on <a href="https://dataforseo.com/help-center/what-is-spam-score-and-how-is-it-calculated" rel="noopener noreferrer" target="_blank">this help center page</a>
          nullable: true
        social_media_tags:
          type: object
          additionalProperties:
            type: string
            nullable: true
          description: <em>array of social media tags found on the page</em><br>contains social media tags and their content<br>supported tags include but are not limited to <a href="https://ogp.me/">Open Graph</a> and <a href="https://developer.twitter.com/en/docs/twitter-for-websites/cards/guides/getting-started">Twitter card</a>
          nullable: true
        h1:
          type: array
          items:
            type: string
            nullable: true
          description: <em>h1 tag</em><br>content of <code>h1</code> tags
          nullable: true
        h2:
          type: array
          items:
            type: string
            nullable: true
          description: <em>h2 tag</em><br>content of <code>h2</code> tags
          nullable: true
        h3:
          type: array
          items:
            type: string
            nullable: true
          description: <em>h3 tag</em><br>content of <code>h3</code> tags
          nullable: true
        images_alt:
          type: array
          items:
            type: string
            nullable: true
          description: <em>content of <code>alt</code> tags</em>
          nullable: true
        powered_by:
          type: array
          items:
            type: string
            nullable: true
          description: <em>CMS details</em>
          nullable: true
        language:
          type: string
          description: <em>page content language</em><br>example:<br><code>en</code>
          nullable: true
        charset:
          type: string
          description: <em>character encoding</em><br>examples:<br><code>utf-8</code>
          nullable: true
        platform_type:
          type: array
          items:
            type: string
            nullable: true
          description: <em>type of a platform</em>
          nullable: true
        technologies:
          type: object
          additionalProperties:
            type: string
            nullable: true
          description: <em>website technologies</em>
          nullable: true
    PageSummary:
      type: object
      properties:
        first_seen:
          type: string
          description: '<em>date and time when our crawler found the backlink for the first time</em><br>in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”<br>example:<br><code>2019-11-15 12:57:46 +00:00</code>'
          nullable: true
        lost_date:
          type: string
          description: '<em>date and time when the last backlink for this page was lost</em><br>indicates the date and time when our crawler visited the page and it responded with 4xx or 5xx status code or the last backlink was removed<br>in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”<br>example:<br><code>2017-01-24 13:20:59 +00:00</code>'
          nullable: true
        rank:
          type: integer
          description: <em>page rank</em><br>rank of the <code>page</code><br><code>rank</code> is calculated based on the method for node ranking in a linked database - a principle used in the original Google PageRank algorithm<br>learn more about the metric and how it is calculated in <a href="https://dataforseo.com/help-center/what_is_rank_in_backlinks_api" rel="noopener noreferrer" target="_blank">this help center article</a>
          nullable: true
        backlinks:
          type: integer
          description: <em>indicates the number of backlinks</em>
          format: int64
          nullable: true
        backlinks_spam_score:
          type: integer
          description: <em>average spam score of the backlinks pointing to the page</em><br>learn more about how the metric is calculated on <a href="https://dataforseo.com/help-center/what-is-spam-score-and-how-is-it-calculated" rel="noopener noreferrer" target="_blank">this help center page</a>
          format: int64
          nullable: true
        broken_backlinks:
          type: integer
          description: <em>number of broken backlinks</em><br>number of broken backlinks pointing to the <code>page</code>
          format: int64
          nullable: true
        broken_pages:
          type: integer
          description: <em>number of broken pages</em><br>number of pages that respond with 4xx or 5xx status codes where backlinks are pointing to
          nullable: true
        referring_domains:
          type: integer
          description: <em>indicates the number of referring domains</em>
          format: int64
          nullable: true
        referring_domains_nofollow:
          type: integer
          description: <em>number of domains pointing at least one nofollow link to the <code>page</code></em>
          format: int64
          nullable: true
        referring_main_domains:
          type: integer
          description: <em>indicates the number of referring main domains</em>
          format: int64
          nullable: true
        referring_main_domains_nofollow:
          type: integer
          description: <em>number of main domains pointing at least one nofollow link to the <code>page</code></em>
          format: int64
          nullable: true
        referring_ips:
          type: integer
          description: <em>number of referring IP addresses</em><br>number of IP addresses pointing to this page
          format: int64
          nullable: true
        referring_subnets:
          type: integer
          description: <em>number of referring subnetworks</em>
          format: int64
          nullable: true
        referring_pages:
          type: integer
          description: <em>indicates the number of pages pointing to the <code>page</code></em>
          format: int64
          nullable: true
        referring_pages_nofollow:
          type: integer
          description: <em>number of referring pages pointing at least one nofollow link to the <code>page</code></em>
          format: int64
          nullable: true
        referring_links_tld:
          type: object
          additionalProperties:
            type: integer
            format: int64
            nullable: true
          description: <em>top-level domains of the referring links</em><br>contains top level domains and referring link count per each
          nullable: true
        referring_links_types:
          type: object
          additionalProperties:
            type: integer
            format: int64
            nullable: true
          description: '<em>types of referring links</em><br>indicates the types of the referring links and link count per each type<br>possible values:<br><code>anchor</code>, <code>image</code>, <code>link</code>, <code>meta</code>, <code>canonical</code>, <code>alternate</code>, <code>redirect</code>'
          nullable: true
        referring_links_attributes:
          type: object
          additionalProperties:
            type: integer
            format: int64
            nullable: true
          description: <em>link attributes of the referring links</em><br>indicates link attributes of the referring links and link count per each attribute
          nullable: true
        referring_links_platform_types:
          type: object
          additionalProperties:
            type: integer
            format: int64
            nullable: true
          description: '<em>types of referring platforms</em><br>indicates referring platform types and and link count per each platform<p>possible values: <code>cms</code>, <code>blogs</code>, <code>ecommerce</code>, <code>message-boards</code>, <code>wikis</code>, <code>news</code>, <code>organization</code>'
          nullable: true
        referring_links_semantic_locations:
          type: object
          additionalProperties:
            type: integer
            format: int64
            nullable: true
          description: '<em>semantic locations of the referring links</em><br>indicates semantic elements in HTML where the referring links are located and link count per each semantic location<p>you can get the full list of semantic elements <a href="https://www.w3schools.com/html/html5_semantic_elements.asp" target="_blank" rel="noopener noreferrer">here</a><br>examples:<br><code>article</code>, <code>section</code>, <code>summary</code>'
          nullable: true
        referring_links_countries:
          type: object
          additionalProperties:
            type: integer
            format: int64
            nullable: true
          description: <em>ISO country codes of the referring links</em><br>indicates ISO country codes of the domains where the referring links are located and the link count per each country
          nullable: true
    BacklinksDomainPagesLiveItem:
      type: object
      properties:
        type:
          type: string
          description: type of element
          nullable: true
        main_domain:
          type: string
          description: <em>main website domain</em><br>main website domain does not include subdomains
          nullable: true
        domain:
          type: string
          description: <em>domain</em><br>domain where the page was found
          nullable: true
        tld:
          type: string
          description: <em>top-level domain</em><br>top-level domain in the <a href="https://www.iana.org/domains/root/db" rel="noopener noreferrer" target="_blank">DNS root zone</a>
          nullable: true
        page:
          type: string
          description: <em>page URL</em><br>relevant page URL
          nullable: true
        ip:
          type: string
          description: <em>Internet Protocol address</em>
          nullable: true
        first_visited:
          type: string
          description: '<em>date and time of the first page visit</em><br>date and time when our crawler visited this page for the first time<br>in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”<br>example:<br><code>2017-01-24 13:20:59 +00:00</code>'
          nullable: true
        prev_visited:
          type: string
          description: '<em>previous to the most recent date when our crawler visited the page</em><br>in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”<br>example:<br><code>2017-01-24 13:20:59 +00:00</code>'
          nullable: true
        fetch_time:
          type: string
          description: '<em>most recent date and time when our crawler visited the page</em><br>in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”<br>example:<br><code>2017-01-24 13:20:59 +00:00</code>'
          nullable: true
        status_code:
          type: integer
          description: <i>general status code</i><br>you can find the full list of the response codes <a href="/v3/appendix/errors">here</a><br><strong>Note:</strong> we strongly recommend designing a necessary system for handling related exceptional or error conditions
          nullable: true
        location:
          type: string
          description: <em>location header</em><br>indicates the URL to redirect a page to if exists
          nullable: true
        size:
          type: integer
          description: '<em>indicates the page size, in bytes</em>'
          nullable: true
        encoded_size:
          type: integer
          description: '<em>page size after encoding</em><br>indicates the size of the encoded page, in bytes'
          nullable: true
        content_encoding:
          type: string
          description: <em>type of encoding</em>
          nullable: true
        media_type:
          type: string
          description: <em>types of media used to display a page</em>
          nullable: true
        server:
          type: string
          description: <em>server version</em>
          nullable: true
        meta:
          type: object
          oneOf:
            - $ref: '#/components/schemas/BacklinksPageMeta'
          properties:
            social_media_tags:
              type: object
              additionalProperties:
                type: string
                nullable: true
              nullable: true
          description: <em>page meta data</em>
          nullable: true
        page_summary:
          type: object
          oneOf:
            - $ref: '#/components/schemas/PageSummary'
          properties:
            referring_main_domains_nofollow:
              type: integer
              format: int64
              nullable: true
            referring_links_tld:
              type: object
              additionalProperties:
                type: integer
                format: int64
                nullable: true
              nullable: true
            referring_links_types:
              type: object
              additionalProperties:
                type: integer
                format: int64
                nullable: true
              nullable: true
            referring_links_attributes:
              type: object
              additionalProperties:
                type: integer
                format: int64
                nullable: true
              nullable: true
            referring_links_platform_types:
              type: object
              additionalProperties:
                type: integer
                format: int64
                nullable: true
              nullable: true
            referring_links_semantic_locations:
              type: object
              additionalProperties:
                type: integer
                format: int64
                nullable: true
              nullable: true
            referring_links_countries:
              type: object
              additionalProperties:
                type: integer
                format: int64
                nullable: true
              nullable: true
          description: <em>contains backlink data for this page</em>
          nullable: true
    BacklinksDomainPagesLiveResultInfo:
      type: object
      properties:
        target:
          type: string
          description: <em><code>target</code> in a POST array</em>
          nullable: true
        total_count:
          type: integer
          description: <em>total number of relevant items in the database</em>
          format: int64
          nullable: true
        items_count:
          type: integer
          description: <em>number of items in the <code>items</code> array</em>
          format: int64
          nullable: true
        items:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/BacklinksDomainPagesLiveItem'
            nullable: true
          description: <em>items array</em>
          nullable: true
    BacklinksDomainPagesLiveTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/BacklinksDomainPagesLiveResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    BacklinksDomainPagesLiveResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/BacklinksDomainPagesLiveTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    BacklinksDomainPagesSummaryLiveRequestInfo:
      type: object
      properties:
        target:
          type: string
          description: '<em>domain, subdomain or webpage to get summary data for</em><br><strong>required field</strong><br>a domain or a subdomain should be specified without <code>https://</code> and <code>www.</code><br>a page should be specified with absolute URL (including <code>http://</code> or <code>https://</code>)'
        limit:
          type: integer
          description: '<em>the maximum number of returned anchors</em><br>optional field<br>default value: <code>100</code><br>maximum value: <code>1000</code>'
          nullable: true
        offset:
          type: integer
          description: '<em>offset in the results array of returned anchors</em><br>optional field<br>default value: <code>0</code><br>if you specify the <code>10</code> value, the first ten anchors in the results array will be omitted and the data will be provided for the successive anchors'
          nullable: true
        internal_list_limit:
          type: integer
          description: '<em>maximum number of elements within internal arrays</em><br>optional field<br>you can use this field to limit the number of elements within the following arrays:<br><code>referring_links_tld</code><br><code>referring_links_types</code><br><code>referring_links_attributes</code><br><code>referring_links_platform_types</code><br><code>referring_links_semantic_locations</code><p>default value: <code>10</code><br>maximum value: <code>1000</code>'
          nullable: true
        backlinks_status_type:
          type: string
          description: '<em>set what backlinks to return and count</em><br>optional field<br>you can use this field to choose what backlinks will be returned and used for aggregated metrics for your <code>target</code>;<br>possible values: <br><code>all</code> - all backlinks will be returned and counted;<br><code>live</code> - backlinks found during the last check will be returned and counted;<br><code>lost</code> - lost backlinks will be returned and counted;<p>default value: <code>live</code>'
          nullable: true
        filters:
          type: array
          items:
            type: object
            nullable: true
          description: '<em>array of results filtering parameters</em><br>optional field<br><strong>you can add several filters at once (8 filters maximum)</strong><br>you should set a logical operator <code>and</code>, <code>or</code> between the conditions<br>the following operators are supported:<br><code>regex</code>, <code>not_regex</code>, <code>=</code>, <code>&lt;&gt;</code>, <code>in</code>, <code>not_in</code>, <code>like</code>, <code>not_like</code>, <code>ilike</code>, <code>not_ilike</code>, <code>match</code>, <code>not_match</code><br>you can use the <code>%</code> operator with <code>like</code> and <code>not_like</code> to match any string of zero or more characters<br>example:<br><code>["referring_links_types.anchors","&gt;","1"]</code><p><code>[["broken_pages","&gt;","2"],<br>"and",<br>["backlinks","&gt;","10"]]</code><p><code>[["first_seen",">","2017-10-23 11:31:45 +00:00"],<br>"and",<br>[["anchor","like","%seo%"],"or",["referring_domains","&gt;","10"]]]</code><p>The full list of possible filters is available <a href="/v3/backlinks/filters/?bash">here.</a>'
          nullable: true
        order_by:
          type: array
          items:
            type: string
          description: '<em>results sorting rules</em><br>optional field<br>you can use the same values as in the <code>filters</code> array to sort the results<br>possible sorting types:<br><code>asc</code> - results will be sorted in the ascending order<br><code>desc</code> - results will be sorted in the descending order<br>you should use a comma to set up a sorting type<br>example:<br><code>["backlinks,desc"]</code><br><strong>note that you can set no more than three sorting rules in a single request</strong><br>you should use a comma to separate several sorting rules<br>example:<br><code>["backlinks,desc","rank,asc"]</code>'
          nullable: true
        backlinks_filters:
          type: array
          items:
            type: object
            nullable: true
          description: '<em>filter the backlinks of your <code>target</code></em><br>optional field<br>you can use this field to filter the initial backlinks that will be included in the dataset for aggregated metrics for your <code>target</code><br>you can filter the backlinks by all fields available in the response of <a href="/v3/backlinks/backlinks/live/">this endpoint</a><br>using this parameter, you can include only dofollow backlinks in the response and create a flexible backlinks dataset to calculate the metrics for<br>example:<br><code>"backlinks_filters": [["dofollow", "=", true]]</code>'
          nullable: true
        include_subdomains:
          type: boolean
          description: '<em>indicates if the subdomains of the <code>target</code> domain will be included in the search</em><br>optional field<br>if set to <code>false</code>, the subdomains will be ignored<br>default value: <code>true</code>'
          nullable: true
        include_indirect_links:
          type: boolean
          description: '<em>indicates if indirect links to the <code>target</code> will be included in the results</em><br>optional field<br>if set to <code>true</code>, the results will include data on indirect links pointing to a page that either redirects to the target, or points to a canonical page<br>if set to <code>false</code>, indirect links will be ignored<br>default value: <code>true</code>'
          nullable: true
        exclude_internal_backlinks:
          type: boolean
          description: '<em>indicates whether the backlinks from subdomains of the <code>target</code> are excluded</em><br>optional field<br>if set to <code>false</code>, backlinks from the subdomains of the <code>target</code> domain will be ommited and you won''t receive the same domain in the response;<br>default value: <code>true</code>'
          nullable: true
        rank_scale:
          type: string
          description: '<em>defines the scale used for calculating and displaying the <code>rank</code>, <code>domain_from_rank</code>, and <code>page_from_rank</code> values</em><br>optional field<p>you can use this parameter to choose whether rank values are presented on a 0–100 or 0–1000 scale<p>possible values:<br><code>one_hundred</code> — rank values are displayed on a 0–100 scale<br><code>one_thousand</code> — rank values are displayed on a 0–1000 scale<p>default value: <code>one_thousand</code><p>learn more about how this parameter works and how ranking metrics are calculated in <a href="https://dataforseo.com/help-center/what_is_rank_in_backlinks_api#rank_scale">this Help Center article</a>'
          nullable: true
        tag:
          type: string
          description: <em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response
          nullable: true
      example:
        - target: forbes.com
          limit: 4
          order_by:
            - 'backlinks,desc'
    BacklinksDomainPagesSummaryLiveItem:
      type: object
      properties:
        type:
          type: string
          description: type of element
          nullable: true
        url:
          type: string
          description: <em>page URL</em>
          nullable: true
        rank:
          type: integer
          description: <em>page rank</em><br>rank of the <code>page</code><br><code>rank</code> is calculated based on the method for node ranking in a linked database - a principle used in the original Google PageRank algorithm<br>learn more about the metric and how it is calculated in <a href="https://dataforseo.com/help-center/what_is_rank_in_backlinks_api" rel="noopener noreferrer" target="_blank">this help center article</a>
          nullable: true
        backlinks:
          type: integer
          description: <em>number of backlinks</em>
          format: int64
          nullable: true
        first_seen:
          type: string
          description: '<em>date and time when our crawler found a backlink to this page for the first time</em><br>in the UTC format: "yyyy-mm-dd hh-mm-ss +00:00"<br>example:<br><code>2019-11-15 12:57:46 +00:00</code>'
          nullable: true
        lost_date:
          type: string
          description: '<em>date and time when the last backlink to this page was lost</em><br>indicates the date and time when our crawler visited the page and it responded with 4xx or 5xx status code or the last backlink was removed<br>in the UTC format: "yyyy-mm-dd hh-mm-ss +00:00"<br>example:<br><code>2017-01-24 13:20:59 +00:00</code>'
          nullable: true
        backlinks_spam_score:
          type: integer
          description: <em>average spam score of the backlinks pointing to the page</em><br>learn more about how the metric is calculated on <a href="https://dataforseo.com/help-center/what-is-spam-score-and-how-is-it-calculated" rel="noopener noreferrer" target="_blank">this help center page</a>
          format: int64
          nullable: true
        broken_backlinks:
          type: integer
          description: <em>number of broken backlinks</em><br>number of broken backlinks pointing to the page
          format: int64
          nullable: true
        broken_pages:
          type: integer
          description: <em>number of broken pages</em><br>number of pages that respond with 4xx or 5xx status codes where backlinks are pointing to
          nullable: true
        referring_domains:
          type: integer
          description: <em>indicates the number domains referring to the page</em>
          format: int64
          nullable: true
        referring_domains_nofollow:
          type: integer
          description: <em>number of domains pointing at least one nofollow link to the <code>page</code></em>
          format: int64
          nullable: true
        referring_main_domains:
          type: integer
          description: <em>indicates the number of referring main domains</em>
          format: int64
          nullable: true
        referring_main_domains_nofollow:
          type: integer
          description: <em>number of main domains pointing at least one nofollow link to the <code>page</code></em>
          format: int64
          nullable: true
        referring_ips:
          type: integer
          description: <em>number of referring IP addresses</em><br>number of IP addresses pointing to this page
          format: int64
          nullable: true
        referring_subnets:
          type: integer
          description: <em>number of referring subnetworks</em>
          format: int64
          nullable: true
        referring_pages:
          type: integer
          description: <em>indicates the number of pages pointing to the relevant <code>url</code></em>
          format: int64
          nullable: true
        referring_pages_nofollow:
          type: integer
          description: <em>number of referring pages pointing at least one nofollow link to the <code>page</code></em>
          format: int64
          nullable: true
        referring_links_tld:
          type: object
          additionalProperties:
            type: integer
            format: int64
            nullable: true
          description: <em>top-level domains of the referring links</em><br>contains top level domains and referring link count per each
          nullable: true
        referring_links_types:
          type: object
          additionalProperties:
            type: integer
            format: int64
            nullable: true
          description: '<em>types of referring links</em><br>indicates the types of the referring links and link count per each type<br>possible values:<br><code>anchor</code>, <code>image</code>, <code>link</code>, <code>meta</code>, <code>canonical</code>, <code>alternate</code>, <code>redirect</code>'
          nullable: true
        referring_links_attributes:
          type: object
          additionalProperties:
            type: integer
            format: int64
            nullable: true
          description: <em>link attributes of the referring links</em><br>indicates link attributes of the referring links and link count per each attribute
          nullable: true
        referring_links_platform_types:
          type: object
          additionalProperties:
            type: integer
            format: int64
            nullable: true
          description: '<em>types of referring platforms</em><br>indicates referring platform types and and link count per each platform<p>possible values: <code>cms</code>, <code>blogs</code>, <code>ecommerce</code>, <code>message-boards</code>, <code>wikis</code>, <code>news</code>, <code>organization</code>'
          nullable: true
        referring_links_semantic_locations:
          type: object
          additionalProperties:
            type: integer
            format: int64
            nullable: true
          description: '<em>semantic locations of the referring links</em><br>indicates semantic elements in HTML where the referring links are located and link count per each semantic location<p>you can get the full list of semantic elements <a href="https://www.w3schools.com/html/html5_semantic_elements.asp" target="_blank" rel="noopener noreferrer">here</a><br>examples:<br><code>article</code>, <code>section</code>, <code>footer</code>'
          nullable: true
        referring_links_countries:
          type: object
          additionalProperties:
            type: integer
            format: int64
            nullable: true
          description: <em>ISO country codes of the referring links</em><br>indicates ISO country codes of the domains where the referring links are located and the link count per each country
          nullable: true
    BacklinksDomainPagesSummaryLiveResultInfo:
      type: object
      properties:
        target:
          type: string
          description: <em>target in the post array</em>
          nullable: true
        total_count:
          type: integer
          description: <em>total number of relevant items in the database</em>
          format: int64
          nullable: true
        items_count:
          type: integer
          description: <em>number of items in the results array</em>
          format: int64
          nullable: true
        items:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/BacklinksDomainPagesSummaryLiveItem'
            nullable: true
          description: <em>items array</em>
          nullable: true
    BacklinksDomainPagesSummaryLiveTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/BacklinksDomainPagesSummaryLiveResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    BacklinksDomainPagesSummaryLiveResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/BacklinksDomainPagesSummaryLiveTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    BacklinksReferringDomainsLiveRequestInfo:
      type: object
      properties:
        target:
          type: string
          description: '<em>domain, subdomain or webpage to get referring domains for</em><br><strong>required field</strong><br>a domain or a subdomain should be specified without <code>https://</code> and <code>www.</code><br>a page should be specified with absolute URL (including <code>http://</code> or <code>https://</code>)'
        limit:
          type: integer
          description: '<em>the maximum number of returned domains</em><br>optional field<br>default value: <code>100</code><br>maximum value: <code>1000</code>'
          nullable: true
        offset:
          type: integer
          description: '<em>offset in the results array of returned domains</em><br>optional field<br>default value: <code>0</code><br>if you specify the <code>10</code> value, the first ten domains in the results array will be omitted and the data will be provided for the successive pages'
          nullable: true
        internal_list_limit:
          type: integer
          description: '<em>maximum number of elements within internal arrays</em><br>optional field<br>you can use this field to limit the number of elements within the following arrays:<br><code>referring_links_tld</code><br><code>referring_links_types</code><br><code>referring_links_attributes</code><br><code>referring_links_platform_types</code><br><code>referring_links_semantic_locations</code><p>default value: <code>10</code><br>maximum value: <code>1000</code>'
          nullable: true
        backlinks_status_type:
          type: string
          description: '<em>set what backlinks to return and count</em><br>optional field<br>you can use this field to choose what backlinks will be returned and used for aggregated metrics for your <code>target</code>;<br>possible values: <br><code>all</code> - all backlinks will be returned and counted;<br><code>live</code> - backlinks found during the last check will be returned and counted;<br><code>lost</code> - lost backlinks will be returned and counted;<p>default value: <code>live</code>'
          nullable: true
        filters:
          type: array
          items:
            type: object
            nullable: true
          description: '<em>array of results filtering parameters</em><br>optional field<br><strong>you can add several filters at once (8 filters maximum)</strong><br>you should set a logical operator <code>and</code>, <code>or</code> between the conditions<br>the following operators are supported:<br><code>regex</code>, <code>not_regex</code>, <code>=</code>, <code>&lt;&gt;</code>, <code>in</code>, <code>not_in</code>, <code>like</code>, <code>not_like</code>, <code>match</code>, <code>not_match</code><br>you can use the <code>%</code> operator with <code>like</code> and <code>not_like</code> to match any string of zero or more characters<br>example:<br><code>["referring_pages","&gt;","1"]</code><p><code>[["referring_pages","&gt;","2"],<br>"and",<br>["backlinks","&gt;","10"]]</code><p><code>[["first_seen",">","2017-10-23 11:31:45 +00:00"],<br>"and",<br>[["domain","like","%dataforseo.com%"],"or",["referring_domains","&gt;","10"]]]</code><p>The full list of possible filters is available <a href="/v3/backlinks/filters/?bash" rel="noopener noreferrer" target="_blank">here.</a>'
          nullable: true
        order_by:
          type: array
          items:
            type: string
          description: '<em>results sorting rules</em><br>optional field<br>you can use the same values as in the <code>filters</code> array to sort the results<br>possible sorting types:<br><code>asc</code> - results will be sorted in the ascending order<br><code>desc</code> - results will be sorted in the descending order<br>you should use a comma to set up a sorting type<br>example:<br><code>["backlinks,desc"]</code><br><strong>note that you can set no more than three sorting rules in a single request</strong><br>you should use a comma to separate several sorting rules<br>example:<br><code>["backlinks,desc","rank,asc"]</code>'
          nullable: true
        backlinks_filters:
          type: array
          items:
            type: object
            nullable: true
          description: '<em>filter the backlinks of your <code>target</code></em><br>optional field<br>you can use this field to filter the initial backlinks that will be included in the dataset for aggregated metrics for your <code>target</code><br>you can filter the backlinks by all fields available in the response of <a href="/v3/backlinks/backlinks/live">this endpoint</a><br>using this parameter, you can include only dofollow backlinks in the response and create a flexible backlinks dataset to calculate the metrics for<br>example:<br><code>"backlinks_filters": ["dofollow", "=", true]</code>'
          nullable: true
        include_subdomains:
          type: boolean
          description: '<em>indicates if the subdomains of the <code>target</code> will be included in the search</em><br>optional field<br>if set to <code>false</code>, the subdomains will be ignored<br>default value: <code>true</code>'
          nullable: true
        include_indirect_links:
          type: boolean
          description: '<em>indicates if indirect links to the <code>target</code> will be included in the results</em><br>optional field<br>if set to <code>true</code>, the results will include data on indirect links pointing to a page that either redirects to the target, or points to a canonical page<br>if set to <code>false</code>, indirect links will be ignored<br>default value: <code>true</code>'
          nullable: true
        exclude_internal_backlinks:
          type: boolean
          description: '<em>indicates whether the backlinks from subdomains of the <code>target</code> are excluded</em><br>optional field<br>if set to <code>false</code>, the backlinks from subdomains of the <code>target</code> will be ommited and you won''t receive the same domain in the response;<br>default value: <code>true</code>'
          nullable: true
        rank_scale:
          type: string
          description: '<em>defines the scale used for calculating and displaying the <code>rank</code>, <code>domain_from_rank</code>, and <code>page_from_rank</code> values</em><br>optional field<p>you can use this parameter to choose whether rank values are presented on a 0–100 or 0–1000 scale<p>possible values:<br><code>one_hundred</code> — rank values are displayed on a 0–100 scale<br><code>one_thousand</code> — rank values are displayed on a 0–1000 scale<p>default value: <code>one_thousand</code><p>learn more about how this parameter works and how ranking metrics are calculated in <a href="https://dataforseo.com/help-center/what_is_rank_in_backlinks_api#rank_scale">this Help Center article</a>'
          nullable: true
        tag:
          type: string
          description: <em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response
          nullable: true
      example:
        - target: backlinko.com
          limit: 5
          order_by:
            - 'rank,desc'
          exclude_internal_backlinks: true
          backlinks_filters:
            - dofollow
            - =
            - true
          filters:
            - backlinks
            - '>'
            - 100
    BacklinksReferringDomainsLiveItem:
      type: object
      properties:
        type:
          type: string
          description: type of element
          nullable: true
        domain:
          type: string
          description: <em>referring domain</em>
          nullable: true
        rank:
          type: integer
          description: <em>domain rank</em><br>rank volume that a referring website passes to the <code>target</code><br><code>rank</code> is calculated based on the method for node ranking in a linked database - a principle used in the original Google PageRank algorithm<br>learn more about the metric and how it is calculated in <a href="https://dataforseo.com/help-center/what_is_rank_in_backlinks_api" rel="noopener noreferrer" target="_blank">this help center article</a>
          nullable: true
        backlinks:
          type: integer
          description: <em>indicates the number of backlinks pointing to the <code>target</code></em>
          format: int64
          nullable: true
        first_seen:
          type: string
          description: '<em>date and time when our crawler found the backlink for the first time</em><br>in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”<br>example:<br><code>2019-11-15 12:57:46 +00:00</code>'
          nullable: true
        lost_date:
          type: string
          description: '<em>date and time when the last backlink from this domain was lost</em><br>indicates the date and time when our crawler visited the page and it responded with 4xx or 5xx status code or the last backlink was removed<br>in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”<br>example:<br><code>2017-01-24 13:20:59 +00:00</code>'
          nullable: true
        backlinks_spam_score:
          type: integer
          description: <em>average spam score of all backlinks pointing to the domain</em><br>learn more about how the metric is calculated on <a href="https://dataforseo.com/help-center/what-is-spam-score-and-how-is-it-calculated" rel="noopener noreferrer" target="_blank">this help center page</a>
          format: int64
          nullable: true
        broken_backlinks:
          type: integer
          description: <em>number of broken backlinks</em><br>number of broken backlinks pointing to the domain
          format: int64
          nullable: true
        broken_pages:
          type: integer
          description: <em>number of broken pages</em><br>number of pages that respond with 4xx or 5xx status codes where backlinks are pointing to
          nullable: true
        referring_domains:
          type: integer
          description: '<em>indicates the number of referring domains</em><br>note that we calculate main domains (root domains, like <code>example.com</code>) and their subdomains (e.g. <code>blog.example.com</code>) separately for this metric'
          format: int64
          nullable: true
        referring_domains_nofollow:
          type: integer
          description: <em>number of domains pointing at least one nofollow link to the <code>target</code></em>
          format: int64
          nullable: true
        referring_main_domains:
          type: integer
          description: <em>indicates the number of referring main domains</em><br>the number of primary (root) domains referring to your target
          format: int64
          nullable: true
        referring_main_domains_nofollow:
          type: integer
          description: <em>number of main domains pointing at least one nofollow link to the <code>target</code></em>
          format: int64
          nullable: true
        referring_ips:
          type: integer
          description: <em>number of referring IP addresses</em><br>number of IP addresses pointing to this page
          format: int64
          nullable: true
        referring_subnets:
          type: integer
          description: <em>number of referring subnetworks</em>
          format: int64
          nullable: true
        referring_pages:
          type: integer
          description: <em>indicates the number of pages pointing to the <code>target</code> specified</em>
          format: int64
          nullable: true
        referring_pages_nofollow:
          type: integer
          description: <em>number of referring pages pointing at least one nofollow link to the <code>target</code></em>
          format: int64
          nullable: true
        referring_links_tld:
          type: object
          additionalProperties:
            type: integer
            format: int64
            nullable: true
          description: <em>top-level domains of the referring links</em><br>contains top level domains and referring link count per each
          nullable: true
        referring_links_types:
          type: object
          additionalProperties:
            type: integer
            format: int64
            nullable: true
          description: '<em>types of referring links</em><br>indicates the types of the referring links and link count per each type<br>possible values:<br><code>anchor</code>, <code>image</code>, <code>link</code>, <code>meta</code>, <code>canonical</code>, <code>alternate</code>, <code>redirect</code>'
          nullable: true
        referring_links_attributes:
          type: object
          additionalProperties:
            type: integer
            format: int64
            nullable: true
          description: <em>link attributes of the referring links</em><br>indicates link attributes of the referring links and link count per each attribute
          nullable: true
        referring_links_platform_types:
          type: object
          additionalProperties:
            type: integer
            format: int64
            nullable: true
          description: '<em>types of referring platforms</em><br>indicates referring platform types and link count per each platform<p>possible values: <code>cms</code>, <code>blogs</code>, <code>ecommerce</code>, <code>message-boards</code>, <code>wikis</code>, <code>news</code>, <code>organization</code>'
          nullable: true
        referring_links_semantic_locations:
          type: object
          additionalProperties:
            type: integer
            format: int64
            nullable: true
          description: '<em>semantic locations of the referring links</em><br>indicates semantic elements in HTML where the referring links are located and the link count per each semantic location<p>you can get the full list of semantic elements <a href="https://www.w3schools.com/html/html5_semantic_elements.asp" target="_blank" rel="noopener noreferrer">here</a><br>examples:<br><code>article</code>, <code>section</code>, <code>summary</code>'
          nullable: true
        referring_links_countries:
          type: object
          additionalProperties:
            type: integer
            format: int64
            nullable: true
          description: <em>ISO country codes of the referring links</em><br>indicates ISO country codes of the domains where the referring links are located and the link count per each country
          nullable: true
    BacklinksReferringDomainsLiveResultInfo:
      type: object
      properties:
        target:
          type: string
          description: <em><code>target</code> in a POST array</em>
          nullable: true
        total_count:
          type: integer
          description: <em>total number of relevant items in the database</em><br>total number of main domains referring to your target;<br>example.com and blog.example.com are counted as one referring domain
          format: int64
          nullable: true
        items_count:
          type: integer
          description: <em>number of items in the <code>items</code> array</em>
          format: int64
          nullable: true
        items:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/BacklinksReferringDomainsLiveItem'
            nullable: true
          description: <em>items array</em>
          nullable: true
    BacklinksReferringDomainsLiveTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/BacklinksReferringDomainsLiveResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    BacklinksReferringDomainsLiveResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/BacklinksReferringDomainsLiveTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    BacklinksReferringNetworksLiveRequestInfo:
      type: object
      properties:
        target:
          type: string
          description: '<em>domain, subdomain or webpage to get referring networks for</em><br><strong>required field</strong><br>a domain or a subdomain should be specified without <code>https://</code> and <code>www.</code><br>a page should be specified with absolute URL (including <code>http://</code> or <code>https://</code>)'
        network_address_type:
          type: string
          description: '<em>indicates the type of network to get data for</em><br>optional field<br>possible values: <code>ip</code>, <code>subnet</code><br>default value: <code>ip</code>'
          nullable: true
        limit:
          type: integer
          description: '<em>the maximum number of returned networks</em><br>optional field<br>default value: <code>100</code><br>maximum value: <code>1000</code>'
          nullable: true
        offset:
          type: integer
          description: '<em>offset in the results array of returned networks</em><br>optional field<br>default value: <code>0</code><br>if you specify the <code>10</code> value, the first ten domains in the results array will be omitted and the data will be provided for the successive pages'
          nullable: true
        internal_list_limit:
          type: integer
          description: '<em>maximum number of elements within internal arrays</em><br>optional field<br>you can use this field to limit the number of elements within the following arrays:<br><code>referring_links_tld</code><br><code>referring_links_types</code><br><code>referring_links_attributes</code><br><code>referring_links_platform_types</code><br><code>referring_links_semantic_locations</code><p>default value: <code>10</code><br>maximum value: <code>1000</code>'
          nullable: true
        backlinks_status_type:
          type: string
          description: '<em>set what backlinks to return and count</em><br>optional field<br>you can use this field to choose what backlinks will be returned and used for aggregated metrics for your <code>target</code>;<br>possible values: <br><code>all</code> - all backlinks will be returned and counted;<br><code>live</code> - backlinks found during the last check will be returned and counted;<br><code>lost</code> - lost backlinks will be returned and counted;<p>default value: <code>live</code>'
          nullable: true
        filters:
          type: array
          items:
            type: object
            nullable: true
          description: '<em>array of results filtering parameters</em><br>optional field<br><strong>you can add several filters at once (8 filters maximum)</strong><br>you should set a logical operator <code>and</code>, <code>or</code> between the conditions<br>the following operators are supported:<br><code>regex</code>, <code>not_regex</code>, <code>=</code>, <code>&lt;&gt;</code>, <code>in</code>, <code>not_in</code>, <code>like</code>, <code>not_like</code>, <code>ilike</code>, <code>not_ilike</code>, <code>match</code>, <code>not_match</code><br>you can use the <code>%</code> operator with <code>like</code> and <code>not_like</code> to match any string of zero or more characters<br>example:<br><code>["referring_pages","&gt;","1"]</code><p><code>[["referring_pages","&gt;","2"],<br>"and",<br>["backlinks","&gt;","10"]]</code><p><code>[["first_seen",">","2017-10-23 11:31:45 +00:00"],<br>"and",<br>[["network_address","like","194.1.%"],"or",["referring_ips","&gt;","10"]]]</code><p>The full list of possible filters is available <a href="/v3/backlinks/filters/?bash" rel="noopener noreferrer" target="_blank">here.</a>'
          nullable: true
        order_by:
          type: array
          items:
            type: string
          description: '<em>results sorting rules</em><br>optional field<br>you can use the same values as in the <code>filters</code> array to sort the results<br>possible sorting types:<br><code>asc</code> - results will be sorted in the ascending order<br><code>desc</code> - results will be sorted in the descending order<br>you should use a comma to set up a sorting type<br>example:<br><code>["backlinks,desc"]</code><br><strong>note that you can set no more than three sorting rules in a single request</strong><br>you should use a comma to separate several sorting rules<br>example:<br><code>["backlinks,desc","rank,asc"]</code>'
          nullable: true
        backlinks_filters:
          type: array
          items:
            type: object
            nullable: true
          description: '<em>filter the backlinks of your <code>target</code></em><br>optional field<br>you can use this field to filter the initial backlinks that will be included in the dataset for aggregated metrics for your <code>target</code><br>you can filter the backlinks by all fields available in the response of <a href="/v3/backlinks/backlinks/live">this endpoint</a><br>using this parameter, you can include only dofollow backlinks in the response and create a flexible backlinks dataset to calculate the metrics for<br>example:<br><code>"backlinks_filters": [["dofollow", "=", true]]</code>'
          nullable: true
        include_subdomains:
          type: boolean
          description: '<em>indicates if the subdomains of the <code>target</code> will be included in the search</em><br>optional field<br>if set to <code>false</code>, the subdomains will be ignored<br>default value: <code>true</code>'
          nullable: true
        include_indirect_links:
          type: boolean
          description: '<em>indicates if indirect links to the <code>target</code> will be included in the results</em><br>optional field<br>if set to <code>true</code>, the results will include data on indirect links pointing to a page that either redirects to the target, or points to a canonical page<br>if set to <code>false</code>, indirect links will be ignored<br>default value: <code>true</code>'
          nullable: true
        exclude_internal_backlinks:
          type: boolean
          description: '<em>indicates whether the backlinks from subdomains of the <code>target</code> are excluded</em><br>optional field<br>if set to <code>false</code>, the backlinks from subdomains of the <code>target</code> will be ommited and you won''t receive the same domain in the response;<br>default value: <code>true</code>'
          nullable: true
        rank_scale:
          type: string
          description: '<em>defines the scale used for calculating and displaying the <code>rank</code>, <code>domain_from_rank</code>, and <code>page_from_rank</code> values</em><br>optional field<p>you can use this parameter to choose whether rank values are presented on a 0–100 or 0–1000 scale<p>possible values:<br><code>one_hundred</code> — rank values are displayed on a 0–100 scale<br><code>one_thousand</code> — rank values are displayed on a 0–1000 scale<p>default value: <code>one_thousand</code><p>learn more about how this parameter works and how ranking metrics are calculated in <a href="https://dataforseo.com/help-center/what_is_rank_in_backlinks_api#rank_scale">this Help Center article</a>'
          nullable: true
        tag:
          type: string
          description: <em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response
          nullable: true
      example:
        - target: backlinko.com
          network_address_type: subnet
          limit: 5
          order_by:
            - 'rank,desc'
          exclude_internal_backlinks: true
          backlinks_filters:
            - dofollow
            - =
            - true
          filters:
            - backlinks
            - '>'
            - 100
    BacklinksReferringNetworksLiveItem:
      type: object
      properties:
        type:
          type: string
          description: type of element
          nullable: true
        network_address:
          type: string
          description: <em>address of the referring subnetwork or IP</em>
          nullable: true
        rank:
          type: integer
          description: <em>network rank</em><br>rank volume that a referring network passes to the <code>target</code><br><code>rank</code> is calculated based on the method for node ranking in a linked database - a principle used in the original Google PageRank algorithm<br>learn more about the metric and how it is calculated in <a href="https://dataforseo.com/help-center/what_is_rank_in_backlinks_api" rel="noopener noreferrer" target="_blank">this help center article</a>
          nullable: true
        backlinks:
          type: integer
          description: <em>indicates the number of backlinks pointing to the <code>target</code></em>
          format: int64
          nullable: true
        first_seen:
          type: string
          description: '<em>date and time when our crawler found the backlink for the first time</em><br>in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”<br>example:<br><code>2019-11-15 12:57:46 +00:00</code>'
          nullable: true
        lost_date:
          type: string
          description: '<em>date and time when the last backlink from this domain was lost</em><br>indicates the date and time when our crawler visited the page and it responded with 4xx or 5xx status code or the last backlink was removed<br>in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”<br>example:<br><code>2017-01-24 13:20:59 +00:00</code>'
          nullable: true
        broken_backlinks:
          type: integer
          description: <em>number of broken backlinks</em><br>number of broken backlinks pointing to the domain
          format: int64
          nullable: true
        broken_pages:
          type: integer
          description: <em>number of broken pages</em><br>number of pages that respond with 4xx or 5xx status codes where backlinks are pointing to
          nullable: true
        referring_domains:
          type: integer
          description: <em>indicates the number of referring domains</em><br>referring domains include subdomains that are counted as separate domains for this metric
          format: int64
          nullable: true
        referring_domains_nofollow:
          type: integer
          description: <em>number of domains pointing at least one nofollow link to the <code>target</code></em>
          format: int64
          nullable: true
        referring_main_domains:
          type: integer
          description: <em>indicates the number of referring main domains</em>
          format: int64
          nullable: true
        referring_main_domains_nofollow:
          type: integer
          description: <em>number of main domains pointing at least one nofollow link to the <code>target</code></em>
          format: int64
          nullable: true
        referring_ips:
          type: integer
          description: <em>number of referring IP addresses</em><br>number of IP addresses pointing to this page
          format: int64
          nullable: true
        referring_subnets:
          type: integer
          description: <em>number of referring subnetworks</em>
          format: int64
          nullable: true
        referring_pages:
          type: integer
          description: <em>indicates the number of pages pointing to the <code>target</code> specified</em>
          format: int64
          nullable: true
        referring_pages_nofollow:
          type: integer
          description: <em>number of referring pages pointing at least one nofollow link to the <code>target</code></em>
          format: int64
          nullable: true
        referring_links_tld:
          type: object
          additionalProperties:
            type: integer
            format: int64
            nullable: true
          description: <em>top-level domains of the referring links</em><br>contains top level domains and referring link count per each
          nullable: true
        referring_links_types:
          type: object
          additionalProperties:
            type: integer
            format: int64
            nullable: true
          description: '<em>types of referring links</em><br>indicates the types of the referring links and link count per each type<br>possible values:<br><code>anchor</code>, <code>image</code>, <code>link</code>, <code>meta</code>, <code>canonical</code>, <code>alternate</code>, <code>redirect</code>'
          nullable: true
        referring_links_attributes:
          type: object
          additionalProperties:
            type: integer
            format: int64
            nullable: true
          description: <em>link attributes of the referring links</em><br>indicates link attributes of the referring links and link count per each attribute
          nullable: true
        referring_links_platform_types:
          type: object
          additionalProperties:
            type: integer
            format: int64
            nullable: true
          description: '<em>types of referring platforms</em><br>indicates referring platform types and and link count per each platform<p>possible values: <code>cms</code>, <code>blogs</code>, <code>ecommerce</code>, <code>message-boards</code>, <code>wikis</code>, <code>news</code>, <code>organization</code>'
          nullable: true
        referring_links_semantic_locations:
          type: object
          additionalProperties:
            type: integer
            format: int64
            nullable: true
          description: '<em>semantic locations of the referring links</em><br>indicates semantic elements in HTML where the referring links are located and the link count per each semantic location<p>you can get the full list of semantic elements <a href="https://www.w3schools.com/html/html5_semantic_elements.asp" target="_blank" rel="noopener noreferrer">here</a><br>examples:<br><code>article</code>, <code>section</code>, <code>summary</code>'
          nullable: true
        referring_links_countries:
          type: object
          additionalProperties:
            type: integer
            format: int64
            nullable: true
          description: <em>ISO country codes of the referring links</em><br>indicates ISO country codes of the domains where the referring links are located and the link count per each country
          nullable: true
    BacklinksReferringNetworksLiveResultInfo:
      type: object
      properties:
        target:
          type: string
          description: <em><code>target</code> in a POST array</em>
          nullable: true
        total_count:
          type: integer
          description: <em>total number of relevant items in the database</em>
          format: int64
          nullable: true
        items_count:
          type: integer
          description: <em>number of items in the <code>items</code> array</em>
          format: int64
          nullable: true
        items:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/BacklinksReferringNetworksLiveItem'
            nullable: true
          description: <em>items array</em>
          nullable: true
    BacklinksReferringNetworksLiveTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/BacklinksReferringNetworksLiveResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    BacklinksReferringNetworksLiveResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/BacklinksReferringNetworksLiveTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    BacklinksCompetitorsLiveRequestInfo:
      type: object
      properties:
        target:
          type: string
          description: '<em>domain, subdomain or webpage to get competitor domains for</em><br><strong>required field</strong><br>a domain or a subdomain should be specified without <code>https://</code> and <code>www.</code><br>a page should be specified with absolute URL (including <code>http://</code> or <code>https://</code>)'
        limit:
          type: integer
          description: '<em>the maximum number of returned domains</em><br>optional field<br>default value: <code>100</code><br>maximum value: <code>1000</code>'
          nullable: true
        offset:
          type: integer
          description: '<em>offset in the results array of returned domains</em><br>optional field<br>default value: <code>0</code><br>if you specify the <code>10</code> value, the first ten domains in the results array will be omitted and the data will be provided for the successive pages'
          nullable: true
        filters:
          type: array
          items:
            type: object
            nullable: true
          description: '<em>array of results filtering parameters</em><br>optional field<br><strong>you can add several filters at once (8 filters maximum)</strong><br>you should set a logical operator <code>and</code>, <code>or</code> between the conditions<br>the following operators are supported:<br><code>regex</code>, <code>not_regex</code>, <code>=</code>, <code>&lt;&gt;</code>, <code>in</code>, <code>not_in</code>, <code>like</code>, <code>not_like</code>, <code>ilike</code>, <code>not_ilike</code>, <code>match</code>, <code>not_match</code><br>you can use the <code>%</code> operator with <code>like</code> and <code>not_like</code> to match any string of zero or more characters<br>example:<br><code>["rank","&gt;","100"]</code><p><code>[["target","like","%forbes%"],<br>"and",<br>[["rank","&gt;","100"],"or",["intersections","&gt;","5"]]]</code><p>The full list of possible filters is available <a href="/v3/backlinks/filters/?bash" rel="noopener noreferrer" target="_blank">here.</a>'
          nullable: true
        order_by:
          type: array
          items:
            type: string
          description: '<em>results sorting rules</em><br>optional field<br>you can use the same values as in the <code>filters</code> array to sort the results<br>possible sorting types:<br><code>asc</code> - results will be sorted in the ascending order<br><code>desc</code> - results will be sorted in the descending order<br>you should use a comma to set up a sorting type<br>example:<br><code>["rank,desc"]</code><br><strong>note that you can set no more than three sorting rules in a single request</strong><br>you should use a comma to separate several sorting rules<br>example:<br><code>["intersections,desc","rank,asc"]</code>'
          nullable: true
        main_domain:
          type: boolean
          description: '<em>indicates if only main domain of the <code>target</code> will be included in the search</em><br>optional field<br>if set to <code>true</code>, only the main domain will be included in search;<br>default value: <code>true</code>'
          nullable: true
        exclude_large_domains:
          type: boolean
          description: '<em>indicates whether large domain will appear in results</em><br>optional field<br>if set to <code>true</code>, the results from the large domain (google.com, amazon.com, etc.) will be omitted;<br>default value: <code>true</code>'
          nullable: true
        exclude_internal_backlinks:
          type: boolean
          description: '<em>indicates if internal backlinks from subdomains to the <code>target</code> will be excluded from the results</em><br>optional field<br>if set to <code>true</code>, the results will not include data on internal backlinks from subdomains of the same domain as <code>target</code><br>if set to <code>false</code>, internal links will be included in the results<br>default value: <code>true</code>'
          nullable: true
        rank_scale:
          type: string
          description: '<em>defines the scale used for calculating and displaying the <code>rank</code>, <code>domain_from_rank</code>, and <code>page_from_rank</code> values</em><br>optional field<p>you can use this parameter to choose whether rank values are presented on a 0–100 or 0–1000 scale<p>possible values:<br><code>one_hundred</code> — rank values are displayed on a 0–100 scale<br><code>one_thousand</code> — rank values are displayed on a 0–1000 scale<p>default value: <code>one_thousand</code><p>learn more about how this parameter works and how ranking metrics are calculated in <a href="https://dataforseo.com/help-center/what_is_rank_in_backlinks_api#rank_scale">this Help Center article</a>'
          nullable: true
        tag:
          type: string
          description: <em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response
          nullable: true
      example:
        - target: dataforseo.com
          filters:
            - rank
            - '>'
            - 100
          order_by:
            - 'rank,desc'
          limit: 5
    BacklinksCompetitorsLiveItem:
      type: object
      properties:
        type:
          type: string
          description: type of element
          nullable: true
        target:
          type: string
          description: <em>competitor domain</em>
          nullable: true
        rank:
          type: integer
          description: <em>domain rank</em><br>domain rank across all domains in the database<br><code>rank</code> is calculated based on the method for node ranking in a linked database - a principle used in the original Google PageRank algorithm<br>learn more about the metric and how it is calculated in <a href="https://dataforseo.com/help-center/what_is_rank_in_backlinks_api" rel="noopener noreferrer" target="_blank">this help center article</a>
          nullable: true
        intersections:
          type: integer
          description: <em>indicates the number of backlink intersections with the <code>target</code> specified in the POST array</em>
          nullable: true
    BacklinksCompetitorsLiveResultInfo:
      type: object
      properties:
        total_count:
          type: integer
          description: <em>total number of relevant items in the database</em>
          format: int64
          nullable: true
        items_count:
          type: integer
          description: <em>number of items in the <code>items</code> array</em>
          format: int64
          nullable: true
        items:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/BacklinksCompetitorsLiveItem'
            nullable: true
          description: <em>items array</em>
          nullable: true
    BacklinksCompetitorsLiveTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/BacklinksCompetitorsLiveResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    BacklinksCompetitorsLiveResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/BacklinksCompetitorsLiveTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    BacklinksDomainIntersectionLiveRequestInfo:
      type: object
      properties:
        targets:
          type: object
          additionalProperties:
            type: string
            nullable: true
          description: '<em>domains, subdomains or webpages to get links for</em><br><strong>required field</strong><br>you can set up to 20 domains, subdomains or webpages<br>a domain or a subdomain should be specified without <code>https://</code> and <code>www.</code><br>a page should be specified with absolute URL (including <code>http://</code> or <code>https://</code>)<br>example:<br>`"targets": {<br>"1": "http://planet.postgresql.org/",<br>"2": "http://gborg.postgresql.org/"<br>}`'
          nullable: true
        exclude_targets:
          type: array
          items:
            type: string
          description: '<em>domains, subdomains or webpages you want to exclude</em><br>optional field<br>you can specify up to 10 domains, subdomains or webpages<br>if you use this array, results will contain the referring domains that link to <code>targets</code> but don''t link to <code>exclude_targets</code><br>example:<br>`"exclude_targets": [<br>"bbc.com",<br>"https://www.apple.com/iphone/*",<br>"https://dataforseo.com/apis/*"]`'
          nullable: true
        filters:
          type: array
          items:
            type: object
            nullable: true
          description: '<em>array of results filtering parameters</em><br>optional field<br><strong>you can add several filters at once (8 filters maximum)</strong><br>you should set a logical operator <code>and</code>, <code>or</code> between the conditions<br>the following operators are supported:<br><code>regex</code>, <code>not_regex</code>, <code>=</code>, <code>&lt;&gt;</code>, <code>in</code>, <code>not_in</code>, <code>like</code>, <code>not_like</code>, <code>ilike</code>, <code>not_ilike</code>, <code>match</code>, <code>not_match</code><br>you can use the <code>%</code> operator with <code>like</code> and <code>not_like</code> to match any string of zero or more characters<br>example:<br><code>["1.internal_links_count","&gt;","1"]</code><p><code>[["2.referring_pages","&gt;","2"],<br>"and",<br>["1.backlinks","&gt;","10"]]</code><p><code>[["1.first_seen",">","2017-10-23 11:31:45 +00:00"],<br>"and",<br>[["2.target","like","%dataforseo.com%"],"or",["1.referring_domains","&gt;","10"]]]</code><p>The full list of possible filters is available <a href="/v3/backlinks/filters/?bash" rel="noopener noreferrer" target="_blank">here.</a>'
          nullable: true
        order_by:
          type: array
          items:
            type: string
          description: '<em>results sorting rules</em><br>optional field<br>you can use the same values as in the <code>filters</code> array to sort the results<br>possible sorting types:<br><code>asc</code> - results will be sorted in the ascending order<br><code>desc</code> - results will be sorted in the descending order<br>you should use a comma to set up a sorting type<br>example:<br><code>["backlinks,desc"]</code><br><strong>note that you can set no more than three sorting rules in a single request</strong><br>you should use a comma to separate several sorting rules<br>example:<br><code>["backlinks,desc","rank,asc"]</code>'
          nullable: true
        offset:
          type: integer
          description: '<em>offset in the array of returned results</em><br>optional field<br>default value: <code>0</code><br>if you specify the <code>10</code> value, the first ten backlinks in the results array will be omitted and the data will be provided for the successive backlinks'
          nullable: true
        limit:
          type: integer
          description: '<em>the maximum number of returned results</em><br>optional field<br>default value: <code>100</code><br>maximum value: <code>1000</code>'
          nullable: true
        internal_list_limit:
          type: integer
          description: '<em>maximum number of elements within internal arrays</em><br>optional field<br>you can use this field to limit the number of elements within the following arrays:<br><code>referring_links_tld</code><br><code>referring_links_types</code><br><code>referring_links_attributes</code><br><code>referring_links_platform_types</code><br><code>referring_links_semantic_locations</code><p>default value: <code>10</code><br>maximum value: <code>1000</code>'
          nullable: true
        backlinks_status_type:
          type: string
          description: '<em>set what backlinks to return and count</em><br>optional field<br>you can use this field to choose what backlinks will be returned and used for aggregated metrics for your <code>targets</code>;<br>possible values: <br><code>all</code> - all backlinks will be returned and counted;<br><code>live</code> - backlinks found during the last check will be returned and counted;<br><code>lost</code> - lost backlinks will be returned and counted;<p>default value: <code>live</code>'
          nullable: true
        backlinks_filters:
          type: array
          items:
            type: object
            nullable: true
          description: '<em>filter the backlinks of your <code>target</code></em><br>optional field<br>you can use this field to filter the initial backlinks that will be included in the dataset for aggregated metrics for your <code>target</code><br>you can filter the backlinks by all fields available in the response of <a href="/v3/backlinks/backlinks/live">this endpoint</a><br>using this parameter, you can include only dofollow backlinks in the response and create a flexible backlinks dataset to calculate the metrics for<br>example:<br><code>"backlinks_filters": [["dofollow", "=", true]]</code>'
          nullable: true
        include_subdomains:
          type: boolean
          description: '<em>indicates if the subdomains of the <code>target</code> will be included in the search</em><br>optional field<br>if set to <code>false</code>, the subdomains will be ignored<br>default value: <code>true</code>'
          nullable: true
        include_indirect_links:
          type: boolean
          description: '<em>indicates if indirect links to the <code>targets</code> will be included in the results</em><br>optional field<br>if set to <code>true</code>, the results will include data on indirect links pointing to a page that either redirects to a target, or points to a canonical page<br>if set to <code>false</code>, indirect links will be ignored<br>default value: <code>true</code>'
          nullable: true
        exclude_internal_backlinks:
          type: boolean
          description: '<em>indicates whether the backlinks from subdomains of the <code>target</code> are excluded</em><br>optional field<br>if set to <code>false</code>, the backlinks from subdomains of the <code>target</code> will be omitted and you won''t receive the same domain in the response;<br>default value: <code>true</code>'
          nullable: true
        intersection_mode:
          type: string
          description: '<em>indicates whether to intersect backlinks</em><br>optional field<br>use this field to intersect or merge results for the specified domains<br>possible values: <code>all</code>, <code>partial</code><br><code>all</code> - results are based on all backlinks;<br><code>partial</code> - results are based on the intersecting backlinks only;<br>default value: <code>all</code>'
          nullable: true
        rank_scale:
          type: string
          description: '<em>defines the scale used for calculating and displaying the <code>rank</code>, <code>domain_from_rank</code>, and <code>page_from_rank</code> values</em><br>optional field<p>you can use this parameter to choose whether rank values are presented on a 0–100 or 0–1000 scale<p>possible values:<br><code>one_hundred</code> — rank values are displayed on a 0–100 scale<br><code>one_thousand</code> — rank values are displayed on a 0–1000 scale<p>default value: <code>one_thousand</code><p>learn more about how this parameter works and how ranking metrics are calculated in <a href="https://dataforseo.com/help-center/what_is_rank_in_backlinks_api#rank_scale">this Help Center article</a>'
          nullable: true
        tag:
          type: string
          description: <em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response
          nullable: true
      example:
        - targets:
            '1': moz.com
            '2': ahrefs.com
          include_subdomains: false
          exclude_targets:
            - semrush.com
          limit: 5
          order_by:
            - '1.backlinks,desc'
          exclude_internal_backlinks: true
    BacklinksDomainIntersection:
      type: object
      properties:
        type:
          type: string
          description: type of element
          nullable: true
        target:
          type: string
          description: <em>domain that links to the corresponding target from the POST array</em>
          nullable: true
        rank:
          type: integer
          description: <em>rank referred to the <code>target</code> from the POST array</em><br>indicates the rank that the referring domain (<code>target</code> above) refers to your target from the POST array;<br><code>rank</code> is calculated based on the method for node ranking in a linked database - a principle used in the original Google PageRank algorithm<br>learn more about the metric and how it is calculated in <a href="https://dataforseo.com/help-center/what_is_rank_in_backlinks_api" rel="noopener noreferrer" target="_blank">this help center article</a>
          nullable: true
        backlinks:
          type: integer
          description: <em>indicates the number of backlinks</em>
          format: int64
          nullable: true
        first_seen:
          type: string
          description: '<em>date and time when our crawler found the backlink from this <code>target</code> for the first time</em><br>in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”<br>example:<br><code>2019-11-15 12:57:46 +00:00</code>'
          nullable: true
        lost_date:
          type: string
          description: '<em>date and time when the last backlink from this <code>target</code> was lost</em><br>indicates the date and time when our crawler visited the page and it responded with 4xx or 5xx status code or the last backlink was removed<br>in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”<br>example:<br><code>2019-11-15 12:57:46 +00:00</code>'
          nullable: true
        backlinks_spam_score:
          type: integer
          description: <em>average spam score of the backlinks pointing to the <code>target</code></em><br>learn more about how the metric is calculated on <a href="https://dataforseo.com/help-center/what-is-spam-score-and-how-is-it-calculated" rel="noopener noreferrer" target="_blank">this help center page</a>
          format: int64
          nullable: true
        broken_backlinks:
          type: integer
          description: <em>number of broken backlinks</em>
          format: int64
          nullable: true
        broken_pages:
          type: integer
          description: <em>number of broken pages</em>
          nullable: true
        referring_domains:
          type: integer
          description: <em>number of referring domains</em>
          format: int64
          nullable: true
        referring_domains_nofollow:
          type: integer
          description: <em>number of domains pointing at least one nofollow link to the corresponding target</em>
          format: int64
          nullable: true
        referring_main_domains:
          type: integer
          description: <em>number of referring main domains</em>
          format: int64
          nullable: true
        referring_main_domains_nofollow:
          type: integer
          description: <em>number of main domains pointing at least one nofollow link to the <code>target</code></em>
          format: int64
          nullable: true
        referring_ips:
          type: integer
          description: <em>number of referring IP addresses</em>
          format: int64
          nullable: true
        referring_subnets:
          type: integer
          description: <em>number of referring subnetworks</em>
          format: int64
          nullable: true
        referring_pages:
          type: integer
          description: <em>indicates the number of pages pointing to the <code>target</code></em>
          format: int64
          nullable: true
        referring_pages_nofollow:
          type: integer
          description: <em>number of referring pages pointing at least one nofollow link to the <code>target</code></em>
          format: int64
          nullable: true
        referring_links_tld:
          type: object
          additionalProperties:
            type: integer
            nullable: true
          description: <em>top level domains of the referring links</em><br>contains top-level domains and referring link count per each
          nullable: true
        referring_links_types:
          type: object
          additionalProperties:
            type: integer
            nullable: true
          description: '<em>types of the referring links</em><br>indicates the types of referring links and link count per each type<br>possible values:<br><code>anchor</code>, <code>image</code>, <code>link</code>, <code>meta</code>, <code>canonical</code>, <code>alternate</code>, <code>redirect</code>'
          nullable: true
        referring_links_attributes:
          type: object
          additionalProperties:
            type: integer
            nullable: true
          description: <em>link attributes of the referring links</em><br>indicates link attributes of the referring links and the link count per each attribute
          nullable: true
        referring_links_platform_types:
          type: object
          additionalProperties:
            type: integer
            nullable: true
          description: '<em>types of referring platforms</em><br>indicates referring platform types and link count per each platform<p>possible values: <code>cms</code>, <code>blogs</code>, <code>ecommerce</code>, <code>message-boards</code>, <code>wikis</code>, <code>news</code>, <code>organization</code>'
          nullable: true
        referring_links_semantic_locations:
          type: object
          additionalProperties:
            type: integer
            nullable: true
          description: <em>semantic locations of the referring links</em><br>indicates semantic elements in HTML where the referring links are located and the link count per each semantic location<br>you can get the full list of semantic elements <a href="https://www.w3schools.com/html/html5_semantic_elements.asp" rel="noopener noreferrer" target="_blank">here</a>
          nullable: true
        referring_links_countries:
          type: object
          description: <em>ISO country codes of the referring links</em><br>indicates ISO country codes of the domains where the referring links are located and the link count per each country
          nullable: true
    IntersectionSummaryInfo:
      type: object
      properties:
        intersections_count:
          type: integer
          description: <em>total number of intersections</em>
          format: int64
          nullable: true
    BacklinksDomainIntersectionLiveItem:
      type: object
      properties:
        domain_intersection:
          type: object
          additionalProperties:
            type: object
            oneOf:
              - $ref: '#/components/schemas/BacklinksDomainIntersection'
            nullable: true
          description: '<em>contains data on domains that link to the corresponding targets specified in the POST array</em><br>data is provided in separate objects corresponding to domains, subdomains or pages specified in the <code>targets</code> object'
          nullable: true
        summary:
          type: object
          oneOf:
            - $ref: '#/components/schemas/IntersectionSummaryInfo'
          description: <em>contains the domain intersections summary</em>
          nullable: true
    BacklinksDomainIntersectionLiveResultInfo:
      type: object
      properties:
        targets:
          type: object
          additionalProperties:
            type: string
            nullable: true
          description: '<em>target domains, subdomains or webpages in a POST array</em>'
          nullable: true
        total_count:
          type: integer
          description: <em>total amount of results relevant to your request</em>
          format: int64
          nullable: true
        items_count:
          type: integer
          description: <em>the number of results returned in the <code>items</code> array</em>
          format: int64
          nullable: true
        items:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/BacklinksDomainIntersectionLiveItem'
            nullable: true
          description: <em>contains domain that link to all <code>targets</code> from the POST array</em>
          nullable: true
    BacklinksDomainIntersectionLiveTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/BacklinksDomainIntersectionLiveResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    BacklinksDomainIntersectionLiveResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/BacklinksDomainIntersectionLiveTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    BacklinksPageIntersectionLiveRequestInfo:
      type: object
      properties:
        targets:
          type: object
          additionalProperties:
            type: string
            nullable: true
          description: '<em>domains, subdomains or webpages to get links for</em><br><strong>required field</strong><br>you can set up to 20 domains, subdomains or webpages<br>a domain or a subdomain should be specified without <code>https://</code> and <code>www.</code><br>a page should be specified with absolute URL (including <code>http://</code> or <code>https://</code>)<br>example:<br>`"targets": {<br>"1": "http://planet.postgresql.org/",<br>"2": "http://gborg.postgresql.org/"<br>}`'
          nullable: true
        exclude_targets:
          type: array
          items:
            type: string
          description: '<em>domains, subdomains or webpages you want to exclude</em><br>optional field<br>you can set up to 10 domains, subdomains or webpages<br>if you use this array, results will contain the referring pages that link to <code>targets</code> but don''t link to <code>exclude_targets</code><br>example:<br>`"exclude_targets": [<br>"bbc.com",<br>"https://www.apple.com/iphone/*",<br>"https://dataforseo.com/apis/*"]`'
          nullable: true
        backlinks_status_type:
          type: string
          description: '<em>set what backlinks to return and count</em><br>optional field<br>you can use this field to choose what backlinks will be returned and used for aggregated metrics for your <code>targets</code>;<br>possible values: <br><code>all</code> - all backlinks will be returned and counted;<br><code>live</code> - backlinks found during the last check will be returned and counted;<br><code>lost</code> - lost backlinks will be returned and counted;<p>default value: <code>live</code>'
          nullable: true
        filters:
          type: array
          items:
            type: object
            nullable: true
          description: '<em>array of results filtering parameters</em><br>optional field<br><strong>you can add several filters at once (8 filters maximum)</strong><br>you should set a logical operator <code>and</code>, <code>or</code> between the conditions<br>the following operators are supported:<br><code>regex</code>, <code>not_regex</code>, <code>=</code>, <code>&lt;&gt;</code>, <code>in</code>, <code>not_in</code>, <code>like</code>, <code>not_like</code>, <code>ilike</code>, <code>not_ilike</code>, <code>match</code>, <code>not_match</code><br>you can use the <code>%</code> operator with <code>like</code> and <code>not_like</code> to match any string of zero or more characters<br>example:<br><code>["1.rank","&gt;","80"]</code><p><code>[["2.page_from_rank","&gt;","55"],<br>"and",<br>["1.original","=","true"]]</code><p><code>[["1.first_seen",">","2017-10-23 11:31:45 +00:00"],<br>"and",<br>[["1.acnhor","like","%seo%"],"or",["1.text_pre","not_like","%seo%"]]]</code><p>The full list of possible filters is available <a href="/v3/backlinks/filters/?bash" rel="noopener noreferrer" target="_blank">here.</a>'
          nullable: true
        order_by:
          type: array
          items:
            type: string
          description: '<em>results sorting rules</em><br>optional field<br>you can use the same values as in the <code>filters</code> array to sort the results<br>possible sorting types:<br><code>asc</code> - results will be sorted in the ascending order<br><code>desc</code> - results will be sorted in the descending order<br>you should use a comma to set up a sorting type<br>example:<br><code>["rank,desc"]</code><br><strong>note that you can set no more than three sorting rules in a single request</strong><br>you should use a comma to separate several sorting rules<br>example:<br><code>["domain_from_rank,desc","page_from_rank,asc"]</code>'
          nullable: true
        offset:
          type: integer
          description: '<em>offset in the results array of the returned backlinks</em><br>optional field<p>default value: <code>0</code><br>if you specify the <code>10</code> value, the first ten backlinks in the results array will be omitted and the data will be provided for the successive backlinks'
          nullable: true
        limit:
          type: integer
          description: '<em>the maximum number of returned backlinks</em><br>optional field<p>default value: <code>100</code><br>maximum value: <code>1000</code>'
          nullable: true
        internal_list_limit:
          type: integer
          description: '<em>maximum number of elements within internal arrays</em><br>optional field<br>you can use this field to limit the number of elements within the following arrays:<br><code>attributes</code><br><code>domain_from_platform_type</code><p>default value: <code>10</code><br>maximum value: <code>1000</code>'
          nullable: true
        include_subdomains:
          type: boolean
          description: '<em>indicates if the subdomains of the <code>targets</code> will be included in the search</em><br>optional field<br>if set to <code>false</code>, the subdomains will be ignored<br>default value: <code>true</code>'
          nullable: true
        include_indirect_links:
          type: boolean
          description: '<em>indicates if indirect links to the <code>targets</code> will be included in the results</em><br>optional field<br>if set to <code>true</code>, the results will include data on indirect links pointing to a page that either redirects to a target, or points to a canonical page<br>if set to <code>false</code>, indirect links will be ignored<br>default value: <code>true</code>'
          nullable: true
        exclude_internal_backlinks:
          type: boolean
          description: '<em>indicates if internal backlinks from subdomains to the <code>target</code> will be excluded from the results</em><br>optional field<br>if set to <code>true</code>, the results will not include data on internal backlinks from subdomains of the same domain as <code>target</code><br>if set to <code>false</code>, internal links will be included in the result<br>default value: <code>true</code>'
          nullable: true
        intersection_mode:
          type: string
          description: '<em>indicates whether to intersect backlinks</em><br>optional field<br>use this field to intersect or merge results for the specified URLs<br>possible values: <code>all</code>, <code>partial</code><br><code>all</code> - results are based on all backlinks;<br><code>partial</code> - results are based on the intersecting backlinks only;<br>default value: <code>all</code>'
          nullable: true
        rank_scale:
          type: string
          description: '<em>defines the scale used for calculating and displaying the <code>rank</code>, <code>domain_from_rank</code>, and <code>page_from_rank</code> values</em><br>optional field<p>you can use this parameter to choose whether rank values are presented on a 0–100 or 0–1000 scale<p>possible values:<br><code>one_hundred</code> — rank values are displayed on a 0–100 scale<br><code>one_thousand</code> — rank values are displayed on a 0–1000 scale<p>default value: <code>one_thousand</code><p>learn more about how this parameter works and how ranking metrics are calculated in <a href="https://dataforseo.com/help-center/what_is_rank_in_backlinks_api#rank_scale">this Help Center article</a>'
          nullable: true
        tag:
          type: string
          description: <em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response
          nullable: true
      example:
        - targets:
            '1': football.com
            '2': fifa.com
          exclude_targets:
            - skysports.com
          limit: 5
          order_by:
            - '1.rank,desc'
          filters:
            - 
              - 2.domain_from_rank
              - '>'
              - 400
            - and
            - 
              - 1.dofollow
              - =
              - true
    BacklinksPageIntersection:
      type: object
      properties:
        type:
          type: string
          description: type of element
          nullable: true
        domain_from:
          type: string
          description: <em>domain referring to the target domain or webpage</em>
          nullable: true
        url_from:
          type: string
          description: <em>URL of the page where the backlink is found</em>
          nullable: true
        url_from_https:
          type: boolean
          description: '<em>indicates whether the referring URL is secured with HTTPS</em><br>if <code>true</code>, the referring URL is secured with HTTPS'
          nullable: true
        domain_to:
          type: string
          description: <em>domain the backlink is pointing to</em>
          nullable: true
        url_to:
          type: string
          description: <em>URL the backlink is pointing to</em>
          nullable: true
        url_to_https:
          type: boolean
          description: '<em>indicates if the URL the backlink is pointing to is secured with HTTPS</em><br>if <code>true</code>, the URL is secured with HTTPS'
          nullable: true
        tld_from:
          type: string
          description: <em>top-level domain of the referring URL</em>
          nullable: true
        is_new:
          type: boolean
          description: '<em>indicates whether the backlink is new</em><br>if <code>true</code>, the backlink was found on the page last time our crawler visited it'
          nullable: true
        is_lost:
          type: boolean
          description: '<em>indicates whether the backlink was removed</em><br>if <code>true</code>, the backlink or the entire page was removed'
          nullable: true
        backlink_spam_score:
          type: integer
          description: <em>spam score of the backlink</em><br>learn more about how the metric is calculated on <a href="https://dataforseo.com/help-center/what-is-spam-score-and-how-is-it-calculated" rel="noopener noreferrer" target="_blank">this help center page</a>
          nullable: true
        rank:
          type: integer
          description: <em>backlink rank</em><br><code>rank</code> is calculated based on the method for node ranking in a linked database - a principle used in the original Google PageRank algorithm<br>learn more about the metric and how it is calculated in <a href="https://dataforseo.com/help-center/what_is_rank_in_backlinks_api" rel="noopener noreferrer" target="_blank">this help center article</a>
          nullable: true
        page_from_rank:
          type: integer
          description: <em>page rank of the referring page</em><br><code>page_from_rank</code> is calculated based on the method for node ranking in a linked database - a principle used in the original Google PageRank algorithm<br>learn more about the metric and how it is calculated in <a href="https://dataforseo.com/help-center/what_is_rank_in_backlinks_api" rel="noopener noreferrer" target="_blank">this help center article</a>
          nullable: true
        domain_from_rank:
          type: integer
          description: <em>domain rank of the referring domain</em><br>indicates the rank of the domain at the time our crawler last saw the backlink;<br><code>domain_from_rank</code> is calculated based on the method for node ranking in a linked database - a principle used in the original Google PageRank algorithm<br>learn more about the metric and how it is calculated in <a href="https://dataforseo.com/help-center/what_is_rank_in_backlinks_api" rel="noopener noreferrer" target="_blank">this help center article</a>
          nullable: true
        domain_from_platform_type:
          type: array
          items:
            type: string
            nullable: true
          description: '<em>platform types of the referring domain</em><p>possible values: <code>cms</code>, <code>blogs</code>, <code>ecommerce</code>, <code>message-boards</code>, <code>wikis</code>, <code>news</code>, <code>organization</code>'
          nullable: true
        domain_from_is_ip:
          type: boolean
          description: '<em>indicates if the domain is IP</em><br>if <code>true</code>, the domain functions as an IP address and does not have a domain name'
          nullable: true
        domain_from_ip:
          type: string
          description: <em>IP address of the referring domain</em>
          nullable: true
        domain_from_country:
          type: string
          description: <em>ISO country code of the referring domain</em>
          nullable: true
        page_from_external_links:
          type: integer
          description: <em>number of external links found on the referring page</em>
          nullable: true
        page_from_internal_links:
          type: integer
          description: <em>number of internal links found on the referring page</em>
          nullable: true
        page_from_size:
          type: integer
          description: '<em>size of the referring page, in bytes</em><br>example:<br><code>63357</code>'
          nullable: true
        page_from_encoding:
          type: string
          description: <em>character encoding of the referring page</em><br>example:<br><code>utf-8</code>
          nullable: true
        page_from_language:
          type: string
          description: <em>language of the referring page</em><br>in ISO 639-1 format<br>example:<br><code>en</code>
          nullable: true
        page_from_title:
          type: string
          description: <em>title of the referring page</em>
          nullable: true
        page_from_status_code:
          type: integer
          description: <em>HTTP status code returned by the referring page</em><br>example:<br><code>200</code>
          nullable: true
        first_seen:
          type: string
          description: '<em>date and time when our crawler found the backlink for the first time</em><br>in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”<br>example:<br><code>2019-11-15 12:57:46 +00:00</code>'
          nullable: true
        prev_seen:
          type: string
          description: '<em>previous to the most recent date when our crawler visited the backlink</em><br>in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”<br>example:<br><code>2019-11-15 12:57:46 +00:00</code>'
          nullable: true
        last_seen:
          type: string
          description: '<em>most recent date when our crawler visited the backlink</em><br>in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”<br>example:<br><code>2019-11-15 12:57:46 +00:00</code>'
          nullable: true
        item_type:
          type: string
          description: '<em>link type</em><br>possible values:<br><code>anchor</code>, <code>image</code>, <code>link</code>, <code>meta</code>, <code>canonical</code>, <code>alternate</code>, <code>redirect</code>'
          nullable: true
        attributes:
          type: array
          items:
            type: string
            nullable: true
          description: <em>link attributes of the referring links</em><br>example:<br><code>nofollow</code>
          nullable: true
        dofollow:
          type: boolean
          description: '<em>indicates whether the backlink is dofollow</em><br>if <code>false</code>, the backlink is nofollow'
          nullable: true
        original:
          type: boolean
          description: <em>indicates whether the backlink was present on the referring page when our crawler first visited it</em>
          nullable: true
        alt:
          type: string
          description: <em>alternative text of the image</em><br>this field will be <code>null</code> if backlink <code>type</code> is not image
          nullable: true
        anchor:
          type: string
          description: <em>anchor text of the backlink</em>
          nullable: true
        text_pre:
          type: string
          description: <em>text snippet before the anchor text</em>
          nullable: true
        text_post:
          type: string
          description: <em>snippet after the anchor text</em>
          nullable: true
        semantic_location:
          type: string
          description: '<em>indicates semantic element in HTML where the backlink is found</em><br>you can get the full list of semantic elements <a href="https://www.w3schools.com/html/html5_semantic_elements.asp" target="_blank" rel="noopener noreferrer">here</a><br>examples:<br><code>article</code>, <code>section</code>, <code>summary</code>'
          nullable: true
        links_count:
          type: integer
          description: <em>number of identical backlinks found on the referring page</em>
          format: int64
          nullable: true
        group_count:
          type: integer
          description: '<em>indicates total number of backlinks from this domain</em><br>for example, if <code>mode</code> is set to <code>one_per_domain</code>, this field will indicate the total number of backlinks coming from this domain'
          format: int64
          nullable: true
        is_broken:
          type: boolean
          description: '<em>indicates whether the backlink is broken</em><br>if <code>true</code>, the backlink is pointing to a page responding with a 4xx or 5xx status code'
          nullable: true
        url_to_status_code:
          type: integer
          description: '<em>status code of the referenced page</em><br>if the value is <code>null</code>, our crawler hasn''t yet visited the webpage the link is pointing to<br>example:<br><code>200</code>'
          nullable: true
        url_to_spam_score:
          type: integer
          description: '<em>spam score of the referenced page</em><br>if the value is <code>null</code>, our crawler hasn''t yet visited the webpage the link is pointing to<br>learn more about how the metric is calculated on <a href="https://dataforseo.com/help-center/what-is-spam-score-and-how-is-it-calculated" rel="noopener noreferrer" target="_blank">this help center page</a>'
          nullable: true
        url_to_redirect_target:
          type: string
          description: <em>target url of the redirect</em><br>target page the redirect is pointing to
          nullable: true
        is_indirect_link:
          type: boolean
          description: '<em>indicates whether the backlink is an indirect link</em><br>if <code>true</code>, the backlink is an indirect link pointing to a page that either redirects to <code>url_to</code>, or points to a canonical page'
          nullable: true
        indirect_link_path:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/BacklinksRedirectInfo'
            nullable: true
          description: <em>indirect link path</em><br>indicates a URL or a sequence of URLs that lead to <code>url_to</code>
          nullable: true
    BacklinksPageIntersectionLiveItem:
      type: object
      properties:
        page_intersection:
          type: object
          additionalProperties:
            type: array
            items:
              type: object
              oneOf:
                - $ref: '#/components/schemas/BacklinksPageIntersection'
              nullable: true
            nullable: true
          description: <em>contains data on pages that link to the corresponding targets specified in the POST array</em><br>data is provided in separate objects corresponding to pages specified in the <code>targets</code> object
          nullable: true
        summary:
          type: object
          oneOf:
            - $ref: '#/components/schemas/IntersectionSummaryInfo'
          description: <em>contains the page intersections summary</em>
          nullable: true
    BacklinksPageIntersectionLiveResultInfo:
      type: object
      properties:
        targets:
          type: object
          additionalProperties:
            type: string
            nullable: true
          description: <em><code>targets</code> from a POST array</em>
          nullable: true
        total_count:
          type: integer
          description: <em>total amount of results relevant the request</em>
          format: int64
          nullable: true
        items_count:
          type: integer
          description: <em>the number of results returned in the <code>items</code> array</em>
          format: int64
          nullable: true
        items:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/BacklinksPageIntersectionLiveItem'
            nullable: true
          description: <em>contains relevant backlinks and referring domains data</em>
          nullable: true
    BacklinksPageIntersectionLiveTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/BacklinksPageIntersectionLiveResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    BacklinksPageIntersectionLiveResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/BacklinksPageIntersectionLiveTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    BacklinksTimeseriesSummaryLiveRequestInfo:
      type: object
      properties:
        target:
          type: string
          description: <em>domain to get data for</em><br><strong>required field</strong><br>a domain should be specified without <code>https://</code> and <code>www.</code><br>example:<br><code>"forbes.com"</code>
        date_from:
          type: string
          description: '<em>starting date of the time range</em><br>optional field<br>this field indicates the date which will be used as a threshold for summary data;<p>minimum value: <code>2019-01-30</code><br>maximum value shouldn''t exceed the date specified in the <code>date_to</code><br>date format: <code>"yyyy-mm-dd"</code><br>example:<br><code>"2021-01-01"</code>'
          nullable: true
        date_to:
          type: string
          description: '<em>ending date of the time range</em><br>optional field<br>if you don''t specify this field, the today''s date will be used by default<br>minimum value shouldn''t preceed the date specified in the <code>date_from</code><br>maximum value: today''s date<br>date format: <code>"yyyy-mm-dd"</code><br>example:<br><code>"2021-01-15"</code>'
          nullable: true
        group_range:
          type: string
          description: '<em>time range which will be used to group the results</em><br>optional field<br>default value: <code>month</code><br>possible values: <code>day</code>, <code>week</code>, <code>month</code>, <code>year</code><p><strong>note:</strong> for <code>day</code>, we will return items corresponding to all dates between and including <code>date_from</code> and <code>date_to</code>;<br>for <code>week</code>/<code>month</code>/<code>year</code>, we will return items corresponding to full weeks/months/years, where each item will indicate the last day of the week/month/year<p>for example, if you specify: <br><code>"group_range": "month",<br>"date_from": "2022-03-23",<br>"date_to": "2022-05-13"</code><br>we will return items falling between 2022-03-01 and 2022-05-31, namely, three items corresponding to the following dates: <code>2022-03-31</code>, <code>2022-04-30</code>, <code>2022-05-31</code><p>if there is no data for a certain  <code>day</code>/<code>week</code>/<code>month</code>/<code>year</code>, we will return <code>0</code>'
          nullable: true
        include_subdomains:
          type: boolean
          description: '<em>indicates if the subdomains of the <code>target</code> will be included in the search</em><br>optional field<br>if set to <code>false</code>, the subdomains will be ignored<br>default value: <code>true</code>'
          nullable: true
        rank_scale:
          type: string
          description: '<em>defines the scale used for calculating and displaying the <code>rank</code>, <code>domain_from_rank</code>, and <code>page_from_rank</code> values</em><br>optional field<p>you can use this parameter to choose whether rank values are presented on a 0–100 or 0–1000 scale<p>possible values:<br><code>one_hundred</code> — rank values are displayed on a 0–100 scale<br><code>one_thousand</code> — rank values are displayed on a 0–1000 scale<p>default value: <code>one_thousand</code><p>learn more about how this parameter works and how ranking metrics are calculated in <a href="https://dataforseo.com/help-center/what_is_rank_in_backlinks_api#rank_scale">this Help Center article</a>'
          nullable: true
        tag:
          type: string
          description: <em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response
          nullable: true
      example:
        - target: dataforseo.com
          date_from: '2021-12-01'
          date_to: '2022-02-01'
          group_range: month
    BacklinksTimeseriesSummaryLiveItem:
      type: object
      properties:
        type:
          type: string
          description: type of element
          nullable: true
        date:
          type: string
          description: '<em>date and time when the data for the target was stored</em><br>in the UTC format: "yyyy-mm-dd hh-mm-ss +00:00"<br>example:<br><code>2019-11-15 12:57:46 +00:00</code>'
          nullable: true
        rank:
          type: integer
          description: <em><code>target</code> rank for the given <code>date</code></em><br>learn more about the metric and how it is calculated in <a href="https://dataforseo.com/help-center/what_is_rank_in_backlinks_api" rel="noopener noreferrer" target="_blank">this help center article</a>
          nullable: true
        backlinks:
          type: integer
          description: <em>number of backlinks for the given <code>date</code></em>
          format: int64
          nullable: true
        backlinks_nofollow:
          type: integer
          description: <em>number of nofollow backlinks for the given <code>date</code></em>
          format: int64
          nullable: true
        referring_pages:
          type: integer
          description: <em>number of pages pointing to <code>target</code> for the given <code>date</code></em>
          format: int64
          nullable: true
        referring_pages_nofollow:
          type: integer
          description: <em>number of referring pages pointing at least one nofollow link to the <code>target</code> for the given <code>date</code></em>
          format: int64
          nullable: true
        referring_domains:
          type: integer
          description: <em>number of referring domains for the given <code>date</code></em><br>referring domains include subdomains that are counted as separate domains for this metric
          format: int64
          nullable: true
        referring_domains_nofollow:
          type: integer
          description: <em>number of domains pointing at least one nofollow link to the <code>target</code> for the given <code>date</code></em>
          format: int64
          nullable: true
        referring_main_domains:
          type: integer
          description: <em>number of referring main domains for the given <code>date</code></em>
          format: int64
          nullable: true
        referring_main_domains_nofollow:
          type: integer
          description: <em>number of main domains pointing at least one nofollow link to the <code>target</code> for the given <code>date</code></em>
          format: int64
          nullable: true
        referring_ips:
          type: integer
          description: <em>number of referring IP addresses for the given <code>date</code></em><br>number of IP addresses pointing to this page
          format: int64
          nullable: true
        referring_subnets:
          type: integer
          description: <em>number of referring subnetworks for the given <code>date</code></em>
          format: int64
          nullable: true
    BacklinksTimeseriesSummaryLiveResultInfo:
      type: object
      properties:
        target:
          type: string
          description: <em><code>target</code> from a POST array</em>
          nullable: true
        date_from:
          type: string
          description: '<em>starting date of the time range</em><br>in the UTC format: “yyyy-mm-dd”<br>example:<br><code>2019-01-01</code>'
          nullable: true
        date_to:
          type: string
          description: '<em>ending date of the time range</em><br>in the UTC format: <code>"yyyy-mm-dd"</code><br>example:<br><code>"2019-01-15"</code>'
          nullable: true
        group_range:
          type: string
          description: group_range from a POST array
          nullable: true
        items_count:
          type: integer
          description: <em>the number of results returned in the <code>items</code> array</em>
          format: int64
          nullable: true
        items:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/BacklinksTimeseriesSummaryLiveItem'
            nullable: true
          description: <em>contains relevant summary data</em>
          nullable: true
    BacklinksTimeseriesSummaryLiveTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/BacklinksTimeseriesSummaryLiveResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    BacklinksTimeseriesSummaryLiveResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/BacklinksTimeseriesSummaryLiveTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    BacklinksTimeseriesNewLostSummaryLiveRequestInfo:
      type: object
      properties:
        target:
          type: string
          description: <em>domain to get data for</em><br><strong>required field</strong><br>a domain should be specified without <code>https://</code> and <code>www.</code><br>example:<br><code>"forbes.com"</code>
        date_from:
          type: string
          description: '<em>starting date of the time range</em><br>optional field<br>this field indicates the date which will be used as a threshold for new and lost backlinks and referring domains;<br>the backlinks and referring domains that appeared in our index after the specified date will be considered as new;<br>the backlinks and referring domains that weren''t found after the specified date, but were present before, will be considered as lost;<p>minimum value: <code>2019-01-30</code><br>maximum value shouldn''t exceed the date specified in the <code>date_to</code><br>date format: <code>"yyyy-mm-dd"</code><br>example:<br><code>"2021-01-01"</code>'
          nullable: true
        date_to:
          type: string
          description: '<em>ending date of the time range</em><br>optional field<br>if you don''t specify this field, the today''s date will be used by default<br>minimum value shouldn''t preceed the date specified in the <code>date_from</code><br>maximum value: today''s date<br>date format: <code>"yyyy-mm-dd"</code><br>example:<br><code>"2021-01-15"</code>'
          nullable: true
        group_range:
          type: string
          description: '<em>time range which will be used to group the results</em><br>optional field<br>default value: <code>month</code><br>possible values: <code>day</code>, <code>week</code>, <code>month</code>, <code>year</code><p><strong>note:</strong> for <code>day</code>, we will return items corresponding to all dates between and including <code>date_from</code> and <code>date_to</code>;<br>for <code>week</code>/<code>month</code>/<code>year</code>, we will return items corresponding to full weeks/months/years, where each item will indicate the last day of the week/month/year<p>for example, if you specify: <br><code>"group_range": "month",<br>"date_from": "2022-03-23",<br>"date_to": "2022-05-13"</code><br>we will return items falling between 2022-03-01 and 2022-05-31, namely, three items corresponding to the following dates: <code>2022-03-31</code>, <code>2022-04-30</code>, <code>2022-05-31</code><p>if there is no data for a certain  <code>day</code>/<code>week</code>/<code>month</code>/<code>year</code>, we will return <code>0</code>'
          nullable: true
        include_subdomains:
          type: boolean
          description: '<em>indicates if the subdomains of the <code>target</code> will be included in the search</em><br>optional field<br>if set to <code>false</code>, the subdomains will be ignored<br>default value: <code>true</code>'
          nullable: true
        tag:
          type: string
          description: <em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response
          nullable: true
      example:
        - target: dataforseo.com
          date_from: '2021-12-01'
          date_to: '2022-02-01'
          group_range: month
    BacklinksTimeseriesNewLostSummaryLiveItem:
      type: object
      properties:
        type:
          type: string
          description: type of element
          nullable: true
        date:
          type: string
          description: '<em>date and time when the data for the target was stored</em><br>in the UTC format: "yyyy-mm-dd hh-mm-ss +00:00"<br>example:<br><code>2019-11-15 12:57:46 +00:00</code>'
          nullable: true
        new_backlinks:
          type: integer
          description: <em>number of new backlinks</code></em><br>number of new backlinks pointing to the <code>target</code>
          format: int64
          nullable: true
        lost_backlinks:
          type: integer
          description: <em>number of lost backlinks</code></em><br>number of lost backlinks of the <code>target</code>
          format: int64
          nullable: true
        new_referring_domains:
          type: integer
          description: <em>number of new referring domains</code></em><br>number of new referring domains pointing to the <code>target</code>
          format: int64
          nullable: true
        lost_referring_domains:
          type: integer
          description: <em>number of lost referring domains</code></em><br>number of lost referring domains of the <code>target</code>
          format: int64
          nullable: true
        new_referring_main_domains:
          type: integer
          description: <em>number of new referring main domains</code></em><br>number of new referring main domains pointing to the <code>target</code>
          format: int64
          nullable: true
        lost_referring_main_domains:
          type: integer
          description: <em>number of lost referring main domains</code></em><br>number of lost referring main domains of the <code>target</code>
          format: int64
          nullable: true
    BacklinksTimeseriesNewLostSummaryLiveResultInfo:
      type: object
      properties:
        target:
          type: string
          description: <em><code>target</code> from a POST array</em>
          nullable: true
        date_from:
          type: string
          description: '<em>starting date of the time range</em><br>in the UTC format: “yyyy-mm-dd”<br>example:<br><code>2019-01-01</code>'
          nullable: true
        date_to:
          type: string
          description: '<em>ending date of the time range</em><br>in the UTC format: <code>"yyyy-mm-dd"</code><br>example:<br><code>"2019-01-15"</code>'
          nullable: true
        group_range:
          type: string
          description: <em><code>group_range</code> from the POST array</em>
          nullable: true
        items_count:
          type: integer
          description: <em>the number of results returned in the <code>items</code> array</em>
          format: int64
          nullable: true
        items:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/BacklinksTimeseriesNewLostSummaryLiveItem'
            nullable: true
          description: <em>contains relevant backlinks and referring domains data</em>
          nullable: true
    BacklinksTimeseriesNewLostSummaryLiveTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/BacklinksTimeseriesNewLostSummaryLiveResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    BacklinksTimeseriesNewLostSummaryLiveResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/BacklinksTimeseriesNewLostSummaryLiveTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    BacklinksBulkRanksLiveRequestInfo:
      type: object
      properties:
        targets:
          type: array
          items:
            type: string
          description: '<em>domains, subdomains or webpages to get <code>rank</code> for</em><br><strong>required field</strong><br>you can set up to 1000 domains, subdomains or webpages<br>the domain or subdomain should be specified without <code>https://</code> and <code>www.</code><br>the page should be specified with absolute URL (including <code>http://</code> or <code>https://</code>)<br>example:<br>`"targets": [<br>  "forbes.com",<br>  "cnn.com",<br>  "bbc.com",<br>  "yelp.com",<br>  "https://www.apple.com/iphone/",<br>  "https://ahrefs.com/blog/",<br>  "ibm.com",<br>  "https://variety.com/",<br>  "https://stackoverflow.com/",<br>  "www.trustpilot.com"<br>]`'
        rank_scale:
          type: string
          description: '<em>defines the scale used for calculating and displaying the <code>rank</code>, <code>domain_from_rank</code>, and <code>page_from_rank</code> values</em><br>optional field<p>you can use this parameter to choose whether rank values are presented on a 0–100 or 0–1000 scale<p>possible values:<br><code>one_hundred</code> — rank values are displayed on a 0–100 scale<br><code>one_thousand</code> — rank values are displayed on a 0–1000 scale<p>default value: <code>one_thousand</code><p>learn more about how this parameter works and how ranking metrics are calculated in <a href="https://dataforseo.com/help-center/what_is_rank_in_backlinks_api#rank_scale">this Help Center article</a>'
          nullable: true
        tag:
          type: string
          description: <em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response
          nullable: true
      example:
        - targets:
            - forbes.com
            - cnn.com
            - bbc.com
            - yelp.com
            - https://www.apple.com/iphone/
            - https://ahrefs.com/blog/
            - ibm.com
            - https://variety.com/
            - https://stackoverflow.com/
            - www.trustpilot.com
    BacklinksBulkRanksLiveItem:
      type: object
      properties:
        target:
          type: string
          description: '<em>domain, subdomain or webpage from a POST array</em>'
          nullable: true
        rank:
          type: integer
          description: <em>rank of the <code>target</code></em><br>values represent real-time data for the date of the request<br><code>rank</code> is calculated based on the method for node ranking in a linked database - a principle used in the original Google PageRank algorithm<br>learn more about the metric and how it is calculated in <a href="https://dataforseo.com/help-center/what_is_rank_in_backlinks_api" rel="noopener noreferrer" target="_blank">this help center article</a>
          nullable: true
    BacklinksBulkRanksLiveResultInfo:
      type: object
      properties:
        items_count:
          type: integer
          description: <em>the number of results returned in the <code>items</code> array</em>
          format: int64
          nullable: true
        items:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/BacklinksBulkRanksLiveItem'
            nullable: true
          description: <em>contains relevant backlinks and referring domains data</em>
          nullable: true
    BacklinksBulkRanksLiveTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/BacklinksBulkRanksLiveResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    BacklinksBulkRanksLiveResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/BacklinksBulkRanksLiveTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    BacklinksBulkBacklinksLiveRequestInfo:
      type: object
      properties:
        targets:
          type: array
          items:
            type: string
          description: '<em>domains, subdomains or webpages to get the number of backlinks for</em><br><strong>required field</strong><br>you can set up to 1000 domains, subdomains or webpages<br>the domain or subdomain should be specified without <code>https://</code> and <code>www.</code><br>the page should be specified with absolute URL (including <code>http://</code> or <code>https://</code>)<br>example:<br>`"targets": [<br>  "forbes.com",<br>  "cnn.com",<br>  "bbc.com",<br>  "yelp.com",<br>  "https://www.apple.com/iphone/",<br>  "https://ahrefs.com/blog/",<br>  "ibm.com",<br>  "https://variety.com/",<br>  "https://stackoverflow.com/",<br>  "www.trustpilot.com"<br>]`'
        tag:
          type: string
          description: <em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response
          nullable: true
      example:
        - targets:
            - forbes.com
            - cnn.com
            - bbc.com
            - yelp.com
            - https://www.apple.com/iphone/
            - https://ahrefs.com/blog/
            - ibm.com
            - https://variety.com/
            - https://stackoverflow.com/
            - www.trustpilot.com
    BacklinksBulkBacklinksLiveItem:
      type: object
      properties:
        target:
          type: string
          description: '<em>domain, subdomain or webpage from a POST array</em>'
          nullable: true
        backlinks:
          type: integer
          description: <em>number of backlinks pointing to the <code>target</code></em>
          format: int64
          nullable: true
    BacklinksBulkBacklinksLiveResultInfo:
      type: object
      properties:
        items_count:
          type: integer
          description: <em>the number of results returned in the <code>items</code> array</em>
          format: int64
          nullable: true
        items:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/BacklinksBulkBacklinksLiveItem'
            nullable: true
          description: <em>contains relevant backlink data</em>
          nullable: true
    BacklinksBulkBacklinksLiveTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/BacklinksBulkBacklinksLiveResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    BacklinksBulkBacklinksLiveResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/BacklinksBulkBacklinksLiveTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    BacklinksBulkSpamScoreLiveRequestInfo:
      type: object
      properties:
        targets:
          type: array
          items:
            type: string
          description: '<em>domains, subdomains or webpages to get <code>rank</code> for</em><br><strong>required field</strong><br>you can set up to 1000 domains, subdomains or webpages<br>the domain or subdomain should be specified without <code>https://</code> and <code>www.</code><br>the page should be specified with absolute URL (including <code>http://</code> or <code>https://</code>)<br>example:<br>`"targets": [<br>  "forbes.com",<br>  "cnn.com",<br>  "bbc.com",<br>  "yelp.com",<br>  "https://www.apple.com/iphone/",<br>  "https://ahrefs.com/blog/",<br>  "ibm.com",<br>  "https://variety.com/",<br>  "https://stackoverflow.com/",<br>  "www.trustpilot.com"<br>]`'
        tag:
          type: string
          description: <em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response
          nullable: true
      example:
        - targets:
            - forbes.com
            - cnn.com
            - bbc.com
            - yelp.com
            - https://www.apple.com/iphone/
            - https://ahrefs.com/blog/
            - ibm.com
            - https://variety.com/
            - https://stackoverflow.com/
            - www.trustpilot.com
    BacklinksBulkSpamScoreLiveItem:
      type: object
      properties:
        type:
          type: string
          description: type of element
          nullable: true
        target:
          type: string
          description: '<em>domain, subdomain or webpage from a POST array</em>'
          nullable: true
        spam_score:
          type: integer
          description: <em>average spam score the target</em><br><a href="https://dataforseo.com/help-center/what-is-spam-score-and-how-is-it-calculated" rel="noopener noreferrer" target="_blank">learn more</a> about how the metric is calculated
          nullable: true
    BacklinksBulkSpamScoreLiveResultInfo:
      type: object
      properties:
        items_count:
          type: integer
          description: <em>the number of results returned in the <code>items</code> array</em>
          format: int64
          nullable: true
        items:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/BacklinksBulkSpamScoreLiveItem'
            nullable: true
          description: <em>contains relevant backlinks and referring domains data</em>
          nullable: true
    BacklinksBulkSpamScoreLiveTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/BacklinksBulkSpamScoreLiveResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    BacklinksBulkSpamScoreLiveResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/BacklinksBulkSpamScoreLiveTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    BacklinksBulkReferringDomainsLiveRequestInfo:
      type: object
      properties:
        targets:
          type: array
          items:
            type: string
          description: '<em>domains, subdomains or webpages to get the number of referring domains for</em><br><strong>required field</strong><br>you can set up to 1000 domains, subdomains or webpages<br>the domain or subdomain should be specified without <code>https://</code> and <code>www.</code><br>the page should be specified with absolute URL (including <code>http://</code> or <code>https://</code>)<br>example:<br>`"targets": [<br>  "forbes.com",<br>  "cnn.com",<br>  "bbc.com",<br>  "yelp.com",<br>  "https://www.apple.com/iphone/",<br>  "https://ahrefs.com/blog/",<br>  "ibm.com",<br>  "https://variety.com/",<br>  "https://stackoverflow.com/",<br>  "www.trustpilot.com"<br>]`'
        tag:
          type: string
          description: <em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response
          nullable: true
      example:
        - targets:
            - forbes.com
            - cnn.com
            - bbc.com
            - yelp.com
            - https://www.apple.com/iphone/
            - https://ahrefs.com/blog/
            - ibm.com
            - https://variety.com/
            - https://stackoverflow.com/
            - www.trustpilot.com
    BacklinksBulkReferringDomainsLiveItem:
      type: object
      properties:
        target:
          type: string
          description: '<em>domain, subdomain or webpage from a POST array</em>'
          nullable: true
        referring_domains:
          type: integer
          description: '<em>number of referring domains pointing to the <code>target</code></em><br>note that we calculate main domains (root domains, like <code>example.com</code>) and their subdomains (e.g. <code>blog.example.com</code>) separately for this metric'
          format: int64
          nullable: true
        referring_domains_nofollow:
          type: integer
          description: <em>number of domains pointing at least one nofollow link to the <code>target</code></em>
          format: int64
          nullable: true
        referring_main_domains:
          type: integer
          description: <em>number of referring main domains pointing to the <code>target</code></em><br>the number of primary (root) domains referring to your target
          format: int64
          nullable: true
        referring_main_domains_nofollow:
          type: integer
          description: <em>number of main domains pointing at least one nofollow link to the <code>target</code></em>
          format: int64
          nullable: true
    BacklinksBulkReferringDomainsLiveResultInfo:
      type: object
      properties:
        items_count:
          type: integer
          description: <em>the number of results returned in the <code>items</code> array</em>
          format: int64
          nullable: true
        items:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/BacklinksBulkReferringDomainsLiveItem'
            nullable: true
          description: <em>contains relevant backlinks and referring domains data</em>
          nullable: true
    BacklinksBulkReferringDomainsLiveTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/BacklinksBulkReferringDomainsLiveResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    BacklinksBulkReferringDomainsLiveResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/BacklinksBulkReferringDomainsLiveTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    BacklinksBulkNewLostBacklinksLiveRequestInfo:
      type: object
      properties:
        targets:
          type: array
          items:
            type: string
          description: '<em>domains, subdomains or webpages to get new & lost backlinks for</em><br><strong>required field</strong><br>you can set up to 1000 domains, subdomains or webpages<br>the domain or subdomain should be specified without `https://` and `www.` the page should be specified with absolute URL (including <code>http://</code> or <code>https://</code>)<br>example:<br> `"targets": [<br>  "forbes.com",<br>  "cnn.com",<br>  "bbc.com",<br>  "yelp.com",<br>  "https://www.apple.com/iphone/",<br>  "https://ahrefs.com/blog/",<br>  "ibm.com",<br>  "https://variety.com/",<br>  "https://stackoverflow.com/",<br>  "www.trustpilot.com"<br>]`'
        date_from:
          type: string
          description: '<em>starting date of the time range</em><br>optional field<br>this field indicates the date which will be used as a threshold for new and lost backlinks;<br>the backlinks that appeared in our index after the specified date will be considered as new;<br>the backlinks that weren''t found after the specified date, but were present before, will be considered as lost;<p>default value: today''s date -(minus) one month;<br>e.g. if today is <code>2021-10-13</code>, default <code>date_from</code> will be <code>2021-09-13</code>.<br><strong>minimum value equals today''s date -(minus) one year;</strong><br>e.g. if today is <code>2021-10-13</code>, minimum <code>date_from</code> will be <code>2020-10-13</code>.<p>date format: <code>"yyyy-mm-dd"</code><br>example:<br><code>"2021-01-01"</code>'
          nullable: true
        tag:
          type: string
          description: <em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response
          nullable: true
      example:
        - targets:
            - forbes.com
            - cnn.com
            - bbc.com
            - yelp.com
            - https://www.apple.com/iphone/
            - https://ahrefs.com/blog/
            - ibm.com
            - https://variety.com/
            - https://stackoverflow.com/
            - www.trustpilot.com
          date_from: '2026-08-31 11:12:35'
    BacklinksBulkNewLostBacklinksLiveItem:
      type: object
      properties:
        target:
          type: string
          description: '<em>domain, subdomain or webpage from a POST array</em>'
          nullable: true
        new_backlinks:
          type: integer
          description: <em>number of new backlinks</code></em><br>number of new backlinks pointing to the <code>target</code>
          format: int64
          nullable: true
        lost_backlinks:
          type: integer
          description: <em>number of lost backlinks</code></em><br>number of lost backlinks of the <code>target</code>
          format: int64
          nullable: true
    BacklinksBulkNewLostBacklinksLiveResultInfo:
      type: object
      properties:
        items_count:
          type: integer
          description: <em>the number of results returned in the <code>items</code> array</em>
          format: int64
          nullable: true
        items:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/BacklinksBulkNewLostBacklinksLiveItem'
            nullable: true
          description: <em>contains relevant backlinks and referring domains data</em>
          nullable: true
    BacklinksBulkNewLostBacklinksLiveTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/BacklinksBulkNewLostBacklinksLiveResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    BacklinksBulkNewLostBacklinksLiveResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/BacklinksBulkNewLostBacklinksLiveTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    BacklinksBulkNewLostReferringDomainsLiveRequestInfo:
      type: object
      properties:
        targets:
          type: array
          items:
            type: string
          description: '<em>domains, subdomains or webpages to get  new & lost referring domains for</em><br><strong>required field</strong><br>you can set up to 1000 domains, subdomains or webpages<br>the domain or subdomain should be specified without <code>https://</code> and <code>www.</code><br>the page should be specified with absolute URL (including <code>http://</code> or <code>https://</code>)<br>example:<br>`"targets": [<br>  "forbes.com",<br>  "cnn.com",<br>  "bbc.com",<br>  "yelp.com",<br>  "https://www.apple.com/iphone/",<br>  "https://ahrefs.com/blog/",<br>  "ibm.com",<br>  "https://variety.com/",<br>  "https://stackoverflow.com/",<br>  "www.trustpilot.com"<br>]`'
        date_from:
          type: string
          description: '<em>starting date of the time range</em><br>optional field<br>this field indicates the date which will be used as a threshold for new and lost referring domains;<br>the referring domains that appeared in our index after the specified date will be considered as new;<br>the referring domains that weren''t found after the specified date, but were present before, will be considered as lost;<p>default value: today''s date -(minus) one month;<br>e.g. if today is <code>2021-10-13</code>, default <code>date_from</code> will be <code>2021-09-13</code>.<br><strong>minimum value equals today''s date -(minus) one year;</strong><br>e.g. if today is <code>2021-10-13</code>, minimum <code>date_from</code> will be <code>2020-10-13</code>.<p>date format: <code>"yyyy-mm-dd"</code><br>example:<br><code>"2021-01-01"</code>'
          nullable: true
        tag:
          type: string
          description: <em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response
          nullable: true
      example:
        - targets:
            - forbes.com
            - cnn.com
            - bbc.com
            - yelp.com
            - https://www.apple.com/iphone/
            - https://ahrefs.com/blog/
            - ibm.com
            - https://variety.com/
            - https://stackoverflow.com/
            - www.trustpilot.com
          datetime_from: '2026-12-31'
    BacklinksBulkNewLostReferringDomainsLiveItem:
      type: object
      properties:
        target:
          type: string
          description: '<em>domain, subdomain or webpage from a POST array</em>'
          nullable: true
        new_referring_domains:
          type: integer
          description: <em>number of new referring domains</code></em><br>number of new referring domains pointing to the <code>target</code>
          format: int64
          nullable: true
        lost_referring_domains:
          type: integer
          description: <em>number of lost referring domains</code></em><br>number of lost referring domains of the <code>target</code>
          format: int64
          nullable: true
        new_referring_main_domains:
          type: integer
          description: <em>number of new referring main domains pointing to the <code>target</code></em>
          format: int64
          nullable: true
        lost_referring_main_domains:
          type: integer
          description: <em>number of lost referring main domains pointing to the <code>target</code></em>
          format: int64
          nullable: true
    BacklinksBulkNewLostReferringDomainsLiveResultInfo:
      type: object
      properties:
        items_count:
          type: integer
          description: <em>the number of results returned in the <code>items</code> array</em>
          format: int64
          nullable: true
        items:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/BacklinksBulkNewLostReferringDomainsLiveItem'
            nullable: true
          description: <em>contains relevant backlinks and referring domains data</em>
          nullable: true
    BacklinksBulkNewLostReferringDomainsLiveTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/BacklinksBulkNewLostReferringDomainsLiveResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    BacklinksBulkNewLostReferringDomainsLiveResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/BacklinksBulkNewLostReferringDomainsLiveTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    BacklinksBulkPagesSummaryLiveRequestInfo:
      type: object
      properties:
        targets:
          type: array
          items:
            type: string
          description: '<em>domains, subdomains or webpages to get summary data for</em><br><strong>required field</strong><br>a domain or a subdomain should be specified without <code>https://</code> and <code>www.</code><br>a page should be specified with absolute URL (including <code>http://</code> or <code>https://</code>)<br>you can specify up to 1000 pages, domains, or subdomains in each request.<br><strong>note that the URLs you set in a single request cannot belong to more than 100 different domains</strong>.'
        include_subdomains:
          type: boolean
          description: '<em>indicates if the subdomains of the <code>target</code> will be included in the search</em><br>optional field<br>if set to <code>false</code>, the subdomains will be ignored<br>default value: <code>true</code>'
          nullable: true
        rank_scale:
          type: string
          description: '<em>defines the scale used for calculating and displaying the <code>rank</code>, <code>domain_from_rank</code>, and <code>page_from_rank</code> values</em><br>optional field<p>you can use this parameter to choose whether rank values are presented on a 0–100 or 0–1000 scale<p>possible values:<br><code>one_hundred</code> — rank values are displayed on a 0–100 scale<br><code>one_thousand</code> — rank values are displayed on a 0–1000 scale<p>default value: <code>one_thousand</code><p>learn more about how this parameter works and how ranking metrics are calculated in <a href="https://dataforseo.com/help-center/what_is_rank_in_backlinks_api#rank_scale">this Help Center article</a>'
          nullable: true
        tag:
          type: string
          description: <em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response
          nullable: true
      example:
        - targets:
            - https://dataforseo.com/solutions
            - https://dataforseo.com/about-us
    BacklinksBulkPagesSummaryLiveItem:
      type: object
      properties:
        type:
          type: string
          description: type of element
          nullable: true
        url:
          type: string
          description: <em>page URL</em>
          nullable: true
        rank:
          type: integer
          description: <em>page rank</em><br>rank of the page on the <code>target</code> website<br><code>rank</code> is calculated based on the method for node ranking in a linked database - a principle used in the original Google PageRank algorithm<br>learn more about the metric and how it is calculated in <a href="https://dataforseo.com/help-center/what_is_rank_in_backlinks_api" rel="noopener noreferrer" target="_blank">this help center article</a>
          nullable: true
        main_domain_rank:
          type: integer
          description: <em>rank of the main domain</em><br>rank of the main domain is calculated based on the method for node ranking in a linked database - a principle used in the original Google PageRank algorithm<br>learn more about the metric and how it is calculated in <a href="https://dataforseo.com/help-center/what_is_rank_in_backlinks_api" rel="noopener noreferrer" target="_blank">this help center article</a>
          nullable: true
        backlinks:
          type: integer
          description: <em>number of backlinks</em>
          format: int64
          nullable: true
        first_seen:
          type: string
          description: '<em>date and time when our crawler found a backlink to this page for the first time</em><br>in the UTC format: "yyyy-mm-dd hh-mm-ss +00:00"<br>example:<br><code>2019-11-15 12:57:46 +00:00</code>'
          nullable: true
        lost_date:
          type: string
          description: '<em>date and time when the last backlink to this page was lost</em><br>indicates the date and time when our crawler visited the page and it responded with 4xx or 5xx status code or the last backlink was removed<br>in the UTC format: "yyyy-mm-dd hh-mm-ss +00:00"<br>example:<br><code>2017-01-24 13:20:59 +00:00</code>'
          nullable: true
        backlinks_spam_score:
          type: integer
          description: <em>average spam score of the backlinks pointing to the page</em><br>learn more about how the metric is calculated on <a href="https://dataforseo.com/help-center/what-is-spam-score-and-how-is-it-calculated" rel="noopener noreferrer" target="_blank">this help center page</a>
          format: int64
          nullable: true
        broken_backlinks:
          type: integer
          description: <em>number of broken backlinks</em><br>number of broken backlinks pointing to the page
          format: int64
          nullable: true
        broken_pages:
          type: integer
          description: <em>number of broken pages</em><br>number of pages that respond with 4xx or 5xx status codes where backlinks are pointing to
          nullable: true
        referring_domains:
          type: integer
          description: <em>indicates the number domains referring to the page</em>
          format: int64
          nullable: true
        referring_domains_nofollow:
          type: integer
          description: <em>number of domains pointing at least one nofollow link to the <code>target</code></em>
          format: int64
          nullable: true
        referring_main_domains:
          type: integer
          description: <em>indicates the number of referring main domains</em>
          format: int64
          nullable: true
        referring_main_domains_nofollow:
          type: integer
          format: int64
          nullable: true
        referring_ips:
          type: integer
          description: <em>number of referring IP addresses</em><br>number of IP addresses pointing to this page
          format: int64
          nullable: true
        referring_subnets:
          type: integer
          description: <em>number of referring subnetworks</em>
          format: int64
          nullable: true
        referring_pages:
          type: integer
          description: <em>indicates the number of pages pointing to the relevant <code>url</code></em>
          format: int64
          nullable: true
        referring_pages_nofollow:
          type: integer
          description: <em>number of referring pages pointing at least one nofollow link to the <code>target</code></em>
          format: int64
          nullable: true
        referring_links_tld:
          type: object
          additionalProperties:
            type: integer
            format: int64
            nullable: true
          description: <em>top-level domains of the referring links</em><br>contains top level domains and referring link count per each
          nullable: true
        referring_links_types:
          type: object
          additionalProperties:
            type: integer
            format: int64
            nullable: true
          description: '<em>types of referring links</em><br>indicates the types of the referring links and link count per each type<br>possible values:<br><code>anchor</code>, <code>image</code>, <code>link</code>, <code>meta</code>, <code>canonical</code>, <code>alternate</code>, <code>redirect</code>'
          nullable: true
        referring_links_attributes:
          type: object
          additionalProperties:
            type: integer
            format: int64
            nullable: true
          description: <em>link attributes of the referring links</em><br>indicates link attributes of the referring links and link count per each attribute
          nullable: true
        referring_links_platform_types:
          type: object
          additionalProperties:
            type: integer
            format: int64
            nullable: true
          description: '<em>types of referring platforms</em><br>indicates referring platform types and and link count per each platform<p>possible values: <code>cms</code>, <code>blogs</code>, <code>ecommerce</code>, <code>message-boards</code>, <code>wikis</code>, <code>news</code>, <code>organization</code>'
          nullable: true
        referring_links_semantic_locations:
          type: object
          additionalProperties:
            type: integer
            format: int64
            nullable: true
          description: '<em>semantic locations of the referring links</em><br>indicates semantic elements in HTML where the referring links are located and link count per each semantic location<p>you can get the full list of semantic elements <a href="https://www.w3schools.com/html/html5_semantic_elements.asp" target="_blank" rel="noopener noreferrer">here</a><br>examples:<br><code>article</code>, <code>section</code>, <code>footer</code>'
          nullable: true
        referring_links_countries:
          type: object
          additionalProperties:
            type: integer
            format: int64
            nullable: true
          description: <em>ISO country codes of the referring links</em><br>indicates ISO country codes of the domains where the referring links are located and the link count per each country
          nullable: true
    BacklinksBulkPagesSummaryLiveResultInfo:
      type: object
      properties:
        total_count:
          type: integer
          description: <em>total number of relevant items in the database</em>
          format: int64
          nullable: true
        items_count:
          type: integer
          description: <em>number of items in the results array</em>
          format: int64
          nullable: true
        items:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/BacklinksBulkPagesSummaryLiveItem'
            nullable: true
          description: <em>items array</em>
          nullable: true
    BacklinksBulkPagesSummaryLiveTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/BacklinksBulkPagesSummaryLiveResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    BacklinksBulkPagesSummaryLiveResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/BacklinksBulkPagesSummaryLiveTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    AiOptimizationChatGptLlmScraperLocationsResultInfo:
      type: object
      properties:
        location_code:
          type: integer
          description: <em>location code</em>
          nullable: true
        location_name:
          type: string
          description: <em>full name of the location</em>
          nullable: true
        location_code_parent:
          type: string
          description: '<em>the code of the superordinate location</em><br>example:<br><code>"location_code": 9041134,<br>"location_name": "Vienna International Airport,Lower Austria,Austria",<br>"location_code_parent": 20044</code><p>where <code>location_code_parent</code> corresponds to:<p><code>"location_code": 20044,<br>"location_name": "Lower Austria,Austria"</code>'
          nullable: true
        country_iso_code:
          type: string
          description: <em>ISO country code of the location</em>
          nullable: true
        location_type:
          type: string
          description: <em>location type</em>
          nullable: true
    AiOptimizationChatGptLlmScraperLocationsTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AiOptimizationChatGptLlmScraperLocationsResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    AiOptimizationChatGptLlmScraperLocationsResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AiOptimizationChatGptLlmScraperLocationsTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    AiOptimizationChatGptLlmScraperLocationsCountryResultInfo:
      type: object
      properties:
        location_code:
          type: integer
          description: <em>location code</em>
          nullable: true
        location_name:
          type: string
          description: <em>full name of the location</em>
          nullable: true
        location_code_parent:
          type: string
          description: '<em>the code of the superordinate location</em><br>example:<br><code>"location_code": 9041134,<br>"location_name": "Vienna International Airport,Lower Austria,Austria",<br>"location_code_parent": 20044</code><p>where <code>location_code_parent</code> corresponds to:<p><code>"location_code": 20044,<br>"location_name": "Lower Austria,Austria"</code>'
          nullable: true
        country_iso_code:
          type: string
          description: <em>ISO country code of the location</em>
          nullable: true
        location_type:
          type: string
          description: <em>location type</em>
          nullable: true
    AiOptimizationChatGptLlmScraperLocationsCountryTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AiOptimizationChatGptLlmScraperLocationsCountryResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    AiOptimizationChatGptLlmScraperLocationsCountryResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AiOptimizationChatGptLlmScraperLocationsCountryTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    AiOptimizationChatGptLlmScraperLanguagesResultInfo:
      type: object
      properties:
        language_name:
          type: string
          description: <em>language name</em>
          nullable: true
        language_code:
          type: string
          description: <em>language code according to <a href="https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes" target="_blank" rel="noopener noreferrer">ISO 639-1</a></em>
          nullable: true
    AiOptimizationChatGptLlmScraperLanguagesTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AiOptimizationChatGptLlmScraperLanguagesResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    AiOptimizationChatGptLlmScraperLanguagesResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AiOptimizationChatGptLlmScraperLanguagesTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    AiOptimizationChatGptLlmScraperTaskPostRequestInfo:
      type: object
      properties:
        keyword:
          type: string
          description: '<em>keyword</em><br><strong>required field</strong><br>you can specify <strong>up to 2000 characters</strong> in the <code>keyword</code> field<br>all %## will be decoded (plus character ‘+’ will be decoded to a space character)<br>if you need to use the “%” character for your <code>keyword</code>, please specify it as “%25”;<br>if you need to use the “+” character for your <code>keyword</code>, please specify it as “%2B”<p>learn more about rules and limitations of <code>keyword</code> and <code>keywords</code> fields in DataForSEO APIs in this <a href="https://dataforseo.com/help-center/rules-and-limitations-of-keyword-and-keywords-fields-in-dataforseo-apis" rel="noopener noreferrer" target="_blank">Help Center article</a>'
        priority:
          type: integer
          description: <em>task priority</em><br>optional field<br>can take the following values:<br>1 – normal execution priority (set by default)<br>2 – high execution priorityYou will be additionally charged for the tasks with high execution priority.<br>The cost can be calculated on the <a title="Pricing" href="https://dataforseo.com/pricing/ai-optimization/llm-scraper" target="_blank" rel="noopener noreferrer">Pricing</a> page.
          nullable: true
        location_name:
          type: string
          description: '<em>full name of search engine location</em><br><strong>required field if you don''t specify</strong> <code>location_code</code><br><strong>if you use this field, you don''t need to specify <code>location_code</code></strong><br>you can receive the list of available locations of the search engine with their <code>location_name</code> by making a separate request to the <code>https://api.dataforseo.com/v3/ai_optimization/chat_gpt/llm_scraper/locations</code><br>example:<br><code class="long-string">United States</code>'
        location_code:
          type: integer
          description: '<em>search engine location code</em><br><strong>required field if you don''t specify</strong> <code>location_name</code><br><strong>if you use this field, you don''t need to specify <code>location_name</code></strong><br>you can receive the list of available locations of the search engines with their <code>location_code</code> by making a separate request to the <code>https://api.dataforseo.com/v3/ai_optimization/chat_gpt/llm_scraper/locations</code><br>example:<br><code class="long-string">2840</code>'
        language_name:
          type: string
          description: '<em>full name of search engine language</em><br>required field if you don''t specify <code>language_code</code>;<br>if you use this field, you don''t need to specify <code>language_code</code>;<br>you can receive the list of available languages of the search engine with their <code>language_name</code> by making a separate request to the <code>https://api.dataforseo.com/v3/ai_optimization/chat_gpt/llm_scraper/languages</code>'
        language_code:
          type: string
          description: '<em>search engine language code</em><br>required field if you don''t specify <code>language_name</code>;<br>if you use this field, you don''t need to specify <code>language_name</code>;<br>you can receive the list of available languages of the search engine with their <code>language_code</code>_by making a separate request to the <code>https://api.dataforseo.com/v3/ai_optimization/chat_gpt/llm_scraper/languages</code>n'
        force_web_search:
          type: boolean
          description: '<em>force AI agent to use web search</em><br>optional field<br>when enabled, the AI model is forced to access and cite current web information;<br>default value: <code>false</code>;<br><strong>Note:</strong> even if the parameter is set to <code>true</code>, there is no guarantee web sources will be cited in the response'
          nullable: true
        expand_citations:
          type: boolean
          description: '<em>return expanded citation bar in HTML results</em><br>optional field<br>to enable this parameter, <code>force_web_search</code> must also be enabled;<br>when enabled, the HTML endpoint will return data from the expanded citation bar;<br>default value: <code>false</code>'
          nullable: true
        tag:
          type: string
          description: <em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response
          nullable: true
        postback_url:
          type: string
          description: '<em>URL for sending task results</em><br>optional field<br>once the task is completed, we will send a POST request with its results compressed in the <code>gzip</code> format to the <code>postback_url</code> you specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/postbackscript?id=$id</code><br><code>http://your-server.com/postbackscript?id=$id&amp;tag=$tag</code><br><strong>Note:</strong> special characters in <code>postback_url</code> will be urlencoded;<br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href="https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api" target="_blank" rel="noopener noreferrer">Help Center</a>'
          nullable: true
        postback_data:
          type: string
          description: '<em>postback_url datatype</em><br><strong>required field if you specify <code>postback_url</code></strong><br>corresponds to the function you used for setting a task<br>possible values:<br><code>advanced</code>, <code>html</code>'
        pingback_url:
          type: string
          description: '<em>notification URL of a completed task</em><br>optional field<br>when a task is completed we will notify you by GET request sent to the URL you have specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/pingscript?id=$id</code><br><code>http://your-server.com/pingscript?id=$id&amp;tag=$tag</code><br><strong>Note:</strong> special characters in <code>pingback_url</code> will be urlencoded;<br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href="https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api" target="_blank" rel="noopener noreferrer">Help Center</a>'
          nullable: true
      example:
        - language_code: en
          location_code: 2840
          keyword: what is chatgpt
    AiOptimizationChatGptLlmScraperTaskPostTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: object
              description: '<em>array of results</em><br>in this case, the value will be <code>null</code>'
              nullable: true
    AiOptimizationChatGptLlmScraperTaskPostResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AiOptimizationChatGptLlmScraperTaskPostTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    AiOptimizationChatGptLlmScraperTasksReadyResultInfo:
      type: object
      properties:
        id:
          type: string
          description: <em>task identifier of the completed task</em><br><strong>unique task identifier in our system in the <a href="https://en.wikipedia.org/wiki/Universally_unique_identifier">UUID</a> format</strong>
          nullable: true
        se:
          type: string
          description: <em>search engine specified when setting the task</em>
          nullable: true
        function:
          type: string
          description: '<em>funciton type</em><br>example: <code>{{low_se_type_under}}</code>'
          nullable: true
        date_posted:
          type: string
          description: <em>date when the task was posted (in the UTC format)</em>
          nullable: true
        tag:
          type: string
          description: <em>user-defined task identifier</em>
          nullable: true
        endpoint_advanced:
          type: string
          description: '<em>URL for collecting the results of the Advanced task</em><br>if the Advanced function is not supported in the specified endpoint, the value will be <code>null</code>'
          nullable: true
        endpoint_html:
          type: string
          description: '<em>URL for collecting the results of the HTML task</em><br>if the HTML function is not supported in the specified endpoint, the value will be <code>null</code>'
          nullable: true
    AiOptimizationChatGptLlmScraperTasksReadyTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AiOptimizationChatGptLlmScraperTasksReadyResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    AiOptimizationChatGptLlmScraperTasksReadyResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AiOptimizationChatGptLlmScraperTasksReadyTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    ChatgptSearchResult:
      type: object
      properties:
        type:
          type: string
          description: type of element
          nullable: true
        url:
          type: string
          description: <em>result URL</em>
          nullable: true
        domain:
          type: string
          description: <em>result domain</em>
          nullable: true
        title:
          type: string
          description: <em>result title</em>
          nullable: true
        description:
          type: string
          description: <em>result description</em>
          nullable: true
        breadcrumb:
          type: string
          description: <em>breadcrumb</em>
          nullable: true
    SourceInfo:
      type: object
      properties:
        type:
          type: string
          description: type of element
          nullable: true
        title:
          type: string
          description: <em>source title</em>
          nullable: true
        snippet:
          type: string
          description: <em>source description</em>
          nullable: true
        domain:
          type: string
          description: <em>source domain in SERP</em>
          nullable: true
        url:
          type: string
          description: <em>source URL</em>
          nullable: true
        thumbnail:
          type: string
          description: <em>source thumbnail</em>
          nullable: true
        source_name:
          type: string
          description: <em>source name</em>
          nullable: true
        publication_date:
          type: string
          description: '<em>date and time when the result was published</em><br>in the format: “year-month-date:minutes:UTC_difference_hours:UTC_difference_minutes”<br>example:<br><code class="long-string">2019-11-15 12:57:46 +00:00</code>'
          nullable: true
        markdown:
          type: string
          description: <em>content of the element in markdown format</em><br>content of the result formatted in the <a href="https://en.wikipedia.org/wiki/Markdown" target="_blank">markdown markup language</a>
          nullable: true
    ChatGptBrandEntity:
      type: object
      properties:
        type:
          type: string
          description: type of element
          nullable: true
        title:
          type: string
          description: <em>name of the brand</em>
          nullable: true
        category:
          type: string
          description: <em>category of the brand</em>
          nullable: true
        markdown:
          type: string
          description: <em>brand name in markdown format</em><br>contains brand name formatted in the <a href="https://en.wikipedia.org/wiki/Markdown" target="_blank">markdown markup language</a>
          nullable: true
        urls:
          type: object
          description: <em> array of URLs and domains relevant to the brand</em>
          nullable: true
    ExploreBrandsElement:
      type: object
      properties:
        type:
          type: string
          description: type of element
          nullable: true
        title:
          type: string
          description: title of the row
          nullable: true
        url:
          type: string
          description: URL of element
          nullable: true
        domain:
          type: string
          description: domain where a link points
          nullable: true
        description:
          type: string
          description: description of the results element in SERP
          nullable: true
        image_url:
          type: string
          description: URL of the image
          nullable: true
        xpath:
          type: string
          description: the XPath of the element
          nullable: true
    ChatGptTextElementItem:
      type: object
      allOf:
        - type: object
          oneOf:
            - $ref: '#/components/schemas/BaseChatGptLlmScraperElementItem'
          nullable: true
        - type: object
          properties:
            markdown:
              type: string
              description: <em>content of the element in markdown format</em><br>content of the result formatted in the <a href="https://en.wikipedia.org/wiki/Markdown" target="_blank">markdown markup language</a>
              nullable: true
            sources:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SourceInfo'
                nullable: true
              description: <em>array of sources</em>
              nullable: true
            brand_entities:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/ChatGptBrandEntity'
                nullable: true
              description: <em>array of brand entities</em><br>contains information on brands mentioned in the text
              nullable: true
    ChatGptTableElementItem:
      type: object
      allOf:
        - type: object
          oneOf:
            - $ref: '#/components/schemas/BaseChatGptLlmScraperElementItem'
          nullable: true
        - type: object
          properties:
            text:
              type: string
              description: <em>text of the element</em>
              nullable: true
            markdown:
              type: string
              description: <em>content of the element in markdown format</em><br>content of the result formatted in the <a href="https://en.wikipedia.org/wiki/Markdown" target="_blank">markdown markup language</a>
              nullable: true
            table:
              type: object
              oneOf:
                - $ref: '#/components/schemas/Table'
              description: <em>table present in the element</em><br>the header and content of the table present in the element
              nullable: true
            brand_entities:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/ChatGptBrandEntity'
                nullable: true
              description: <em>array of brand entities</em><br>contains information on brands mentioned in the text
              nullable: true
    ChatGptNavigationListElementItem:
      type: object
      allOf:
        - type: object
          oneOf:
            - $ref: '#/components/schemas/BaseChatGptLlmScraperElementItem'
          nullable: true
        - type: object
          properties:
            title:
              type: string
              description: <em>name of the brand</em>
              nullable: true
            sources:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SourceInfo'
                nullable: true
              description: <em>array of sources</em>
              nullable: true
    GeminiImagesElement:
      type: object
      properties:
        type:
          type: string
          description: type of element
          nullable: true
        url:
          type: string
          description: <em>URL</em>
          nullable: true
        alt:
          type: string
          description: <i>alt tag of the image</i>
          nullable: true
        image_url:
          type: string
          description: <em>URL of the image</em><br>the URL leading to the image on the original resource or DataForSEO storage (in case the original source is not available)
          nullable: true
        markdown:
          type: string
          description: <em>content of the element in markdown format</em><br>content of the result formatted in the <a href="https://en.wikipedia.org/wiki/Markdown" target="_blank">markdown markup language</a>
          nullable: true
    ChatGptImagesElementItem:
      type: object
      allOf:
        - type: object
          oneOf:
            - $ref: '#/components/schemas/BaseChatGptLlmScraperElementItem'
          nullable: true
        - type: object
          properties:
            markdown:
              type: string
              description: <em>content of the element in markdown format</em><br>content of the result formatted in the <a href="https://en.wikipedia.org/wiki/Markdown" target="_blank">markdown markup language</a>
              nullable: true
            items:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/GeminiImagesElement'
                nullable: true
              description: <em>elements of ChatGPT results</em>
              nullable: true
    ChatGptGoogleShoppingProduct:
      type: object
      properties:
        type:
          type: string
          description: type of element
          nullable: true
        ei:
          type: string
          description: <em>event identifier</em><br>internal event identifier used by Google
          nullable: true
        product_id:
          type: string
          description: <em>product identifier</em><br>can be used as a <code>data_docid</code> in <a href="https://docs.dataforseo.com/v3/merchant/google/overview/" target="_blank">Google Shopping API endpoints
          nullable: true
        catalog_id:
          type: string
          description: <em>Google Shopping catalog identifier of the product</em><br>can be used as a <code>product_id</code> in <a href="https://docs.dataforseo.com/v3/merchant/google/overview/" target="_blank">Google Shopping API endpoints</a>
          nullable: true
        gpcid:
          type: string
          description: <em>Google product cluster identifier</em><br>can be used as a <code>gid</code> in <a href="https://docs.dataforseo.com/v3/merchant/google/overview/" target="_blank">Google Shopping API endpoints</a>
          nullable: true
        headline_offer_docid:
          type: string
          description: <em>document identifier of the main offer in the headline</em><br>can be used as a <code>data_docid</code> in <a href="https://docs.dataforseo.com/v3/merchant/google/overview/" target="_blank">Google Shopping API endpoints</a>
          nullable: true
        image_docid:
          type: string
          description: <em>identifier for the displayed product’s image</em>
          nullable: true
        rds:
          type: string
          description: <em>resource descriptor string </em><br>internal Google resource descriptor string that identifies the product within Google's Shopping index
          nullable: true
        query:
          type: string
          description: <em>search query</em><br>search query used by ChatGPT to retrieve the product from Google Shopping
          nullable: true
        mid:
          type: string
          description: <em>merchant identifier</em><br>identifier of the seller or merchant account in Google Shopping
          nullable: true
        pvt:
          type: string
          description: <em>product view type</em><br>internal Google parameter that specifies the product view type used when rendering the product item
          nullable: true
        uule:
          type: string
          description: <em>encoded location parameter</em><br>indicates the location for a search
          nullable: true
        gl:
          type: string
          description: <em>country code</em><br>indicates the location for which search results are displayed
          nullable: true
        hl:
          type: string
          description: <em>host language code</em><br>indicates the language in which search results are displayed
          nullable: true
    ChatGptProductsElement:
      type: object
      properties:
        type:
          type: string
          description: type of element
          nullable: true
        product_id:
          type: string
          description: <em>product id</em>
          nullable: true
        merchants:
          type: string
          description: <em>merchant(s) offering the product</em>
          nullable: true
        id_to_token_map:
          type: string
          description: <em>product identifier token</em><br>Base64-encoded token containing Google Shopping product IDs associated with the product
          nullable: true
        title:
          type: string
          description: <em>title of the element</em>
          nullable: true
        rating:
          type: object
          oneOf:
            - $ref: '#/components/schemas/RatingInfo'
          description: <em>rating of the corresponding local business</em><br>popularity rate based on reviews as displayed in the results
          nullable: true
        price:
          type: number
          description: <em>product price</em>
          nullable: true
        currency:
          type: string
          description: <em>currency of the listed price</em><br>ISO code of the currency applied to the price
          nullable: true
        tag:
          type: string
          description: <em>tag text</em>
          nullable: true
        url:
          type: string
          description: <em>URL</em>
          nullable: true
        domain:
          type: string
          description: <em>domain</em>
          nullable: true
        images:
          type: array
          items:
            type: string
            nullable: true
          description: <em>image URLs of the element</em><br>contains URLs leading to the images on the original resource or DataForSEO storage (in case the original source is not available)
          nullable: true
        product_ids:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/ChatGptGoogleShoppingProduct'
            nullable: true
          description: <em>Google Shopping product identifiers</em><br>array of Google Shopping product IDs associated with the product
          nullable: true
    ChatGptProductsElementItem:
      type: object
      allOf:
        - type: object
          oneOf:
            - $ref: '#/components/schemas/BaseChatGptLlmScraperElementItem'
          nullable: true
        - type: object
          properties:
            items:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/ChatGptProductsElement'
                nullable: true
              description: <em>elements of ChatGPT results</em>
              nullable: true
    ChatGptLocalBusinessesElement:
      type: object
      properties:
        type:
          type: string
          description: type of element
          nullable: true
        title:
          type: string
          description: <em>title of the element</em>
          nullable: true
        description:
          type: string
          description: <em>description of the local business</em>
          nullable: true
        address:
          type: string
          description: <em>address of the local business</em>
          nullable: true
        phone:
          type: string
          description: <em>phone of the local business</em>
          nullable: true
        reviews_count:
          type: integer
          description: <em>total number of reviews submitted for the local business</em>
          format: int64
          nullable: true
        url:
          type: string
          description: <em>URL</em>
          nullable: true
        domain:
          type: string
          description: <em>domain</em>
          nullable: true
        rating:
          type: object
          oneOf:
            - $ref: '#/components/schemas/RatingInfo'
          description: <em>rating of the corresponding local business</em><br>popularity rate based on reviews as displayed in the results
          nullable: true
    ChatGptLocalBusinessesElementItem:
      type: object
      allOf:
        - type: object
          oneOf:
            - $ref: '#/components/schemas/BaseChatGptLlmScraperElementItem'
          nullable: true
        - type: object
          properties:
            markdown:
              type: string
              description: <em>content of the element in markdown format</em><br>content of the result formatted in the <a href="https://en.wikipedia.org/wiki/Markdown" target="_blank">markdown markup language</a>
              nullable: true
            items:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/ChatGptLocalBusinessesElement'
                nullable: true
              description: <em>elements of ChatGPT results</em>
              nullable: true
    ChatGptAdAdvertiser:
      type: object
      properties:
        name:
          type: string
          description: <em>name of the advertiser</em>
          nullable: true
        url:
          type: string
          description: <em>source URL</em>
          nullable: true
        favicon_url:
          type: string
          description: <em>URL of the advertiser's favicon image</em>
          nullable: true
    ChatGptAdElementItem:
      type: object
      allOf:
        - type: object
          oneOf:
            - $ref: '#/components/schemas/BaseChatGptLlmScraperElementItem'
          nullable: true
        - type: object
          properties:
            is_rendered:
              type: boolean
              description: '<em>  indicates whether the ad is displayed to the user</em><br>if `true`, the ad is present in the response and shown on the page<br>if `false`, the ad is present in the response but not displayed to the user'
              nullable: true
            title:
              type: string
              description: <em>name of the brand</em>
              nullable: true
            snippet:
              type: string
              description: <em>source description</em>
              nullable: true
            url:
              type: string
              description: <em>URL</em>
              nullable: true
            domain:
              type: string
              description: <em>domain</em>
              nullable: true
            image_url:
              type: string
              description: <em>URL of the image displayed in the ad</em>
              nullable: true
            advertiser:
              type: object
              oneOf:
                - $ref: '#/components/schemas/ChatGptAdAdvertiser'
              description: <em>information about the advertiser associated with the ad</em>
              nullable: true
    AiOptimizationChatGptLlmScraperTaskGetAdvancedResultInfo:
      type: object
      properties:
        keyword:
          type: string
          description: <em>keyword received in a POST array<br></em><strong>the keyword is returned with decoded %## (plus symbol '+' will be decoded to a space character)</strong>
          nullable: true
        location_code:
          type: integer
          description: <em>location code in a POST array</em>
          nullable: true
        language_code:
          type: string
          description: <em>language code in a POST array</em>
          nullable: true
        model:
          type: string
          description: <em>indicates the model version</em>
          nullable: true
        check_url:
          type: string
          description: <em>direct URL to search engine results<br></em>you can use it to make sure that we provided exact results
          nullable: true
        datetime:
          type: string
          description: '<em>date and time when the result was received</em><br>in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”<br>example:<br><code class="long-string">2019-11-15 12:57:46 +00:00</code>'
          nullable: true
        markdown:
          type: string
          description: <em>content of the element in markdown format</em><br>content of the result formatted in the <a href="https://en.wikipedia.org/wiki/Markdown" target="_blank">markdown markup language</a>
          nullable: true
        search_results:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/ChatgptSearchResult'
            nullable: true
          description: '<em>array of search results</em><br>all web search outputs the model retrieved when looking up information, including duplicates and unused entries'
          nullable: true
        sources:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/SourceInfo'
            nullable: true
          description: <em>array of sources</em><br>the sources the model actually cited or relied on in its final answer
          nullable: true
        fan_out_queries:
          type: array
          items:
            type: string
            nullable: true
          description: <em>array of fan-out queries</em><br>contains related search queries derived from the main query to provide a more comprehensive response
          nullable: true
        brand_entities:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/ChatGptBrandEntity'
            nullable: true
          description: <em>array of brand entities</em><br>contains information on brands mentioned in the response
          nullable: true
        se_results_count:
          type: integer
          description: <em> total number of results</em>
          format: int64
          nullable: true
        item_types:
          type: array
          items:
            type: string
            nullable: true
          description: '<em>types of search results</em><br>contains types of search results (<code>items</code>) found.<br>possible item types:<br><code>chat_gpt_text</code>, <code>chat_gpt_table</code>, <code>chat_gpt_navigation_list</code>, <code>chat_gpt_images</code>, <code>chat_gpt_local_businesses</code>, <code>chat_gpt_products</code>'
          nullable: true
        items_count:
          type: integer
          description: <em>the number of results returned in the <strong><code>items</code></strong> array</em>
          format: int64
          nullable: true
        items:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/BaseChatGptLlmScraperElementItem'
            nullable: true
          description: <em>items present in the element</em>
          nullable: true
    AiOptimizationChatGptLlmScraperTaskGetAdvancedTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AiOptimizationChatGptLlmScraperTaskGetAdvancedResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    AiOptimizationChatGptLlmScraperTaskGetAdvancedResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AiOptimizationChatGptLlmScraperTaskGetAdvancedTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    AiOptimizationChatGptLlmScraperTaskGetHtmlResultInfo:
      type: object
      properties:
        keyword:
          type: string
          description: <em>keyword received in a POST array<br></em><strong>keyword is returned with decoded %## (plus symbol '+' will be decoded to a space character)</strong>
          nullable: true
        location_code:
          type: integer
          description: <em>location code in a POST array</em>
          nullable: true
        language_code:
          type: string
          description: <em>language code in a POST array</em>
          nullable: true
        datetime:
          type: string
          description: '<em>date and time when the result was received</em><br>in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”<br>example:<br><code class="long-string">2019-11-15 12:57:46 +00:00</code>'
          nullable: true
        items_count:
          type: integer
          description: <em>the number of results returned in the <strong><code>items</code></strong> array</em>
          format: int64
          nullable: true
        items:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/HtmlItemInfo'
            nullable: true
          description: <em>elements of search results found</em>
          nullable: true
    AiOptimizationChatGptLlmScraperTaskGetHtmlTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AiOptimizationChatGptLlmScraperTaskGetHtmlResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    AiOptimizationChatGptLlmScraperTaskGetHtmlResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AiOptimizationChatGptLlmScraperTaskGetHtmlTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    AiOptimizationChatGptLlmScraperLiveAdvancedRequestInfo:
      type: object
      properties:
        keyword:
          type: string
          description: '<em>keyword</em><br><strong>required field</strong><br>you can specify <strong>up to 2000 characters</strong> in the <code>keyword</code> field<br>all %## will be decoded (plus character ‘+’ will be decoded to a space character)<br>if you need to use the “%” character for your <code>keyword</code>, please specify it as “%25”;<br>if you need to use the “+” character for your <code>keyword</code>, please specify it as “%2B”<p>learn more about rules and limitations of <code>keyword</code> and <code>keywords</code> fields in DataForSEO APIs in this <a href="https://dataforseo.com/help-center/rules-and-limitations-of-keyword-and-keywords-fields-in-dataforseo-apis" rel="noopener noreferrer" target="_blank">Help Center article</a>'
        location_name:
          type: string
          description: '<em>full name of search engine location</em><br><strong>required field if you don''t specify</strong> <code>location_code</code><br><strong>if you use this field, you don''t need to specify <code>location_code</code></strong><br>you can receive the list of available locations of the search engine with their <code>location_name</code> by making a separate request to the <code>https://api.dataforseo.com/v3/ai_optimization/chat_gpt/llm_scraper/locations</code><br>example:<br><code class="long-string">United States</code>'
        location_code:
          type: integer
          description: '<em>search engine location code</em><br><strong>required field if you don''t specify</strong> <code>location_name</code><br><strong>if you use this field, you don''t need to specify <code>location_name</code></strong><br>you can receive the list of available locations of the search engines with their <code>location_code</code> by making a separate request to the <code>https://api.dataforseo.com/v3/ai_optimization/chat_gpt/llm_scraper/locations</code><br>example:<br><code class="long-string">2840</code>'
        language_name:
          type: string
          description: '<em>full name of search engine language</em><br><strong>required field if you don''t specify <code>language_code</code>;</strong><br>if you use this field, you don''t need to specify <code>language_code</code>;<br>you can receive the list of available languages of the search engine with their <code>language_name</code> by making a separate request to the <code>https://api.dataforseo.com/v3/ai_optimization/chat_gpt/llm_scraper/languages</code>'
        language_code:
          type: string
          description: '<em>search engine language code</em><br><strong>required field if you don''t specify <code>language_name</code>;</strong><br>if you use this field, you don''t need to specify <code>language_name</code>;<br>you can receive the list of available languages of the search engine with their <code>language_code</code> by making a separate request to the <code>https://api.dataforseo.com/v3/ai_optimization/chat_gpt/llm_scraper/languages</code>'
        force_web_search:
          type: boolean
          description: '<em>force AI agent to use web search</em><br>optional field<br>when enabled, the AI model is forced to access and cite current web information;<br>default value: <code>false</code>;<br><strong>Note:</strong> even if the parameter is set to <code>true</code>, there is no guarantee web sources will be cited in the response'
          nullable: true
        tag:
          type: string
          description: <em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response
          nullable: true
      example:
        - language_code: en
          location_code: 2840
          keyword: albert einstein
    AiOptimizationChatGptLlmScraperLiveAdvancedResultInfo:
      type: object
      properties:
        keyword:
          type: string
          description: <em>keyword received in a POST array<br></em><strong>the keyword is returned with decoded %## (plus symbol '+' will be decoded to a space character)</strong>
          nullable: true
        location_code:
          type: integer
          description: <em>location code in a POST array</em>
          nullable: true
        language_code:
          type: string
          description: <em>language code in a POST array</em>
          nullable: true
        model:
          type: string
          description: <em>indicates the model version</em>
          nullable: true
        check_url:
          type: string
          description: <em>direct URL to search engine results<br></em>you can use it to make sure that we provided exact results
          nullable: true
        datetime:
          type: string
          description: '<em>date and time when the result was received</em><br>in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”<br>example:<br><code class="long-string">2019-11-15 12:57:46 +00:00</code>'
          nullable: true
        markdown:
          type: string
          description: <em>content of the element in markdown format</em><br>content of the result formatted in the <a href="https://en.wikipedia.org/wiki/Markdown" target="_blank">markdown markup language</a>
          nullable: true
        search_results:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/ChatgptSearchResult'
            nullable: true
          description: '<em>array of search results</em><br>all web search outputs the model retrieved when looking up information, including duplicates and unused entries'
          nullable: true
        sources:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/SourceInfo'
            nullable: true
          description: <em>array of sources</em><br>the sources the model actually cited or relied on in its final answer
          nullable: true
        fan_out_queries:
          type: array
          items:
            type: string
            nullable: true
          description: <em>array of fan-out queries</em><br>contains related search queries derived from the main query to provide a more comprehensive response
          nullable: true
        brand_entities:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/ChatGptBrandEntity'
            nullable: true
          description: <em>array of brand entities</em><br>contains information on brands mentioned in the response
          nullable: true
        se_results_count:
          type: integer
          description: <em> total number of results</em>
          format: int64
          nullable: true
        item_types:
          type: array
          items:
            type: string
            nullable: true
          description: '<em>types of search results</em><br>contains types of search results (<code>items</code>) found in SERP.<br>possible item types:<br><code>chat_gpt_text</code>, <code>chat_gpt_table</code>, <code>chat_gpt_navigation_list</code>, <code>chat_gpt_images</code>, <code>chat_gpt_local_businesses</code>, <code>chat_gpt_products</code>'
          nullable: true
        items_count:
          type: integer
          description: <em>the number of results returned in the <strong><code>items</code></strong> array</em>
          format: int64
          nullable: true
        items:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/BaseChatGptLlmScraperElementItem'
            nullable: true
          description: <em>elements of ChatGPT results</em>
          nullable: true
    AiOptimizationChatGptLlmScraperLiveAdvancedTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AiOptimizationChatGptLlmScraperLiveAdvancedResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    AiOptimizationChatGptLlmScraperLiveAdvancedResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AiOptimizationChatGptLlmScraperLiveAdvancedTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    AiOptimizationChatGptLlmScraperLiveHtmlRequestInfo:
      type: object
      properties:
        keyword:
          type: string
          description: '<em>keyword</em><br><strong>required field</strong><br>you can specify <strong>up to 2000 characters</strong> in the <code>keyword</code> field<br>all %## will be decoded (plus character ‘+’ will be decoded to a space character)<br>if you need to use the “%” character for your <code>keyword</code>, please specify it as “%25”;<br>if you need to use the “+” character for your <code>keyword</code>, please specify it as “%2B”<p>learn more about rules and limitations of <code>keyword</code> and <code>keywords</code> fields in DataForSEO APIs in this <a href="https://dataforseo.com/help-center/rules-and-limitations-of-keyword-and-keywords-fields-in-dataforseo-apis" rel="noopener noreferrer" target="_blank">Help Center article</a>'
        location_name:
          type: string
          description: '<em>full name of search engine location</em><br><strong>required field if you don''t specify</strong> <code>location_code</code><br><strong>if you use this field, you don''t need to specify <code>location_code</code></strong><br>you can receive the list of available locations of the search engine with their <code>location_name</code> by making a separate request to the <code>https://api.dataforseo.com/v3/ai_optimization/{{low_se_name}}/locations</code><br>example:<br><code class="long-string">United States</code>'
        location_code:
          type: integer
          description: '<em>search engine location code</em><br><strong>required field if you don''t specify</strong> <code>location_name</code><br><strong>if you use this field, you don''t need to specify <code>location_name</code></strong><br>you can receive the list of available locations of the search engines with their <code>location_code</code> by making a separate request to the <code>https://api.dataforseo.com/v3/ai_optimization/{{low_se_name}}/{{low_se_type}}/locations</code><br>example:<br><code class="long-string">2840</code>'
        language_name:
          type: string
          description: '<em>full name of search engine language</em><br><strong>required field if you don''t specify</strong> <code>language_code</code><br><strong>if you use this field, you don''t need to specify <code>language_code</code></strong><br>you can receive the list of available languages of the search engine with their <code>language_name</code> by making a separate request to the <code>https://api.dataforseo.com/v3/ai_optimization/{{low_se_name}}/{{low_se_type}}/languages</code><br>example:<br><code class="long-string">English</code>'
        language_code:
          type: string
          description: '<em>search engine language code</em><br><strong>required field if you don''t specify</strong> <code>language_name</code><br><strong>if you use this field, you don''t need to specify <code>language_name</code></strong><br>you can receive the list of available languages of the search engine with their <code>language_code</code>_by making a separate request to the <code>https://api.dataforseo.com/v3/ai_optimization/{{low_se_name}}/{{low_se_type}}/languages</code><br>example:<code class="long-string">en</code>n'
        force_web_search:
          type: boolean
          description: '<em>force AI agent to use web search</em><br>optional field<br>when enabled, the AI model is forced to access and cite current web information;<br>default value: <code>false</code>;<br><strong>Note:</strong> even if the parameter is set to <code>true</code>, there is no guarantee web sources will be cited in the response'
          nullable: true
        expand_citations:
          type: boolean
          description: '<em>return expanded citation bar in HTML results</em><br>optional field<br>to enable this parameter, <code>force_web_search</code> must also be enabled;<br>when enabled, the endpoint will return HTML data from the expanded citation bar;<br>default value: <code>false</code>'
          nullable: true
        tag:
          type: string
          description: <em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response
          nullable: true
      example:
        - language_code: en
          location_code: 2840
          keyword: albert einstein
    AiOptimizationChatGptLlmScraperLiveHtmlResultInfo:
      type: object
      properties:
        keyword:
          type: string
          description: <em>keyword received in a POST array<br></em><strong>keyword is returned with decoded %## (plus character '+' will be decoded to a space character)</strong>
          nullable: true
        location_code:
          type: integer
          description: <em>location code in a POST array</em>
          nullable: true
        language_code:
          type: string
          description: <em>language code in a POST array</em>
          nullable: true
        datetime:
          type: string
          description: '<em>date and time when the result was received</em><br>in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”<br>example:<br><code class="long-string">2019-11-15 12:57:46 +00:00</code>'
          nullable: true
        items_count:
          type: integer
          description: <em>the number of results returned in the <strong><code>items</code></strong> array</em>
          format: int64
          nullable: true
        items:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/HtmlItemInfo'
            nullable: true
          description: <em>elements of search results found</em>
          nullable: true
    AiOptimizationChatGptLlmScraperLiveHtmlTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AiOptimizationChatGptLlmScraperLiveHtmlResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    AiOptimizationChatGptLlmScraperLiveHtmlResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AiOptimizationChatGptLlmScraperLiveHtmlTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    AiOptimizationChatGptLlmResponsesModelsResultInfo:
      type: object
      properties:
        model_name:
          type: string
          description: <em>name of the AI model</em>
          nullable: true
        web_search_supported:
          type: boolean
          description: '<em>web search support for the AI model</em><br>if <code>true</code>, the <code>web_search</code> parameter can be set with the AI model'
          nullable: true
        task_post_supported:
          type: boolean
          description: '<em>indicates if Standard (POST-GET) data retrieval is supported</em><br>if <code>true</code>, you can use the <a href="https://dataforseo.com/help-center/live-vs-standard-method" target="_blank">Standard (POST-GET)</a> data retrieval method with the AI model'
          nullable: true
    AiOptimizationChatGptLlmResponsesModelsTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AiOptimizationChatGptLlmResponsesModelsResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    AiOptimizationChatGptLlmResponsesModelsResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AiOptimizationChatGptLlmResponsesModelsTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    AiOptimizationChatGptLlmResponsesLiveRequestInfo:
      type: object
      properties:
        user_prompt:
          type: string
          description: <em>prompt for the AI model</em><br><strong>required field</strong><br>the question or task you want to send to the AI model;<br>you can specify <strong>up to 500 characters</strong> in the <code>user_prompt</code> field
        model_name:
          type: string
          description: '<em>name of the AI model</em><br><strong>required field</strong><br><code>model_name</code >consists of the actual model name and version name;<br>if the basic model name is specified, its latest version will be set by default;<br>for example, if <code>gpt-4.1</code> is specified, the <code>gpt-4.1-2025-04-14</code> will be set as <code>model_name</code> automatically;<br>you can receive the list of available LLM models by making a separate request to the <code>https://api.dataforseo.com/v3/ai_optimization/chat_gpt/llm_responses/models</code>'
        max_output_tokens:
          type: integer
          description: '<em>maximum number of tokens in the AI response</em><br>optional field<br>minimum value for reasoning models (e.g., <code>reasoning</code> is <code>true</code> in the <a href="/v3/ai_optimization/chat_gpt/llm_responses/models/" target="_blank">Models endpoint</a>): <code>1024</code>;<br>minimum value for non-reasoning models: <code>16</code>;<br>maximum value: <code>4096</code>;<br>default value: <code>2048</code><br><strong>Note:</strong> if <code>web_search</code> is set to <code>true</code> or the reasoning model is specified in the request, the output token count may exceed the specified <code>max_output_tokens</code> limit'
          nullable: true
        temperature:
          type: number
          description: '<em>randomness of the AI response</em><br>optional field<br>higher values make output more diverse; <br>lower values make output more focused;<br>minimum value: <code>0</code><br>maximum value: <code>2</code><br>default value: <code>0.94</code><br><strong>Note:</strong> not supported in reasoning models'
          nullable: true
        top_p:
          type: number
          description: '<em>diversity of the AI response</em><br>optional field <br>controls diversity of the response by limiting token selection;<br>minimum value: <code>0</code><br>maximum value: <code>1</code> <br>default value: <code>0.92</code><p><strong>Note:</strong>  <code>top_p</code> cannot be used together with <code>temperature</code> in the same request'
          nullable: true
        web_search:
          type: boolean
          description: '<em>enable web search</em><br>optional field<br>when enabled, the AI model can access and cite current web information;<br>default value: <code>false</code>;<br><strong>Note:</strong> refer to the <a href="https://docs.dataforseo.com/v3/ai_optimization/chat_gpt/llm_responses/models/">Models endpoint</a> for a list of models that support <code>web_search</code>;'
          nullable: true
        force_web_search:
          type: boolean
          description: '<em>force AI agent to use web search</em><br>optional field<br>to enable this parameter, <code>web_search</code> must also be enabled;<br>when enabled, the AI model is forced to access and cite current web information;<br>default value: <code>false</code>;<br><strong>Note:</strong> even if the parameter is set to <code>true</code>, there is no guarantee web sources will be cited in the response <br><strong>Note #2:</strong> not supported in reasoning models'
          nullable: true
        web_search_country_iso_code:
          type: string
          description: '<em>ISO country code of the location</em><br>optional field<br>to enable this parameter, <code>web_search</code> must also be enabled;<br>when enabled, the AI model will search the web from the country you specify;<br><strong>Note:</strong> not supported in <code>o3-mini</code>, <code>o1-pro</code>, <code>o1</code> models'
          nullable: true
        web_search_city:
          type: string
          description: '<em>city name of the location</em><br>optional field<br><strong>Note:</strong> not supported in <code>o3-mini</code>, <code>o1-pro</code>, <code>o1</code> models'
          nullable: true
        system_message:
          type: string
          description: '<em>instructions for the AI behaviour</em><br>optional field<br>defines the AI''s role, tone, or specific behavior <br>you can specify <strong>up to 500 characters</strong> in the <code>system_message</code> field'
          nullable: true
        message_chain:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/LlmMessageChainItem'
            nullable: true
          description: "conversation history\noptional field\narray of message objects representing previous conversation turns;\neach object must contain:\nrole string with either user or ai role;\nmessage string with message content (max 500 characters);\nyou can specify maximum of 10 message objects in the array;\nNote: for Perplexity models, messages must strictly alternate between user and AI roles (user → ai);\nexample:\n\"message_chain\": [{\"role\":\"user\",\"message\":\"Hello, what’s up?\"},{\"role\":\"ai\",\"message\":\"Hello! I’m doing well, thank you. How can I assist you today?\"}]"
          nullable: true
        tag:
          type: string
          description: <em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response
          nullable: true
      example:
        - system_message: communicate as if we are in a business meeting
          message_chain:
            - role: user
              message: 'Hello, what’s up?'
            - role: ai
              message: 'Hello! I’m doing well, thank you. How can I assist you today? Are there any specific topics or projects you’d like to discuss in our meeting?'
          max_output_tokens: 200
          temperature: 0.3
          top_p: 0.5
          model_name: gpt-4.1-mini
          web_search: true
          web_search_country_iso_code: FR
          web_search_city: Paris
          user_prompt: provide information on how relevant the amusement park business is in France now
    ReasoningAiOptimizationLlmResponseElementItem:
      type: object
      allOf:
        - type: object
          oneOf:
            - $ref: '#/components/schemas/BaseAiOptimizationLlmResponseElementItem'
          nullable: true
        - type: object
          properties:
            sections:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/LocalJustificationInfo'
                nullable: true
              description: <em>reasoning chain sections</em><br>array of objects containing the reasoning chain sections generated by the LLM
              nullable: true
    AnnotationInfo:
      type: object
      properties:
        title:
          type: string
          description: <em>the domain name or title of the quoted source</em>
          nullable: true
        url:
          type: string
          description: <em>redirect URL to the quoted source</em><br>contains a Vertex AI redirect that leads to the original source
          nullable: true
        direct_url:
          type: string
          description: <em>direct URL to the quoted source</em><br>contains the original source URL that the Vertex AI redirect in the `url` field leads to
          nullable: true
        start_index:
          type: integer
          description: <em>start of the annotation indexing</em>
          nullable: true
        end_index:
          type: integer
          description: <em>end of the annotation indexing</em>
          nullable: true
        text:
          type: string
          description: <em>text of the reasoning chain section</em><br>text of the reasoning chain  section summarizing the model's thought process
          nullable: true
    LlmMessageSectionInfo:
      type: object
      properties:
        type:
          type: string
          description: type of element
          nullable: true
        text:
          type: string
          description: <em>text of the reasoning chain section</em><br>text of the reasoning chain  section summarizing the model's thought process
          nullable: true
        annotations:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/AnnotationInfo'
            nullable: true
          description: '<em>array of references used to generate the response</em><br>equals <code>null</code> if the <code>web_search</code> parameter is not set to <code>true</code><br><strong>Note:</strong> <code>annotations</code> may return empty even when <code>web_search</code> is <code>true</code>, as the AI will attempt to retrieve web information but may not find relevant results'
          nullable: true
    MessageAiOptimizationLlmResponseElementItem:
      type: object
      allOf:
        - type: object
          oneOf:
            - $ref: '#/components/schemas/BaseAiOptimizationLlmResponseElementItem'
          nullable: true
        - type: object
          properties:
            sections:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/LlmMessageSectionInfo'
                nullable: true
              description: <em>reasoning chain sections</em><br>array of objects containing the reasoning chain sections generated by the LLM
              nullable: true
    AiOptimizationChatGptLlmResponsesLiveResultInfo:
      type: object
      properties:
        model_name:
          type: string
          description: <em>name of the AI model used</em>
          nullable: true
        input_tokens:
          type: integer
          description: <em>number of tokens in the input</em><br>total count of tokens processed
          nullable: true
        output_tokens:
          type: integer
          description: <em>number of tokens in the output</em><br>total count of tokens generated in the AI response
          nullable: true
        reasoning_tokens:
          type: integer
          description: <em>number of reasoning tokens</em><br>total count of tokens used to generate reasoning content
          nullable: true
        web_search:
          type: boolean
          description: <em>indicates if web search was used</em>
          nullable: true
        money_spent:
          type: number
          description: '<em>cost of AI tokens, USD</em><br>the price charged by the third-party AI model provider for according to its <a href="https://platform.openai.com/docs/pricing" target="_blank">Pricing</a>'
          nullable: true
        datetime:
          type: string
          description: '<em>date and time when the result was received</em><br>in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”<br>example:<br><code class="long-string">2019-11-15 12:57:46 +00:00</code>'
          nullable: true
        items:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/BaseAiOptimizationLlmResponseElementItem'
            nullable: true
          description: <em>array of response items</em><br>contains structured AI response data
          nullable: true
        fan_out_queries:
          type: array
          items:
            type: string
            nullable: true
          description: <em>array of fan-out queries</em><br>contains related search queries derived from the main query to provide a more comprehensive response
          nullable: true
    AiOptimizationChatGptLlmResponsesLiveTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AiOptimizationChatGptLlmResponsesLiveResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    AiOptimizationChatGptLlmResponsesLiveResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AiOptimizationChatGptLlmResponsesLiveTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    AiOptimizationChatGptLlmResponsesTaskPostRequestInfo:
      type: object
      properties:
        user_prompt:
          type: string
          description: <em>prompt for the AI model</em><br><strong>required field</strong><br>the question or task you want to send to the AI model;<br>you can specify <strong>up to 500 characters</strong> in the <code>user_prompt</code> field
        model_name:
          type: string
          description: '<em>name of the AI model</em><br><strong>required field</strong><br><code>model_name</code >consists of the actual model name and version name;<br>if the basic model name is specified, its latest version will be set by default;<br>for example, if <code>gpt-4.1</code> is specified, the <code>gpt-4.1-2025-04-14</code> will be set as <code>model_name</code> automatically;<br>you can receive the list of available LLM models by making a separate request to the <code>https://api.dataforseo.com/v3/ai_optimization/chat_gpt/llm_responses/models</code>'
        max_output_tokens:
          type: integer
          description: '<em>maximum number of tokens in the AI response</em><br>optional field<br>minimum value for reasoning models (e.g., <code>reasoning</code> is <code>true</code> in the <a href="/v3/ai_optimization/chat_gpt/llm_responses/models/" target="_blank">Models endpoint</a>): <code>1024</code>;<br>minimum value for non-reasoning models: <code>16</code>;<br>maximum value: <code>4096</code>;<br>default value: <code>2048</code>'
          nullable: true
        temperature:
          type: number
          description: '<em>randomness of the AI response</em><br>optional field<br>higher values make output more diverse; <br>lower values make output more focused;<br>minimum value: <code>0</code><br>maximum value: <code>2</code><br>default value: <code>0.94</code><br><strong>Note:</strong> not supported in reasoning models'
          nullable: true
        top_p:
          type: number
          description: '<em>diversity of the AI response</em><br>optional field <br>controls diversity of the response by limiting token selection;<br>minimum value: <code>0</code><br>maximum value: <code>1</code> <br>default value: <code>0.92</code><p><strong>Note:</strong>  <code>top_p</code> cannot be used together with <code>temperature</code> in the same request'
          nullable: true
        web_search:
          type: boolean
          description: '<em>enable web search</em><br>optional field<br>when enabled, the AI model can access and cite current web information;<br>default value: <code>false</code>;<br><strong>Note:</strong> refer to the <a href="https://docs.dataforseo.com/v3/ai_optimization/chat_gpt/llm_responses/models/">Models endpoint</a> for a list of models that support <code>web_search</code>;'
          nullable: true
        force_web_search:
          type: boolean
          description: '<em>force AI agent to use web search</em><br>optional field<br>to enable this parameter, <code>web_search</code> must also be enabled;<br>when enabled, the AI model is forced to access and cite current web information;<br>default value: <code>false</code>;<br><strong>Note:</strong> even if the parameter is set to <code>true</code>, there is no guarantee web sources will be cited in the response <br><strong>Note #2:</strong> not supported in reasoning models'
          nullable: true
        web_search_country_iso_code:
          type: string
          description: '<em>ISO country code of the location</em><br>optional field<br>to enable this parameter, <code>web_search</code> must also be enabled;<br>when enabled, the AI model will search the web from the country you specify;<br><strong>Note:</strong> not supported in <code>o3-mini</code>, <code>o1-pro</code>, <code>o1</code> models'
          nullable: true
        web_search_city:
          type: string
          description: '<em>city name of the location</em><br>optional field<br><strong>Note:</strong> not supported in <code>o3-mini</code>, <code>o1-pro</code>, <code>o1</code> models'
          nullable: true
        system_message:
          type: string
          description: '<em>instructions for the AI behaviour</em><br>optional field<br>defines the AI''s role, tone, or specific behavior;<br>you can specify <strong>up to 500 characters</strong> in the <code>system_message</code> field'
          nullable: true
        message_chain:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/LlmMessageChainItem'
            nullable: true
          description: "conversation history\noptional field\narray of message objects representing previous conversation turns;\neach object must contain:\nrole string with either user or ai role;\nmessage string with message content (max 500 characters);\nyou can specify maximum of 10 message objects in the array;\nNote: for Perplexity models, messages must strictly alternate between user and AI roles (user → ai);\nexample:\n\"message_chain\": [{\"role\":\"user\",\"message\":\"Hello, what’s up?\"},{\"role\":\"ai\",\"message\":\"Hello! I’m doing well, thank you. How can I assist you today?\"}]"
          nullable: true
        postback_url:
          type: string
          description: '<em>URL for sending task results</em><br>optional field<br>once the task is completed, we will send a POST request with its results compressed in the <code>gzip</code> format to the <code>postback_url</code> you specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/postbackscript?id=$id</code><br><code>http://your-server.com/postbackscript?id=$id&amp;tag=$tag</code><br><strong>Note:</strong> special character in <code>postback_url</code> will be urlencoded;<br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href="https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api" target="_blank" rel="noopener noreferrer">Help Center</a>'
          nullable: true
        pingback_url:
          type: string
          description: '<em>notification URL of a completed task</em><br>optional field<br>when a task is completed we will notify you by GET request sent to the URL you have specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request<br>example:<br><code>http://your-server.com/pingscript?id=$id</code><br><code>http://your-server.com/pingscript?id=$id&amp;tag=$tag</code><br><strong>Note:</strong> special character in <code>pingback_url</code> will be urlencoded;<br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href="https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api" target="_blank" rel="noopener noreferrer">Help Center</a>'
          nullable: true
        tag:
          type: string
          description: <em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> array of the response
          nullable: true
      example:
        - system_message: communicate as if we are in a business meeting
          message_chain:
            - role: user
              message: 'Hello, what’s up?'
            - role: ai
              message: 'Hello! I’m doing well, thank you. How can I assist you today? Are there any specific topics or projects you’d like to discuss in our meeting?'
          model_name: gpt-4.1-mini
          user_prompt: provide information on how relevant the amusement park business is in France now
    AiOptimizationChatGptLlmResponsesTaskPostTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: object
              description: '<em>array of results</em><br>in this case, the value will be <code>null</code>'
              nullable: true
    AiOptimizationChatGptLlmResponsesTaskPostResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AiOptimizationChatGptLlmResponsesTaskPostTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    AiOptimizationChatGptLlmResponsesTasksReadyResultInfo:
      type: object
      properties:
        id:
          type: string
          description: <em>task identifier of the completed task</em><br><strong>unique task identifier in our system in the <a href="https://en.wikipedia.org/wiki/Universally_unique_identifier">UUID</a> format</strong>
          nullable: true
        se:
          type: string
          description: <em>LLM model specified when setting the task</em>
          nullable: true
        se_type:
          type: string
          nullable: true
        date_posted:
          type: string
          description: <em>date when the task was posted (in the UTC format)</em>
          nullable: true
        tag:
          type: string
          description: <em>user-defined task identifier</em>
          nullable: true
        endpoint:
          type: string
          description: <em>URL for collecting the results of the task</em>
          nullable: true
    AiOptimizationChatGptLlmResponsesTasksReadyTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AiOptimizationChatGptLlmResponsesTasksReadyResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    AiOptimizationChatGptLlmResponsesTasksReadyResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AiOptimizationChatGptLlmResponsesTasksReadyTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    AiOptimizationChatGptLlmResponsesTaskGetResultInfo:
      type: object
      properties:
        model_name:
          type: string
          description: <em>name of the AI model used</em>
          nullable: true
        input_tokens:
          type: integer
          description: <em>number of tokens in the input</em><br>total count of tokens processed
          nullable: true
        output_tokens:
          type: integer
          description: <em>number of tokens in the output</em><br>total count of tokens generated in the AI response
          nullable: true
        reasoning_tokens:
          type: integer
          description: <em>number of reasoning tokens</em><br>total count of tokens used to generate reasoning content
          nullable: true
        web_search:
          type: boolean
          description: <em>indicates if web search was used</em>
          nullable: true
        money_spent:
          type: number
          description: '<em>cost of AI tokens, USD</em><br>the price charged by the third-party AI model provider for according to its <a href="https://platform.openai.com/docs/pricing" target="_blank">Pricing</a>'
          nullable: true
        datetime:
          type: string
          description: '<em>date and time when the result was received</em><br>in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”<br>example:<br><code class="long-string">2019-11-15 12:57:46 +00:00</code>'
          nullable: true
        items:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/BaseAiOptimizationLlmResponseElementItem'
            nullable: true
          description: <em>array of response items</em><br>contains structured AI response data
          nullable: true
        fan_out_queries:
          type: array
          items:
            type: string
            nullable: true
          description: <em>array of fan-out queries</em><br>contains related search queries derived from the main query to provide a more comprehensive response
          nullable: true
    AiOptimizationChatGptLlmResponsesTaskGetTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AiOptimizationChatGptLlmResponsesTaskGetResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    AiOptimizationChatGptLlmResponsesTaskGetResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AiOptimizationChatGptLlmResponsesTaskGetTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    AiOptimizationClaudeLlmResponsesModelsResultInfo:
      type: object
      properties:
        model_name:
          type: string
          description: <em>name of the AI model</em>
          nullable: true
        web_search_supported:
          type: boolean
          description: '<em>web search support for the AI model</em><br>if <code>true</code>, the <code>web_search</code> parameter can be set with the AI model'
          nullable: true
        task_post_supported:
          type: boolean
          description: '<em>indicates if Standard (POST-GET) data retrieval is supported</em><br>if <code>true</code>, you can use the <a href="https://dataforseo.com/help-center/live-vs-standard-method" target="_blank">Standard (POST-GET)</a> data retrieval method with the AI model'
          nullable: true
    AiOptimizationClaudeLlmResponsesModelsTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AiOptimizationClaudeLlmResponsesModelsResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    AiOptimizationClaudeLlmResponsesModelsResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AiOptimizationClaudeLlmResponsesModelsTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    AiOptimizationClaudeLlmResponsesLiveRequestInfo:
      type: object
      properties:
        user_prompt:
          type: string
          description: <em>prompt for the AI model</em><br><strong>required field</strong><br>the question or task you want to send to the AI model;<br>you can specify <strong>up to 500 characters</strong> in the <code>user_prompt</code> field
        model_name:
          type: string
          description: '<em>name of the AI model</em><br><strong>required field</strong><br><code>model_name</code >consists of the actual model name and version name;<br>if the basic model name is specified, its latest version will be set by default;<br>for example, if <code>claude-opus-4-0</code> is specified, the <code>claude-opus-4-20250514</code> will be set as <code>model_name</code> automatically;<br>you can receive the list of available LLM models by making a separate request to the <code>https://api.dataforseo.com/v3/ai_optimization/claude/llm_responses/models</code>'
        max_output_tokens:
          type: integer
          description: '<em>maximum number of tokens in the AI response</em><br>optional field<br>minimum value: <code>1</code>;<br>maximum value: <code>4096</code>;<br>default value: <code>2048</code>;<br><strong>Note:</strong> if <code>web_search</code> is set to <code>true</code> or the reasoning model is specified in the request, the output token count may exceed the specified <code>max_output_tokens</code> limit<br><strong>Note #2:</strong> if <code>use_reasoning</code> is set to <code>true</code>, the minimum value for <code>max_output_tokens</code> is <code>1025</code>'
          nullable: true
        temperature:
          type: number
          description: '<em>randomness of the AI response</em><br>optional field<br>higher values make output more diverse; <br>lower values make output more focused;<br>minimum value: <code>0</code><br>maximum value: <code>1</code><br>default value: <code>0.7</code><p><strong>Note:</strong> <code>temperature</code> cannot be used together with <code>top_p</code> in the same request'
          nullable: true
        top_p:
          type: number
          description: '<em>diversity of the AI response</em><br>optional field <br>controls diversity of the response by limiting token selection;<br>minimum value: <code>0</code><br>maximum value: <code>1</code> <br>default value: <code>null</code><p><strong>Note:</strong> <code>top_p</code> cannot be used together with <code>temperature</code> in the same request'
          nullable: true
        web_search:
          type: boolean
          description: '<em>enable web search for current information</em><br>optional field<br>when enabled, the AI model can access and cite current web information;<br><strong>Note:</strong> refer to the <a href="https://docs.dataforseo.com/v3/ai_optimization/claude/llm_responses/models/">Models endpoint</a> for a list of models that support <code>web_search</code>; <br>default value: <code>false</code>;<br>The cost of the parameter can be calculated on the <a title="Anthropic API Pricing" href="https://docs.anthropic.com/en/docs/about-claude/pricing" target="_blank" rel="noopener noreferrer">Pricing</a> page'
          nullable: true
        force_web_search:
          type: boolean
          description: '<em>force AI agent to use web search</em><br>optional field<br>to enable this parameter, <code>web_search</code> must also be enabled;<br>when enabled, the AI model is forced to access and cite current web information;<br>default value: <code>false</code>;<br><strong>Note:</strong> even if the parameter is set to <code>true</code>, there is no guarantee web sources will be cited in the response'
          nullable: true
        web_search_country_iso_code:
          type: string
          description: '<em>ISO country code of the location used for searching the web</em><br>optional field<br>possible values: <code>''AR'',''AT'',''AU'',''BE'',''BR'',''CA'',''CH'',''CL'',''CN'',''DE'',''DK'',''ES'',''FI'',''FR'',''GB'',''HK'',''ID'',''IN'',''IT'',''JP'',''KR'',''MX'',''MY'',''NL'',''NO'',''NZ'',''PH'',''PL'',''PT'',''RU'',''SA'',''SE'',''TR'',''TW'',''US'',''ZA''</code>'
          nullable: true
        web_search_city:
          type: string
          description: <em>city name of the location used for searching the web</em><br>optional field<br>
          nullable: true
        system_message:
          type: string
          description: '<em>instructions for the AI behaviour</em><br>optional field<br>defines the AI''s role, tone, or specific behavior;<br>you can specify <strong>up to 500 characters</strong> in the <code>system_message</code> field'
          nullable: true
        message_chain:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/LlmMessageChainItem'
            nullable: true
          description: "conversation history\noptional field\narray of message objects representing previous conversation turns;\neach object must contain:\nrole string with either user or ai role;\nmessage string with message content (max 500 characters);\nyou can specify maximum of 10 message objects in the array;\nNote: for Perplexity models, messages must strictly alternate between user and AI roles (user → ai);\nexample:\n\"message_chain\": [{\"role\":\"user\",\"message\":\"Hello, what’s up?\"},{\"role\":\"ai\",\"message\":\"Hello! I’m doing well, thank you. How can I assist you today?\"}]"
          nullable: true
        use_reasoning:
          type: boolean
          description: '<em>enable reasoning for the AI model</em><br>optional field<br>when enabled, the model will perform reasoning before generating a response<br>refer to the <a href="https://docs.dataforseo.com/v3/ai_optimization/claude/llm_responses/models/" target="_blank">Models endpoint</a> for a list of models that support <code>reasoning</code><br>default value: <code>false</code><br><strong>Note:</strong> if set to <code>true</code>, the minimum value for <code>max_output_tokens</code> is <code>1025</code><br><strong>Note #2:</strong> if set to <code>true</code>, <code>force_web_search</code> must be set to <code>false</code><br><strong>Note #3:</strong> if set to <code>true</code>, the <code>temperature</code> and <code>top_p</code> cannot be used'
          nullable: true
        tag:
          type: string
          description: <em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response
          nullable: true
      example:
        - system_message: communicate as if we are in a business meeting
          message_chain:
            - role: user
              message: 'Hello, what’s up?'
            - role: ai
              message: 'Hello! I’m doing well, thank you. How can I assist you today? Are there any specific topics or projects you’d like to discuss in our meeting?'
          max_output_tokens: 200
          model_name: claude-opus-4-0
          temperature: 0.3
          web_search: true
          web_search_country_iso_code: FR
          user_prompt: provide information on how relevant the amusement park business is in France now
    AiOptimizationClaudeLlmResponsesLiveResultInfo:
      type: object
      properties:
        model_name:
          type: string
          description: <em>name of the AI model used</em>
          nullable: true
        input_tokens:
          type: integer
          description: <em>number of tokens in the input</em><br>total count of tokens processed
          nullable: true
        output_tokens:
          type: integer
          description: <em>number of tokens in the output</em><br>total count of tokens generated in the AI response
          nullable: true
        reasoning_tokens:
          type: integer
          description: <em>number of reasoning tokens</em><br>total count of tokens used to generate reasoning content
          nullable: true
        web_search:
          type: boolean
          description: <em>indicates if web search was used</em>
          nullable: true
        money_spent:
          type: number
          description: '<em>cost of AI tokens, USD</em><br>the price charged by the third-party AI model provider for according to its <a href="https://docs.anthropic.com/en/docs/about-claude/pricing" target="_blank">Pricing</a>'
          nullable: true
        datetime:
          type: string
          description: '<em>date and time when the result was received</em><br>in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”<br>example:<br><code class="long-string">2019-11-15 12:57:46 +00:00</code>'
          nullable: true
        items:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/BaseAiOptimizationLlmResponseElementItem'
            nullable: true
          description: <em>array of response items</em><br>contains structured AI response data
          nullable: true
        fan_out_queries:
          type: array
          items:
            type: string
            nullable: true
          description: <em>array of fan-out queries</em><br>contains related search queries derived from the main query to provide a more comprehensive response
          nullable: true
    AiOptimizationClaudeLlmResponsesLiveTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AiOptimizationClaudeLlmResponsesLiveResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    AiOptimizationClaudeLlmResponsesLiveResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AiOptimizationClaudeLlmResponsesLiveTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    AiOptimizationClaudeLlmResponsesTaskPostRequestInfo:
      type: object
      properties:
        user_prompt:
          type: string
          description: <em>prompt for the AI model</em><br><strong>required field</strong><br>the question or task you want to send to the AI model;<br>you can specify <strong>up to 500 characters</strong> in the <code>user_prompt</code> field
        model_name:
          type: string
          description: '<em>name of the AI model</em><br><strong>required field</strong><br><code>model_name</code >consists of the actual model name and version name;<br>if the basic model name is specified, its latest version will be set by default;<br>for example, if <code>claude-opus-4-0</code> is specified, the <code>claude-opus-4-20250514</code> will be set as <code>model_name</code> automatically;<br>you can receive the list of available LLM models by making a separate request to the <code>https://api.dataforseo.com/v3/ai_optimization/claude/llm_responses/models</code>'
        max_output_tokens:
          type: integer
          description: '<em>maximum number of tokens in the AI response</em><br>optional field<br>minimum value: <code>1</code>;<br>maximum value: <code>4096</code>;<br>default value: <code>2048</code>;<br><strong>Note:</strong> if <code>web_search</code> is set to <code>true</code> or the reasoning model is specified in the request, the output token count may exceed the specified <code>max_output_tokens</code> limit<br><strong>Note #2:</strong> if <code>use_reasoning</code> is set to <code>true</code>, the minimum value for <code>max_output_tokens</code> is <code>1025</code>'
          nullable: true
        temperature:
          type: number
          description: '<em>randomness of the AI response</em><br>optional field<br>higher values make output more diverse; <br>lower values make output more focused;<br>minimum value: <code>0</code><br>maximum value: <code>1</code><br>default value: <code>0.7</code><p><strong>Note:</strong> <code>temperature</code> cannot be used together with <code>top_p</code> in the same request'
          nullable: true
        top_p:
          type: number
          description: '<em>diversity of the AI response</em><br>optional field <br>controls diversity of the response by limiting token selection;<br>minimum value: <code>0</code><br>maximum value: <code>1</code> <br>default value: <code>null</code><p><strong>Note:</strong> <code>top_p</code> cannot be used together with <code>temperature</code> in the same request'
          nullable: true
        web_search:
          type: boolean
          description: '<em>enable web search for current information</em><br>optional field<br>when enabled, the AI model can access and cite current web information;<br><strong>Note:</strong> refer to the <a href="https://docs.dataforseo.com/v3/ai_optimization/claude/llm_responses/models/">Models endpoint</a> for a list of models that support <code>web_search</code>; <br>default value: <code>false</code>;<br>The cost of the parameter can be calculated on the <a title="Anthropic API Pricing" href="https://docs.anthropic.com/en/docs/about-claude/pricing" target="_blank" rel="noopener noreferrer">Pricing</a> page'
          nullable: true
        force_web_search:
          type: boolean
          description: '<em>force AI agent to use web search</em><br>optional field<br>to enable this parameter, <code>web_search</code> must also be enabled;<br>when enabled, the AI model is forced to access and cite current web information;<br>default value: <code>false</code>;<br><strong>Note:</strong> even if the parameter is set to <code>true</code>, there is no guarantee web sources will be cited in the response'
          nullable: true
        web_search_country_iso_code:
          type: string
          description: '<em>ISO country code of the location used for searching the web</em><br>optional field<br>possible values: <code>''AR'',''AT'',''AU'',''BE'',''BR'',''CA'',''CH'',''CL'',''CN'',''DE'',''DK'',''ES'',''FI'',''FR'',''GB'',''HK'',''ID'',''IN'',''IT'',''JP'',''KR'',''MX'',''MY'',''NL'',''NO'',''NZ'',''PH'',''PL'',''PT'',''RU'',''SA'',''SE'',''TR'',''TW'',''US'',''ZA''</code>'
          nullable: true
        web_search_city:
          type: string
          description: <em>city name of the location used for searching the web</em><br>optional field<br>
          nullable: true
        system_message:
          type: string
          description: '<em>instructions for the AI behaviour</em><br>optional field<br>defines the AI''s role, tone, or specific behavior;<br>you can specify <strong>up to 500 characters</strong> in the <code>system_message</code> field'
          nullable: true
        message_chain:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/LlmMessageChainItem'
            nullable: true
          description: "conversation history\noptional field\narray of message objects representing previous conversation turns;\neach object must contain:\nrole string with either user or ai role;\nmessage string with message content (max 500 characters);\nyou can specify maximum of 10 message objects in the array;\nNote: for Perplexity models, messages must strictly alternate between user and AI roles (user → ai);\nexample:\n\"message_chain\": [{\"role\":\"user\",\"message\":\"Hello, what’s up?\"},{\"role\":\"ai\",\"message\":\"Hello! I’m doing well, thank you. How can I assist you today?\"}]"
          nullable: true
        use_reasoning:
          type: boolean
          description: '<em>enable reasoning for the AI model</em><br>optional field<br>when enabled, the model will perform reasoning before generating a response<br>refer to the <a href="https://docs.dataforseo.com/v3/ai_optimization/claude/llm_responses/models/" target="_blank">Models endpoint</a> for a list of models that support <code>reasoning</code><br>default value: <code>false</code><br><strong>Note:</strong> if set to <code>true</code>, the minimum value for <code>max_output_tokens</code> is <code>1025</code><br><strong>Note #2:</strong> if set to <code>true</code>, <code>force_web_search</code> must be set to <code>false</code><br><strong>Note #3:</strong> if set to <code>true</code>, the <code>temperature</code> and <code>top_p</code> cannot be used'
          nullable: true
        tag:
          type: string
          description: <em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response
          nullable: true
        postback_url:
          type: string
          description: '<em>URL for sending task results</em><br>optional field<br>once the task is completed, we will send a POST request with its results compressed in the <code>gzip</code> format to the <code>postback_url</code> you specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/postbackscript?id=$id</code><br><code>http://your-server.com/postbackscript?id=$id&amp;tag=$tag</code><br><strong>Note:</strong> special character in <code>postback_url</code> will be urlencoded;<br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href="https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api" target="_blank" rel="noopener noreferrer">Help Center</a>'
          nullable: true
        pingback_url:
          type: string
          description: '<em>notification URL of a completed task</em><br>optional field<br>when a task is completed we will notify you by GET request sent to the URL you have specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request<br>example:<br><code>http://your-server.com/pingscript?id=$id</code><br><code>http://your-server.com/pingscript?id=$id&amp;tag=$tag</code><br><strong>Note:</strong> special character in <code>pingback_url</code> will be urlencoded;<br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href="https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api" target="_blank" rel="noopener noreferrer">Help Center</a>'
          nullable: true
      example:
        - system_message: communicate as if we are in a business meeting
          message_chain:
            - role: user
              message: 'Hello, what’s up?'
            - role: ai
              message: 'Hello! I’m doing well, thank you. How can I assist you today? Are there any specific topics or projects you’d like to discuss in our meeting?'
          max_output_tokens: 1024
          temperature: 0.3
          web_search_country_iso_code: FR
          model_name: claude-sonnet-4-0
          web_search: true
          user_prompt: provide information on how relevant the amusement park business is in France now
    AiOptimizationClaudeLlmResponsesTaskPostTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: object
              description: '<em>array of results</em><br>in this case, the value will be <code>null</code>'
              nullable: true
    AiOptimizationClaudeLlmResponsesTaskPostResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AiOptimizationClaudeLlmResponsesTaskPostTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    AiOptimizationClaudeLlmResponsesTasksReadyResultInfo:
      type: object
      properties:
        id:
          type: string
          description: <em>task identifier of the completed task</em><br><strong>unique task identifier in our system in the <a href="https://en.wikipedia.org/wiki/Universally_unique_identifier">UUID</a> format</strong>
          nullable: true
        se:
          type: string
          description: <em>LLM model specified when setting the task</em>
          nullable: true
        se_type:
          type: string
          nullable: true
        date_posted:
          type: string
          description: <em>date when the task was posted (in the UTC format)</em>
          nullable: true
        tag:
          type: string
          description: <em>user-defined task identifier</em>
          nullable: true
        endpoint:
          type: string
          description: <em>URL for collecting the results of the task</em>
          nullable: true
    AiOptimizationClaudeLlmResponsesTasksReadyTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AiOptimizationClaudeLlmResponsesTasksReadyResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    AiOptimizationClaudeLlmResponsesTasksReadyResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AiOptimizationClaudeLlmResponsesTasksReadyTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    AiOptimizationClaudeLlmResponsesTaskGetResultInfo:
      type: object
      properties:
        model_name:
          type: string
          description: <em>name of the AI model used</em>
          nullable: true
        input_tokens:
          type: integer
          description: <em>number of tokens in the input</em><br>total count of tokens processed
          nullable: true
        output_tokens:
          type: integer
          description: <em>number of tokens in the output</em><br>total count of tokens generated in the AI response
          nullable: true
        reasoning_tokens:
          type: integer
          description: <em>number of reasoning tokens</em><br>total count of tokens used to generate reasoning content
          nullable: true
        web_search:
          type: boolean
          description: <em>indicates if web search was used</em>
          nullable: true
        money_spent:
          type: number
          description: '<em>cost of AI tokens, USD</em><br>the price charged by the third-party AI model provider for according to its <a href="https://docs.anthropic.com/en/docs/about-claude/pricing" target="_blank">Pricing</a>'
          nullable: true
        datetime:
          type: string
          description: '<em>date and time when the result was received</em><br>in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”<br>example:<br><code class="long-string">2019-11-15 12:57:46 +00:00</code>'
          nullable: true
        items:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/BaseAiOptimizationLlmResponseElementItem'
            nullable: true
          description: <em>array of response items</em><br>contains structured AI response data
          nullable: true
        fan_out_queries:
          type: array
          items:
            type: string
            nullable: true
          description: <em>array of fan-out queries</em><br>contains related search queries derived from the main query to provide a more comprehensive response
          nullable: true
    AiOptimizationClaudeLlmResponsesTaskGetTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AiOptimizationClaudeLlmResponsesTaskGetResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    AiOptimizationClaudeLlmResponsesTaskGetResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AiOptimizationClaudeLlmResponsesTaskGetTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    AiOptimizationGeminiLlmResponsesModelsResultInfo:
      type: object
      properties:
        model_name:
          type: string
          description: <em>name of the AI model</em>
          nullable: true
        web_search_supported:
          type: boolean
          description: '<em>web search support for the AI model</em><br>if <code>true</code>, the <code>web_search</code> parameter can be set with the AI model'
          nullable: true
        task_post_supported:
          type: boolean
          description: '<em>indicates if Standard (POST-GET) data retrieval is supported</em><br>if <code>true</code>, you can use the <a href="https://dataforseo.com/help-center/live-vs-standard-method" target="_blank">Standard (POST-GET)</a> data retrieval method with the AI model'
          nullable: true
    AiOptimizationGeminiLlmResponsesModelsTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AiOptimizationGeminiLlmResponsesModelsResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    AiOptimizationGeminiLlmResponsesModelsResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AiOptimizationGeminiLlmResponsesModelsTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    AiOptimizationGeminiLlmResponsesTaskPostRequestInfo:
      type: object
      properties:
        user_prompt:
          type: string
          description: <em>prompt for the AI model</em><br><strong>required field</strong><br>the question or task you want to send to the AI model;<br>you can specify <strong>up to 500 characters</strong> in the <code>user_prompt</code> field
        model_name:
          type: string
          description: '<em>name of the AI model</em><br><strong>required field</strong><br><code>model_name</code >consists of the actual model name and version name;<br>if the basic model name is specified, its latest version will be set by default;<br>for example, if <code>gemini-1.5-pro</code> is specified, the <code>gemini-1.5-pro-002</code> will be set as <code>model_name</code> automatically;<br>you can receive the list of available LLM models by making a separate request to the <code>https://api.dataforseo.com/v3/ai_optimization/gemini/llm_responses/models</code>'
        max_output_tokens:
          type: integer
          description: '<em>maximum number of tokens in the AI response</em><br>optional field<br>minimum value: <code>1</code>;<br>maximum value: <code>4096</code>;<br>default value: <code>2048</code>;<br><strong>Note:</strong> if <code>web_search</code> is set to <code>true</code> or the reasoning model is specified in the request, the output token count may exceed the specified <code>max_output_tokens</code> limit<br><strong>Note #2:</strong> if <code>use_reasoning</code> is set to <code>true</code>, the minimum value for <code>max_output_tokens</code> is <code>1024</code>'
          nullable: true
        temperature:
          type: number
          description: '<em>randomness of the AI response</em><br>optional field<br>higher values make output more diverse <br>lower values make output more focused<br>minimum value: <code>0</code><br>maximum value: <code>2</code><br>default value: <code>1.3</code>'
          nullable: true
        top_p:
          type: number
          description: '<em>diversity of the AI response</em><br>optional field <br>controls diversity of the response by limiting token selection<br>minimum value: <code>0</code><br>maximum value: <code>1</code> <br>default value: <code>0.9</code>'
          nullable: true
        web_search:
          type: boolean
          description: '<em>enable web search for current information</em><br>optional field<br>when enabled, the AI model can access and cite current web information;<br><strong>Note:</strong> refer to the <a href="https://docs.dataforseo.com/v3/ai_optimization/gemini/llm_responses/models/">Models endpoint</a> for a list of models that support <code>web_search</code>; <br>default value: <code>false</code>;<br>The cost of the parameter can be calculated on the <a title="Gemini API Pricing" href="https://ai.google.dev/gemini-api/docs/pricing" target="_blank" rel="noopener noreferrer">Pricing</a> page'
          nullable: true
        system_message:
          type: string
          description: '<em>instructions for the AI behavior</em><br>optional field<br>defines the AI''s role, tone, or specific behavior <br>you can specify <strong>up to 500 characters</strong> in the <code>system_message</code> field'
          nullable: true
        message_chain:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/LlmMessageChainItem'
            nullable: true
          description: "conversation history\noptional field\narray of message objects representing previous conversation turns;\neach object must contain:\nrole string with either user or ai role;\nmessage string with message content (max 500 characters);\nyou can specify maximum of 10 message objects in the array;\nNote: for Perplexity models, messages must strictly alternate between user and AI roles (user → ai);\nexample:\n\"message_chain\": [{\"role\":\"user\",\"message\":\"Hello, what’s up?\"},{\"role\":\"ai\",\"message\":\"Hello! I’m doing well, thank you. How can I assist you today?\"}]"
          nullable: true
        use_reasoning:
          type: boolean
          description: '<em>enable reasoning for the AI model</em><br>optional field<br>when enabled, the model will perform reasoning before generating a response<br>refer to the <a href="https://docs.dataforseo.com/v3/ai_optimization/gemini/llm_responses/models/" target="_blank">Models endpoint</a> for a list of models that support <code>reasoning</code><br>default value: <code>false</code><br><strong>Note:</strong> if set to <code>true</code>, the minimum value for <code>max_output_tokens</code> is <code>1024</code><br><strong>Note #2:</strong> for Gemini Pro models, the <code>use_reasoning</code> will automatically be set to <code>true</code>'
          nullable: true
        tag:
          type: string
          description: <em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response
          nullable: true
        postback_url:
          type: string
          description: '<em>URL for sending task results</em><br>optional field<br>once the task is completed, we will send a POST request with its results compressed in the <code>gzip</code> format to the <code>postback_url</code> you specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/postbackscript?id=$id</code><br><code>http://your-server.com/postbackscript?id=$id&amp;tag=$tag</code><br><strong>Note:</strong> special character in <code>postback_url</code> will be urlencoded;<br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href="https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api" target="_blank" rel="noopener noreferrer">Help Center</a>'
          nullable: true
        pingback_url:
          type: string
          description: '<em>notification URL of a completed task</em><br>optional field<br>when a task is completed we will notify you by GET request sent to the URL you have specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request<br>example:<br><code>http://your-server.com/pingscript?id=$id</code><br><code>http://your-server.com/pingscript?id=$id&amp;tag=$tag</code><br><strong>Note:</strong> special character in <code>pingback_url</code> will be urlencoded;<br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href="https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api" target="_blank" rel="noopener noreferrer">Help Center</a>'
          nullable: true
      example:
        - system_message: communicate as if we are in a business meeting
          message_chain:
            - role: user
              message: 'Hello, what’s up?'
            - role: ai
              message: 'Hello! I’m doing well, thank you. How can I assist you today? Are there any specific topics or projects you’d like to discuss in our meeting?'
          model_name: gemini-2.5-flash
          user_prompt: provide information on how relevant the amusement park business is in France now
    AiOptimizationGeminiLlmResponsesTaskPostTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: object
              description: '<em>array of results</em><br>in this case, the value will be <code>null</code>'
              nullable: true
    AiOptimizationGeminiLlmResponsesTaskPostResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AiOptimizationGeminiLlmResponsesTaskPostTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    AiOptimizationGeminiLlmResponsesTasksReadyResultInfo:
      type: object
      properties:
        id:
          type: string
          description: <em>task identifier of the completed task</em><br><strong>unique task identifier in our system in the <a href="https://en.wikipedia.org/wiki/Universally_unique_identifier">UUID</a> format</strong>
          nullable: true
        se:
          type: string
          description: <em>LLM model specified when setting the task</em>
          nullable: true
        se_type:
          type: string
          nullable: true
        date_posted:
          type: string
          description: <em>date when the task was posted (in the UTC format)</em>
          nullable: true
        tag:
          type: string
          description: <em>user-defined task identifier</em>
          nullable: true
        endpoint:
          type: string
          description: <em>URL for collecting the results of the task</em>
          nullable: true
    AiOptimizationGeminiLlmResponsesTasksReadyTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AiOptimizationGeminiLlmResponsesTasksReadyResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    AiOptimizationGeminiLlmResponsesTasksReadyResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AiOptimizationGeminiLlmResponsesTasksReadyTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    AiOptimizationGeminiLlmResponsesTaskGetResultInfo:
      type: object
      properties:
        model_name:
          type: string
          description: <em>name of the AI model used</em>
          nullable: true
        input_tokens:
          type: integer
          description: <em>number of tokens in the input</em><br>total count of tokens processed
          nullable: true
        output_tokens:
          type: integer
          description: <em>number of tokens in the output</em><br>total count of tokens generated in the AI response
          nullable: true
        reasoning_tokens:
          type: integer
          description: <em>number of reasoning tokens</em><br>total count of tokens used to generate reasoning content
          nullable: true
        web_search:
          type: boolean
          description: <em>indicates if web search was used</em>
          nullable: true
        money_spent:
          type: number
          description: '<em>cost of AI tokens, USD</em><br>the price charged by the third-party AI model provider for according to its <a href="https://platform.openai.com/docs/pricing" target="_blank">Pricing</a>'
          nullable: true
        datetime:
          type: string
          description: '<em>date and time when the result was received</em><br>in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”<br>example:<br><code class="long-string">2019-11-15 12:57:46 +00:00</code>'
          nullable: true
        items:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/BaseAiOptimizationLlmResponseElementItem'
            nullable: true
          description: <em>array of response items</em><br>contains structured AI response data
          nullable: true
        fan_out_queries:
          type: array
          items:
            type: string
            nullable: true
          description: <em>array of fan-out queries</em><br>contains related search queries derived from the main query to provide a more comprehensive response
          nullable: true
    AiOptimizationGeminiLlmResponsesTaskGetTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AiOptimizationGeminiLlmResponsesTaskGetResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    AiOptimizationGeminiLlmResponsesTaskGetResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AiOptimizationGeminiLlmResponsesTaskGetTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    AiOptimizationGeminiLlmResponsesLiveRequestInfo:
      type: object
      properties:
        user_prompt:
          type: string
          description: <em>prompt for the AI model</em><br><strong>required field</strong><br>the question or task you want to send to the AI model;<br>you can specify <strong>up to 500 characters</strong> in the <code>user_prompt</code> field
        model_name:
          type: string
          description: '<em>name of the AI model</em><br><strong>required field</strong><br><code>model_name</code >consists of the actual model name and version name;<br>if the basic model name is specified, its latest version will be set by default;<br>for example, if <code>gemini-1.5-pro</code> is specified, the <code>gemini-1.5-pro-002</code> will be set as <code>model_name</code> automatically;<br>you can receive the list of available LLM models by making a separate request to the <code>https://api.dataforseo.com/v3/ai_optimization/gemini/llm_responses/models</code>'
        max_output_tokens:
          type: integer
          description: '<em>maximum number of tokens in the AI response</em><br>optional field<br>minimum value: <code>1</code><br>maximum value: <code>4096</code>;<br>default value: <code>2048</code>;<br><strong>Note:</strong> if <code>web_search</code> is set to <code>true</code> or the reasoning model is specified in the request, the output token count may exceed the specified <code>max_output_tokens</code> limit<br><strong>Note #2:</strong> if <code>use_reasoning</code> is set to <code>true</code>, the minimum value for <code>max_output_tokens</code> is <code>1024</code>'
          nullable: true
        temperature:
          type: number
          description: '<em>randomness of the AI response</em><br>optional field<br>higher values make output more diverse <br>lower values make output more focused<br>minimum value: <code>0</code><br>maximum value: <code>2</code><br>default value: <code>1.3</code>'
          nullable: true
        top_p:
          type: number
          description: '<em>diversity of the AI response</em><br>optional field <br>controls diversity of the response by limiting token selection<br>minimum value: <code>0</code><br>maximum value: <code>1</code> <br>default value: <code>0.9</code>'
          nullable: true
        web_search:
          type: boolean
          description: '<em>enable web search for current information</em><br>optional field<br>when enabled, the AI model can access and cite current web information;<br><strong>Note:</strong> refer to the <a href="https://docs.dataforseo.com/v3/ai_optimization/gemini/llm_responses/models/">Models endpoint</a> for a list of models that support <code>web_search</code>; <br>default value: <code>false</code>;<br>The cost of the parameter can be calculated on the <a title="Gemini API Pricing" href="https://ai.google.dev/gemini-api/docs/pricing" target="_blank" rel="noopener noreferrer">Pricing</a> page'
          nullable: true
        system_message:
          type: string
          description: '<em>instructions for the AI behavior</em><br>optional field<br>defines the AI''s role, tone, or specific behavior <br>you can specify <strong>up to 500 characters</strong> in the <code>system_message</code> field'
          nullable: true
        message_chain:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/LlmMessageChainItem'
            nullable: true
          description: "conversation history\noptional field\narray of message objects representing previous conversation turns;\neach object must contain:\nrole string with either user or ai role;\nmessage string with message content (max 500 characters);\nyou can specify maximum of 10 message objects in the array;\nNote: for Perplexity models, messages must strictly alternate between user and AI roles (user → ai);\nexample:\n\"message_chain\": [{\"role\":\"user\",\"message\":\"Hello, what’s up?\"},{\"role\":\"ai\",\"message\":\"Hello! I’m doing well, thank you. How can I assist you today?\"}]"
          nullable: true
        use_reasoning:
          type: boolean
          description: '<em>enable reasoning for the AI model</em><br>optional field<br>when enabled, the model will perform reasoning before generating a response<br>refer to the <a href="https://docs.dataforseo.com/v3/ai_optimization/gemini/llm_responses/models/" target="_blank">Models endpoint</a> for a list of models that support <code>reasoning</code><br>default value: <code>false</code><br><strong>Note:</strong> if set to <code>true</code>, the minimum value for <code>max_output_tokens</code> is <code>1024</code><br><strong>Note #2:</strong> for Gemini Pro models, the <code>use_reasoning</code> will automatically be set to <code>true</code>'
          nullable: true
        tag:
          type: string
          description: <em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response
          nullable: true
      example:
        - system_message: communicate as if we are in a business meeting
          message_chain:
            - role: user
              message: 'Hello, what’s up?'
            - role: ai
              message: 'Hello! I’m doing well, thank you. How can I assist you today? Are there any specific topics or projects you’d like to discuss in our meeting?'
          max_output_tokens: 200
          temperature: 0.3
          top_p: 0.5
          model_name: gemini-2.5-flash
          web_search: true
          user_prompt: provide information on how relevant the amusement park business is in France now
    AiOptimizationGeminiLlmResponsesLiveResultInfo:
      type: object
      properties:
        model_name:
          type: string
          description: <em>name of the AI model used</em>
          nullable: true
        input_tokens:
          type: integer
          description: <em>number of tokens in the input</em><br>total count of tokens processed
          nullable: true
        output_tokens:
          type: integer
          description: <em>number of tokens in the output</em><br>total count of tokens generated in the AI response
          nullable: true
        reasoning_tokens:
          type: integer
          description: <em>number of reasoning tokens</em><br>total count of tokens used to generate reasoning content
          nullable: true
        web_search:
          type: boolean
          description: <em>indicates if web search was used</em>
          nullable: true
        money_spent:
          type: number
          description: '<em>cost of AI tokens, USD</em><br>the price charged by the third-party AI model provider for according to its <a href="https://ai.google.dev/gemini-api/docs/pricing" target="_blank">Pricing</a>'
          nullable: true
        datetime:
          type: string
          description: '<em>date and time when the result was received</em><br>in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”<br>example:<br><code class="long-string">2019-11-15 12:57:46 +00:00</code>'
          nullable: true
        items:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/BaseAiOptimizationLlmResponseElementItem'
            nullable: true
          description: <em>array of response items</em><br>contains structured AI response data
          nullable: true
        fan_out_queries:
          type: array
          items:
            type: string
            nullable: true
          description: <em>array of fan-out queries</em><br>contains related search queries derived from the main query to provide a more comprehensive response
          nullable: true
    AiOptimizationGeminiLlmResponsesLiveTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AiOptimizationGeminiLlmResponsesLiveResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    AiOptimizationGeminiLlmResponsesLiveResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AiOptimizationGeminiLlmResponsesLiveTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    AiOptimizationPerplexityLlmResponsesModelsResultInfo:
      type: object
      properties:
        model_name:
          type: string
          description: <em>name of the AI model</em>
          nullable: true
        web_search_supported:
          type: boolean
          description: '<em>web search support for the AI model</em><br>if <code>true</code>, the <code>web_search</code> parameter can be set with the AI model'
          nullable: true
        task_post_supported:
          type: boolean
          description: '<em>indicates if Standard (POST-GET) data retrieval is supported</em><br>if <code>true</code>, you can use the <a href="https://dataforseo.com/help-center/live-vs-standard-method" target="_blank">Standard (POST-GET)</a> data retrieval method with the AI model'
          nullable: true
    AiOptimizationPerplexityLlmResponsesModelsTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AiOptimizationPerplexityLlmResponsesModelsResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    AiOptimizationPerplexityLlmResponsesModelsResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AiOptimizationPerplexityLlmResponsesModelsTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    AiOptimizationPerplexityLlmResponsesLiveRequestInfo:
      type: object
      properties:
        user_prompt:
          type: string
          description: <em>prompt for the AI model</em><br><strong>required field</strong><br>the question or task you want to send to the AI model;<br>you can specify <strong>up to 500 characters</strong> in the <code>user_prompt</code> field
        model_name:
          type: string
          description: '<em>name of the AI model</em><br><strong>required field</strong><br><code>model_name</code >consists of the actual model name and version name;<br>if the basic model name is specified, its latest version will be set by default;<br>you can receive the list of available LLM models by making a separate request to the following endpoint: <code>https://api.dataforseo.com/v3/ai_optimization/perplexity/llm_responses/models</code>'
        max_output_tokens:
          type: integer
          description: '<em>maximum number of tokens in the AI response</em><br>optional field<br>minimum value: <code>1</code><br>maximum value: <code>4096</code>;<br>default value: <code>2048</code>;<br><strong>Note:</strong> if the reasoning model is specified in the request, the output token count may exceed the specified <code>max_output_tokens</code> limit'
          nullable: true
        temperature:
          type: number
          description: '<em>randomness of the AI response</em><br>optional field<br>higher values make output more diverse <br>lower values make output more focused<br>minimum value: <code>0</code><br>maximum value: <code>1.9</code><br>default value: <code>0.77</code>'
          nullable: true
        top_p:
          type: number
          description: '<em>diversity of the AI response</em><br>optional field <br>controls diversity of the response by limiting token selection<br>minimum value: <code>0</code><br>maximum value: <code>1</code> <br>default value: <code>0.9</code>'
          nullable: true
        web_search_country_iso_code:
          type: string
          description: '<em>country code for web search localization</em><br>optional field<br>specify the country  ISO code to get localized web search results<br><strong>Note:</strong> available only for Perplexity Sonar models<br>example: <code>US</code>'
          nullable: true
        system_message:
          type: string
          description: '<em>instructions for the AI behavior</em><br>optional field<br>defines the AI''s role, tone, or specific behavior <br>you can specify <strong>up to 500 characters</strong> in the <code>system_message</code> field'
          nullable: true
        message_chain:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/LlmMessageChainItem'
            nullable: true
          description: "conversation history\noptional field\narray of message objects representing previous conversation turns;\neach object must contain:\nrole string with either user or ai role;\nmessage string with message content (max 500 characters);\nyou can specify maximum of 10 message objects in the array;\nNote: for Perplexity models, messages must strictly alternate between user and AI roles (user → ai);\nexample:\n\"message_chain\": [{\"role\":\"user\",\"message\":\"Hello, what’s up?\"},{\"role\":\"ai\",\"message\":\"Hello! I’m doing well, thank you. How can I assist you today?\"}]"
          nullable: true
        tag:
          type: string
          description: <em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response
          nullable: true
      example:
        - system_message: communicate as if we are in a business meeting
          message_chain:
            - role: user
              message: 'Hello, what’s up?'
            - role: ai
              message: 'Hello! I’m doing well, thank you. How can I assist you today? Are there any specific topics or projects you’d like to discuss in our meeting?'
          max_output_tokens: 200
          temperature: 0.3
          top_p: 0.5
          web_search_country_iso_code: FR
          model_name: sonar
          user_prompt: provide information on how relevant the amusement park business is in France now
    AiOptimizationPerplexityLlmResponsesLiveResultInfo:
      type: object
      properties:
        model_name:
          type: string
          description: <em>name of the AI model used</em>
          nullable: true
        input_tokens:
          type: integer
          description: <em>number of tokens in the input</em><br>total count of tokens processed
          nullable: true
        output_tokens:
          type: integer
          description: <em>number of tokens in the output</em><br>total count of tokens generated in the AI response
          nullable: true
        reasoning_tokens:
          type: integer
          nullable: true
        web_search:
          type: boolean
          description: <em>indicates if web search was used</em><br><strong>Note:</strong> web search is enabled by default in Perplexity Sonar models
          nullable: true
        money_spent:
          type: number
          description: '<em>cost of AI tokens, USD</em><br>the price charged by the third-party AI model provider for according to its <a href="https://docs.perplexity.ai/guides/pricing" target="_blank">Pricing</a>'
          nullable: true
        datetime:
          type: string
          description: '<em>date and time when the result was received</em><br>in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”<br>example:<br><code class="long-string">2019-11-15 12:57:46 +00:00</code>'
          nullable: true
        items:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/MessageAiOptimizationLlmResponseElementItem'
            nullable: true
          description: <em>array of response items</em><br>contains structured AI response data
          nullable: true
        fan_out_queries:
          type: object
          description: <em>array of fan-out queries</em><br>contains related search queries derived from the main query to provide a more comprehensive response
          nullable: true
    AiOptimizationPerplexityLlmResponsesLiveTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AiOptimizationPerplexityLlmResponsesLiveResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    AiOptimizationPerplexityLlmResponsesLiveResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AiOptimizationPerplexityLlmResponsesLiveTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    AiOptimizationGeminiLlmScraperLocationsResultInfo:
      type: object
      properties:
        location_code:
          type: integer
          description: <em>location code</em>
          nullable: true
        location_name:
          type: string
          description: <em>full name of the location</em>
          nullable: true
        location_code_parent:
          type: string
          description: '<em>the code of the superordinate location</em><br>example:<br><code>"location_code": 9041134,<br>"location_name": "Vienna International Airport,Lower Austria,Austria",<br>"location_code_parent": 20044</code><p>where <code>location_code_parent</code> corresponds to:<p><code>"location_code": 20044,<br>"location_name": "Lower Austria,Austria"</code>'
          nullable: true
        country_iso_code:
          type: string
          description: <em>ISO country code of the location</em>
          nullable: true
        location_type:
          type: string
          description: <em>location type</em>
          nullable: true
    AiOptimizationGeminiLlmScraperLocationsTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AiOptimizationGeminiLlmScraperLocationsResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    AiOptimizationGeminiLlmScraperLocationsResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AiOptimizationGeminiLlmScraperLocationsTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    AiOptimizationGeminiLlmScraperLanguagesResultInfo:
      type: object
      properties:
        language_name:
          type: string
          description: <em>language name</em>
          nullable: true
        language_code:
          type: string
          description: <em>language code according to <a href="https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes" target="_blank" rel="noopener noreferrer">ISO 639-1</a></em>
          nullable: true
    AiOptimizationGeminiLlmScraperLanguagesTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AiOptimizationGeminiLlmScraperLanguagesResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    AiOptimizationGeminiLlmScraperLanguagesResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AiOptimizationGeminiLlmScraperLanguagesTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    AiOptimizationGeminiLlmScraperTaskPostRequestInfo:
      type: object
      properties:
        keyword:
          type: string
          description: '<em>keyword</em><br><strong>required field</strong><br>you can specify <strong>up to 2000 characters</strong> in the <code>keyword</code> field<br>all %## will be decoded (plus character ‘+’ will be decoded to a space character)<br>if you need to use the “%” character for your <code>keyword</code>, please specify it as “%25”;<br>if you need to use the “+” character for your <code>keyword</code>, please specify it as “%2B”<p>learn more about rules and limitations of <code>keyword</code> and <code>keywords</code> fields in DataForSEO APIs in this <a href="https://dataforseo.com/help-center/rules-and-limitations-of-keyword-and-keywords-fields-in-dataforseo-apis" rel="noopener noreferrer" target="_blank">Help Center article</a>'
        priority:
          type: integer
          description: <em>task priority</em><br>optional field<br>can take the following values:<br>1 – normal execution priority (set by default)<br>2 – high execution priorityYou will be additionally charged for the tasks with high execution priority.<br>The cost can be calculated on the <a title="Pricing" href="https://dataforseo.com/pricing/ai-optimization/llm-scraper" target="_blank" rel="noopener noreferrer">Pricing</a> page.
          nullable: true
        location_name:
          type: string
          description: '<em>full name of search engine location</em><br><strong>required field if you don''t specify</strong> <code>location_code</code> or <code>location_coordinate</code><br><strong>if you use this field, you don''t need to specify <code>location_code</code> or <code>location_coordinate</code></strong><br>you can receive the list of available locations of the search engine with their <code>location_name</code> by making a separate request to the <code>https://api.dataforseo.com/v3/ai_optimization/gemini/llm_scraper/locations</code><br>example:<br><code class="long-string">United States</code>'
        location_code:
          type: integer
          description: '<em>search engine location code</em><br><strong>required field if you don''t specify</strong> <code>location_name</code> or <code>location_coordinate</code><br><strong>if you use this field, you don''t need to specify <code>location_name</code> or <code>location_coordinate</code></strong><br>you can receive the list of available locations of the search engines with their <code>location_code</code> by making a separate request to the <code>https://api.dataforseo.com/v3/ai_optimization/gemini/llm_scraper/locations</code><br>example:<br><code class="long-string">2840</code>'
        location_coordinate:
          type: string
          description: '<p><em>GPS coordinates of a location</em><p><strong>required field if you don''t specify</strong> <code>location_name</code>&nbsp;or <code>location_code</code><p><strong>if you use this field, you don''t need to specify <code>location_name</code> or <code>location_code</code></strong><p><code>location_coordinate</code> parameter should be specified in the <em>"latitude,longitude,radius"</em> format<p>the maximum number of decimal digits for <em>"latitude"</em> and <em>"longitude"</em>: 7<p>the minimum value for <em>"radius"</em>: 199 (mm)<p>the maximum value for <em>"radius"</em>: 199999 (mm)<p>example:<p><code class="long-string">53.476225,-2.243572,200</code></p>'
        language_name:
          type: string
          description: '<em>full name of search engine language</em><br>required field if you don''t specify <code>language_code</code>;<br>if you use this field, you don''t need to specify <code>language_code</code>;<br>you can receive the list of available languages of the search engine with their <code>language_name</code> by making a separate request to the <code>https://api.dataforseo.com/v3/ai_optimization/gemini/llm_scraper/languages</code><br>example:<br><code class="long-string">English</code>'
        language_code:
          type: string
          description: '<em>search engine language code</em><br>required field if you don''t specify <code>language_name</code>;<br>if you use this field, you don''t need to specify <code>language_name</code>;<br>you can receive the list of available languages of the search engine with their <code>language_code</code>_by making a separate request to the <code>https://api.dataforseo.com/v3/ai_optimization/gemini/llm_scraper/languages</code><br>example:<br><code class="long-string">en</code>'
        expand_citations:
          type: boolean
          description: '<em>return expanded citation bar in HTML results</em><br>optional field<br>when enabled, the HTML endpoint will return data from the expanded citation bar;<br>default value: <code>false</code>'
          nullable: true
        tag:
          type: string
          description: <em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response
          nullable: true
        postback_url:
          type: string
          description: '<em>URL for sending task results</em><br>optional field<br>once the task is completed, we will send a POST request with its results compressed in the <code>gzip</code> format to the <code>postback_url</code> you specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/postbackscript?id=$id</code><br><code>http://your-server.com/postbackscript?id=$id&amp;tag=$tag</code><br><strong>Note:</strong> special characters in <code>postback_url</code> will be urlencoded;<br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href="https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api" target="_blank" rel="noopener noreferrer">Help Center</a>'
          nullable: true
        postback_data:
          type: string
          description: '<em>postback_url datatype</em><br><strong>required field if you specify <code>postback_url</code></strong><br>corresponds to the function you used for setting a task<br>possible values:<br><code>advanced</code>, <code>html</code>'
        pingback_url:
          type: string
          description: '<em>notification URL of a completed task</em><br>optional field<br>when a task is completed we will notify you by GET request sent to the URL you have specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/pingscript?id=$id</code><br><code>http://your-server.com/pingscript?id=$id&amp;tag=$tag</code><br><strong>Note:</strong> special characters in <code>pingback_url</code> will be urlencoded;<br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href="https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api" target="_blank" rel="noopener noreferrer">Help Center</a>'
          nullable: true
      example:
        - language_code: en
          location_code: 2840
          keyword: albert einstein
    AiOptimizationGeminiLlmScraperTaskPostTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: object
              description: '<em>array of results</em><br>in this case, the value will be <code>null</code>'
              nullable: true
    AiOptimizationGeminiLlmScraperTaskPostResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AiOptimizationGeminiLlmScraperTaskPostTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    AiOptimizationGeminiLlmScraperTasksReadyResultInfo:
      type: object
      properties:
        id:
          type: string
          description: <em>task identifier of the completed task</em><br><strong>unique task identifier in our system in the <a href="https://en.wikipedia.org/wiki/Universally_unique_identifier">UUID</a> format</strong>
          nullable: true
        se:
          type: string
          description: <em>search engine specified when setting the task</em>
          nullable: true
        function:
          type: string
          description: '<em>search engine function</em><br>example: <code>llm_scraper</code>'
          nullable: true
        date_posted:
          type: string
          description: <em>date when the task was posted (in the UTC format)</em>
          nullable: true
        tag:
          type: string
          description: <em>user-defined task identifier</em>
          nullable: true
        endpoint_advanced:
          type: string
          description: '<em>URL for collecting the results of the Advanced task</em><br>if the Advanced function is not supported in the specified endpoint, the value will be <code>null</code>'
          nullable: true
        endpoint_html:
          type: string
          description: '<em>URL for collecting the results of the HTML task</em><br>if the HTML function is not supported in the specified endpoint, the value will be <code>null</code>'
          nullable: true
    AiOptimizationGeminiLlmScraperTasksReadyTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AiOptimizationGeminiLlmScraperTasksReadyResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    AiOptimizationGeminiLlmScraperTasksReadyResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AiOptimizationGeminiLlmScraperTasksReadyTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    GeminiTextElementItem:
      type: object
      allOf:
        - type: object
          oneOf:
            - $ref: '#/components/schemas/BaseGeminiLlmScraperElementItem'
          nullable: true
        - type: object
          properties:
            original_text:
              type: string
              description: <em>unformatted text content of the element</em>
              nullable: true
            sources:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/SourceInfo'
                nullable: true
              description: <em>array of sources</em>
              nullable: true
    GeminiTableElementItem:
      type: object
      allOf:
        - type: object
          oneOf:
            - $ref: '#/components/schemas/BaseGeminiLlmScraperElementItem'
          nullable: true
        - type: object
          properties:
            original_text:
              type: string
              description: <em>unformatted text content of the element</em>
              nullable: true
            table:
              type: object
              oneOf:
                - $ref: '#/components/schemas/Table'
              description: <em>table present in the element</em><br>the header and content of the table present in the element
              nullable: true
    GeminiImagesElementItem:
      type: object
      allOf:
        - type: object
          oneOf:
            - $ref: '#/components/schemas/BaseGeminiLlmScraperElementItem'
          nullable: true
        - type: object
          properties:
            items:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/GeminiImagesElement'
                nullable: true
              description: <em>elements of Gemini results</em>
              nullable: true
    AiOptimizationGeminiLlmScraperTaskGetAdvancedResultInfo:
      type: object
      properties:
        keyword:
          type: string
          description: <em>keyword received in a POST array<br></em><strong>the keyword is returned with decoded %## (plus symbol '+' will be decoded to a space character)</strong>
          nullable: true
        location_code:
          type: integer
          description: <em>location code in a POST array</em>
          nullable: true
        language_code:
          type: string
          description: <em>language code in a POST array</em>
          nullable: true
        model:
          type: string
          description: <em>indicates the model version</em>
          nullable: true
        datetime:
          type: string
          description: '<em>date and time when the result was received</em><br>in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”<br>example:<br><code class="long-string">2019-11-15 12:57:46 +00:00</code>'
          nullable: true
        markdown:
          type: string
          description: <em>content of the element in markdown format</em><br>content of the result formatted in the <a href="https://en.wikipedia.org/wiki/Markdown" target="_blank">markdown markup language</a>
          nullable: true
        sources:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/SourceInfo'
            nullable: true
          description: <em>array of sources</em><br>the sources the model actually cited or relied on in its final answer
          nullable: true
        se_results_count:
          type: integer
          description: <em> total number of results</em>
          format: int64
          nullable: true
        item_types:
          type: array
          items:
            type: string
            nullable: true
          description: '<em>types of search results</em><br>contains types of search results (<code>items</code>) found in SERP.<br>possible item types:<br><code>gemini_text</code>, <code>gemini_table</code>, <code>gemini_images</code>'
          nullable: true
        items_count:
          type: integer
          description: <em>the number of results returned in the <strong><code>items</code></strong> array</em>
          format: int64
          nullable: true
        items:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/BaseGeminiLlmScraperElementItem'
            nullable: true
          description: <em>items present in the element</em>
          nullable: true
    AiOptimizationGeminiLlmScraperTaskGetAdvancedTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AiOptimizationGeminiLlmScraperTaskGetAdvancedResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    AiOptimizationGeminiLlmScraperTaskGetAdvancedResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AiOptimizationGeminiLlmScraperTaskGetAdvancedTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    AiOptimizationGeminiLlmScraperTaskGetHtmlResultInfo:
      type: object
      properties:
        keyword:
          type: string
          description: <em>keyword received in a POST array<br></em><strong>keyword is returned with decoded %## (plus symbol '+' will be decoded to a space character)</strong>
          nullable: true
        location_code:
          type: integer
          description: <em>location code in a POST array</em>
          nullable: true
        language_code:
          type: string
          description: <em>language code in a POST array</em>
          nullable: true
        datetime:
          type: string
          description: '<em>date and time when the result was received</em><br>in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”<br>example:<br><code class="long-string">2019-11-15 12:57:46 +00:00</code>'
          nullable: true
        items_count:
          type: integer
          description: <em>the number of results returned in the <strong><code>items</code></strong> array</em>
          format: int64
          nullable: true
        items:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/HtmlItemInfo'
            nullable: true
          description: <em>elements of search results found</em>
          nullable: true
    AiOptimizationGeminiLlmScraperTaskGetHtmlTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AiOptimizationGeminiLlmScraperTaskGetHtmlResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    AiOptimizationGeminiLlmScraperTaskGetHtmlResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AiOptimizationGeminiLlmScraperTaskGetHtmlTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    AiOptimizationGeminiLlmScraperLiveAdvancedRequestInfo:
      type: object
      properties:
        keyword:
          type: string
          description: '<em>keyword</em><br><strong>required field</strong><br>you can specify <strong>up to 2000 characters</strong> in the <code>keyword</code> field<br>all %## will be decoded (plus character ‘+’ will be decoded to a space character)<br>if you need to use the “%” character for your <code>keyword</code>, please specify it as “%25”;<br>if you need to use the “+” character for your <code>keyword</code>, please specify it as “%2B”<p>learn more about rules and limitations of <code>keyword</code> and <code>keywords</code> fields in DataForSEO APIs in this <a href="https://dataforseo.com/help-center/rules-and-limitations-of-keyword-and-keywords-fields-in-dataforseo-apis" rel="noopener noreferrer" target="_blank">Help Center article</a>'
        location_name:
          type: string
          description: '<em>full name of search engine location</em><br><strong>required field if you don''t specify</strong> <code>location_code</code> or <code>location_coordinate</code><br><strong>if you use this field, you don''t need to specify <code>location_code</code> or <code>location_coordinate</code></strong><br>you can receive the list of available locations of the search engine with their <code>location_name</code> by making a separate request to the <code>https://api.dataforseo.com/v3/ai_optimization/gemini/llm_scraper/locations</code><br>example:<br><code class="long-string">United States</code>'
        location_code:
          type: integer
          description: '<em>search engine location code</em><br><strong>required field if you don''t specify</strong> <code>location_name</code> or <code>location_coordinate</code><br><strong>if you use this field, you don''t need to specify <code>location_name</code> or <code>location_coordinate</code></strong><br>you can receive the list of available locations of the search engines with their <code>location_code</code> by making a separate request to the <code>https://api.dataforseo.com/v3/ai_optimization/gemini/llm_scraper/locations</code><br>example:<br><code class="long-string">2840</code>'
        location_coordinate:
          type: string
          description: '<p><em>GPS coordinates of a location</em><p><strong>required field if you don''t specify</strong> <code>location_name</code>&nbsp;or <code>location_code</code><p><strong>if you use this field, you don''t need to specify <code>location_name</code> or <code>location_code</code></strong><p><code>location_coordinate</code> parameter should be specified in the <em>"latitude,longitude,radius"</em> format<p>the maximum number of decimal digits for <em>"latitude"</em> and <em>"longitude"</em>: 7<p>the minimum value for <em>"radius"</em>: 199 (mm)<p>the maximum value for <em>"radius"</em>: 199999 (mm)<p>example:<p><code class="long-string">53.476225,-2.243572,200</code></p>'
        language_name:
          type: string
          description: '<em>full name of search engine language</em><br>required field if you don''t specify <code>language_code</code>;<br>if you use this field, you don''t need to specify <code>language_code</code>;<br>you can receive the list of available languages of the search engine with their <code>language_name</code> by making a separate request to the <code>https://api.dataforseo.com/v3/ai_optimization/gemini/llm_scraper/languages</code><br>example: <code>English</code>'
        language_code:
          type: string
          description: '<em>search engine language code</em><br>required field if you don''t specify <code>language_name</code>;<br>if you use this field, you don''t need to specify <code>language_name</code>;<br>you can receive the list of available languages of the search engine with their <code>language_code</code>_by making a separate request to the <code>https://api.dataforseo.com/v3/ai_optimization/gemini/llm_scraper/languages</code><br>example: <code>en</code>n'
        tag:
          type: string
          description: <em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response
          nullable: true
      example:
        - language_code: en
          location_code: 2840
          keyword: albert einstein
    AiOptimizationGeminiLlmScraperLiveAdvancedResultInfo:
      type: object
      properties:
        keyword:
          type: string
          description: <em>keyword received in a POST array<br></em><strong>the keyword is returned with decoded %## (plus symbol '+' will be decoded to a space character)</strong>
          nullable: true
        location_code:
          type: integer
          description: <em>location code in a POST array</em>
          nullable: true
        language_code:
          type: string
          description: <em>language code in a POST array</em>
          nullable: true
        model:
          type: string
          description: <em>indicates the model version</em>
          nullable: true
        datetime:
          type: string
          description: '<em>date and time when the result was received</em><br>in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”<br>example:<br><code class="long-string">2019-11-15 12:57:46 +00:00</code>'
          nullable: true
        markdown:
          type: string
          description: <em>content of the element in markdown format</em><br>content of the result formatted in the <a href="https://en.wikipedia.org/wiki/Markdown" target="_blank">markdown markup language</a>
          nullable: true
        sources:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/SourceInfo'
            nullable: true
          description: <em>array of sources</em><br>the sources the model actually cited or relied on in its final answer
          nullable: true
        se_results_count:
          type: integer
          description: <em> total number of results</em>
          format: int64
          nullable: true
        item_types:
          type: array
          items:
            type: string
            nullable: true
          description: '<em>types of search results</em><br>contains types of search results (<code>items</code>) found in SERP.<br>possible item types:<br><code>gemini_text</code>, <code>gemini_table</code>, <code>gemini_images</code>'
          nullable: true
        items_count:
          type: integer
          description: <em>the number of results returned in the <strong><code>items</code></strong> array</em>
          format: int64
          nullable: true
        items:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/BaseGeminiLlmScraperElementItem'
            nullable: true
          description: <em>elements of Gemini results</em>
          nullable: true
    AiOptimizationGeminiLlmScraperLiveAdvancedTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AiOptimizationGeminiLlmScraperLiveAdvancedResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    AiOptimizationGeminiLlmScraperLiveAdvancedResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AiOptimizationGeminiLlmScraperLiveAdvancedTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    AiOptimizationGeminiLlmScraperLiveHtmlRequestInfo:
      type: object
      properties:
        keyword:
          type: string
          description: '<em>keyword</em><br><strong>required field</strong><br>you can specify <strong>up to 2000 characters</strong> in the <code>keyword</code> field<br>all %## will be decoded (plus character ‘+’ will be decoded to a space character)<br>if you need to use the “%” character for your <code>keyword</code>, please specify it as “%25”;<br>if you need to use the “+” character for your <code>keyword</code>, please specify it as “%2B”<p>learn more about rules and limitations of <code>keyword</code> and <code>keywords</code> fields in DataForSEO APIs in this <a href="https://dataforseo.com/help-center/rules-and-limitations-of-keyword-and-keywords-fields-in-dataforseo-apis" rel="noopener noreferrer" target="_blank">Help Center article</a>'
        location_name:
          type: string
          description: '<em>full name of search engine location</em><br><strong>required field if you don''t specify</strong> <code>location_code</code> or <code>location_coordinate</code><br><strong>if you use this field, you don''t need to specify <code>location_code</code> or <code>location_coordinate</code></strong><br>you can receive the list of available locations of the search engine with their <code>location_name</code> by making a separate request to the <code>https://api.dataforseo.com/v3/ai_optimization/gemini/llm_scraper/locations</code><br>example:<br><code class="long-string">United States</code>'
        location_code:
          type: integer
          description: '<em>search engine location code</em><br><strong>required field if you don''t specify</strong> <code>location_name</code> or <code>location_coordinate</code><br><strong>if you use this field, you don''t need to specify <code>location_name</code> or <code>location_coordinate</code></strong><br>you can receive the list of available locations of the search engines with their <code>location_code</code> by making a separate request to the <code>https://api.dataforseo.com/v3/ai_optimization/gemini/llm_scraper/locations</code><br>example:<br><code class="long-string">2840</code>'
        location_coordinate:
          type: string
          description: '<p><em>GPS coordinates of a location</em><p><strong>required field if you don''t specify</strong> <code>location_name</code>&nbsp;or <code>location_code</code><p><strong>if you use this field, you don''t need to specify <code>location_name</code> or <code>location_code</code></strong><p><code>location_coordinate</code> parameter should be specified in the <em>"latitude,longitude,radius"</em> format<p>the maximum number of decimal digits for <em>"latitude"</em> and <em>"longitude"</em>: 7<p>the minimum value for <em>"radius"</em>: 199 (mm)<p>the maximum value for <em>"radius"</em>: 199999 (mm)<p>example:<p><code class="long-string">53.476225,-2.243572,200</code></p>'
        language_name:
          type: string
          description: '<em>full name of search engine language</em><br><strong>required field if you don''t specify</strong> <code>language_code</code><br><strong>if you use this field, you don''t need to specify <code>language_code</code></strong><br>you can receive the list of available languages of the search engine with their <code>language_name</code> by making a separate request to the <code>https://api.dataforseo.com/v3/ai_optimization/gemini/llm_scraper/languages</code><br>example:<br><code class="long-string">English</code>'
        language_code:
          type: string
          description: '<em>search engine language code</em><br><strong>required field if you don''t specify</strong> <code>language_name</code><br><strong>if you use this field, you don''t need to specify <code>language_name</code></strong><br>you can receive the list of available languages of the search engine with their <code>language_code</code>_by making a separate request to the <code>https://api.dataforseo.com/v3/ai_optimization/gemini/llm_scraper/languages</code><br>example:<code class="long-string">en</code>n'
        expand_citations:
          type: boolean
          description: '<em>return expanded citation bar in HTML results</em><br>optional field<br>when enabled, the endpoint will return HTML data from the expanded citation bar;<br>default value: <code>false</code>'
          nullable: true
        tag:
          type: string
          description: <em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response
          nullable: true
      example:
        - language_code: en
          location_code: 2840
          keyword: albert einstein
    AiOptimizationGeminiLlmScraperLiveHtmlResultInfo:
      type: object
      properties:
        keyword:
          type: string
          description: <em>keyword received in a POST array<br></em><strong>keyword is returned with decoded %## (plus character '+' will be decoded to a space character)</strong>
          nullable: true
        location_code:
          type: integer
          description: <em>location code in a POST array</em>
          nullable: true
        language_code:
          type: string
          description: <em>language code in a POST array</em>
          nullable: true
        datetime:
          type: string
          description: '<em>date and time when the result was received</em><br>in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”<br>example:<br><code class="long-string">2019-11-15 12:57:46 +00:00</code>'
          nullable: true
        items_count:
          type: integer
          description: <em>the number of results returned in the <strong><code>items</code></strong> array</em>
          format: int64
          nullable: true
        items:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/HtmlItemInfo'
            nullable: true
          description: <em>elements of search results found</em>
          nullable: true
    AiOptimizationGeminiLlmScraperLiveHtmlTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AiOptimizationGeminiLlmScraperLiveHtmlResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    AiOptimizationGeminiLlmScraperLiveHtmlResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AiOptimizationGeminiLlmScraperLiveHtmlTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    AiOptimizationAiKeywordDataAvailableFiltersResultInfo:
      type: object
      properties:
        popular_questions:
          type: object
          additionalProperties:
            type: string
            nullable: true
          nullable: true
    AiOptimizationAiKeywordDataAvailableFiltersTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AiOptimizationAiKeywordDataAvailableFiltersResultInfo'
                nullable: true
              nullable: true
    AiOptimizationAiKeywordDataAvailableFiltersResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AiOptimizationAiKeywordDataAvailableFiltersTaskInfo'
                nullable: true
              nullable: true
    AiOptimizationAiKeywordDataLocationsAndLanguagesResultInfo:
      type: object
      properties:
        location_code:
          type: integer
          description: <em>location code</em>
          nullable: true
        location_name:
          type: string
          description: <em>full name of the location</em>
          nullable: true
        available_languages:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/AvailableLanguages'
            nullable: true
          description: <em>supported languages</em><br>contains the languages which are supported for a specific location
          nullable: true
    AiOptimizationAiKeywordDataLocationsAndLanguagesTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AiOptimizationAiKeywordDataLocationsAndLanguagesResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    AiOptimizationAiKeywordDataLocationsAndLanguagesResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AiOptimizationAiKeywordDataLocationsAndLanguagesTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    AiOptimizationAiKeywordDataKeywordsSearchVolumeLiveRequestInfo:
      type: object
      properties:
        keywords:
          type: array
          items:
            type: string
          description: '<em>keywords</em><br><strong>required field</strong><br>UTF-8 encoding<br>The maximum number of keywords you can specify: 1000;<br>The maximum number of characters in a single keyword: 250;<br>The keywords will be converted to lowercase format;<p>learn more about rules and limitations of <code>keyword</code> and <code>keywords</code> fields in DataForSEO APIs in this <a href="https://dataforseo.com/help-center/rules-and-limitations-of-keyword-and-keywords-fields-in-dataforseo-apis" rel="noopener noreferrer" target="_blank">Help Center article</a>'
        location_name:
          type: string
          description: <em>full name of the location</em><br><strong>required field if you don't specify</strong> <code>location_code</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_name</code> by making a separate request to the<br><code>https://api.dataforseo.com/v3/ai_optimization/ai_keyword_data/locations_and_languages</code><br>example:<br><code class="long-string">United Kingdom</code>
        location_code:
          type: integer
          description: <em>unique location identifier</em><br><strong>required field if you don't specify</strong> <code>location_name</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_code</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/ai_optimization/ai_keyword_data/locations_and_languages</code><br>example:<br><code class="long-string">2840</code>
        language_name:
          type: string
          description: '<em>full name of the language</em><br><strong>required field if you don''t specify</strong> <code>language_code</code><br><strong>if you use this field, you don''t need to specify</strong> <code>language_code</code><br>you can receive the list of available languages with their <code>language_name</code> by making a separate request to the<br><code>https://api.dataforseo.com/v3/ai_optimization/ai_keyword_data/locations_and_languages</code><br>example:<br><code class="long-string">English</code>'
        language_code:
          type: string
          description: '<em>language code</em><br><strong>required field if you don''t specify</strong> <code>language_name</code><br><strong>if you use this field, you don''t need to specify</strong> <code>language_name</code><br>you can receive the list of available languages with their <code>language_code</code> by making a separate request to the<br><code>https://api.dataforseo.com/v3/ai_optimization/ai_keyword_data/locations_and_languages</code><br>example:<br><code class="long-string">en</code>'
        tag:
          type: string
          description: <em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response
          nullable: true
      example:
        - language_name: English
          location_code: 2840
          keywords:
            - iphone
            - seo
    AiMonthlySearches:
      type: object
      properties:
        year:
          type: integer
          description: <em>year</em>
          nullable: true
        month:
          type: integer
          description: <em>month</em>
          nullable: true
        ai_search_volume:
          type: integer
          description: <em>current AI search volume rate of a keyword</em><br>learn more about this metric <a href="https://dataforseo.com/help-center/what-is-ai-search-volume-in-dataforseo" rel="noopener noreferrer" target="_blank">here</a>
          format: int64
          nullable: true
    AiOptimizationAiKeywordDataKeywordsSearchVolumeLiveItem:
      type: object
      properties:
        keyword:
          type: string
          description: <em>specified keyword</em>
          nullable: true
        ai_search_volume:
          type: integer
          description: <em>current AI search volume rate of a keyword</em><br>learn more about this metric <a href="https://dataforseo.com/help-center/what-is-ai-search-volume-in-dataforseo" rel="noopener noreferrer" target="_blank">here</a>
          format: int64
          nullable: true
        ai_monthly_searches:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/AiMonthlySearches'
            nullable: true
          description: <em>monthly AI search volume rates</em><br>array of objects with AI search volume rates in a certain month of a year
          nullable: true
    AiOptimizationAiKeywordDataKeywordsSearchVolumeLiveResultInfo:
      type: object
      properties:
        location_code:
          type: integer
          description: <em>location code in a POST array</em>
          nullable: true
        language_code:
          type: string
          description: <em>language code in a POST array</em>
          nullable: true
        items_count:
          type: integer
          description: <em>number of results returned in the <code>items</code> array</em>
          format: int64
          nullable: true
        items:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/AiOptimizationAiKeywordDataKeywordsSearchVolumeLiveItem'
            nullable: true
          description: <em>contains specified keywords with their AI search volume rates</em>
          nullable: true
    AiOptimizationAiKeywordDataKeywordsSearchVolumeLiveTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AiOptimizationAiKeywordDataKeywordsSearchVolumeLiveResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    AiOptimizationAiKeywordDataKeywordsSearchVolumeLiveResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AiOptimizationAiKeywordDataKeywordsSearchVolumeLiveTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    AiOptimizationLlmMentionsAvailableFiltersResultInfo:
      type: object
      properties:
        search:
          type: object
          additionalProperties:
            type: string
            nullable: true
          nullable: true
        search_mentions:
          type: object
          additionalProperties:
            type: string
            nullable: true
          nullable: true
        target_metrics:
          type: object
          additionalProperties:
            type: string
            nullable: true
          nullable: true
        multi_target_metrics:
          type: object
          additionalProperties:
            type: string
            nullable: true
          nullable: true
        top_mentioned_domains:
          type: object
          additionalProperties:
            type: string
            nullable: true
          nullable: true
        top_mentioned_pages:
          type: object
          additionalProperties:
            type: string
            nullable: true
          nullable: true
        top_mentioned_brands:
          type: object
          additionalProperties:
            type: string
            nullable: true
          nullable: true
        top_mentioned_brand_categories:
          type: object
          additionalProperties:
            type: string
            nullable: true
          nullable: true
        target_metrics_lite:
          type: object
          additionalProperties:
            type: string
            nullable: true
          nullable: true
        top_mentioned_domains_lite:
          type: object
          additionalProperties:
            type: string
            nullable: true
          nullable: true
        top_mentioned_pages_lite:
          type: object
          additionalProperties:
            type: string
            nullable: true
          nullable: true
        top_mentioned_brands_lite:
          type: object
          additionalProperties:
            type: string
            nullable: true
          nullable: true
        top_mentioned_brand_categories_lite:
          type: object
          additionalProperties:
            type: string
            nullable: true
          nullable: true
    AiOptimizationLlmMentionsAvailableFiltersTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AiOptimizationLlmMentionsAvailableFiltersResultInfo'
                nullable: true
              nullable: true
    AiOptimizationLlmMentionsAvailableFiltersResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AiOptimizationLlmMentionsAvailableFiltersTaskInfo'
                nullable: true
              nullable: true
    ResultAvailableLanguages:
      type: object
      properties:
        available_platforms:
          type: array
          items:
            type: string
            nullable: true
          description: <em>supported LLM platforms</em><br>contains the sources of data supported for a specific location and language combination<br>only <code>google</code> and <code>chat_gpt</code> are currently available
          nullable: true
        language_name:
          type: string
          description: <em>language name</em>
          nullable: true
        language_code:
          type: string
          description: <em>language code according to <a href="https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes" target="_blank" rel="noopener noreferrer">ISO 639-1</a></em>
          nullable: true
        responses_count:
          type: integer
          description: <em>number of LLM responses</em><br>the number of LLM responses available in the database for the certain location and language parameters
          format: int64
          nullable: true
    AiOptimizationLlmMentionsLocationsAndLanguagesResultInfo:
      type: object
      properties:
        location_code:
          type: integer
          description: <em>location code</em>
          nullable: true
        location_name:
          type: string
          description: <em>full name of the location</em>
          nullable: true
        available_languages:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/ResultAvailableLanguages'
            nullable: true
          description: <em>supported languages</em><br>contains the languages which are supported for a specific location
          nullable: true
    AiOptimizationLlmMentionsLocationsAndLanguagesTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AiOptimizationLlmMentionsLocationsAndLanguagesResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    AiOptimizationLlmMentionsLocationsAndLanguagesResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AiOptimizationLlmMentionsLocationsAndLanguagesTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    AiOptimizationLlmMentionsSearchMentionsLiveRequestInfo:
      type: object
      properties:
        target:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/BaseAiOptimizationLLmMentionsTargetElement'
            nullable: true
          description: "array of objects containing target entities\nrequired field\nyou can specify up to 10 entities (objects) in the target field\none target entity can contain either one domain or one keyword and related parameters\nexamples:\n\ntarget array with a domain entity"
          nullable: true
        location_name:
          type: string
          description: '<em>full name of search location</em><br>optional field<br>if you use this field, you don''t need to specify <code>location_code</code><br>if you don''t specify this field, the <code>location_code</code> with <code class="long-string">2840</code> value will be used by default;<br>you can receive the list of available locations of the search engine with their <code>location_name</code> by making a separate request to the <code>https://api.dataforseo.com/v3/ai_optimization/llm_mentions/locations_and_languages</code><br><strong>Note: <code>chat_gpt</code> data is available for <code class="long-string">United States</code> only'
          nullable: true
        location_code:
          type: integer
          description: '<em>search location code</em><br>optional field<br>if you use this field, you don''t need to specify <code>location_name</code><br>you can receive the list of available locations of the search engine with their <code>location_code</code> by making a separate request to the <code>https://api.dataforseo.com/v3/ai_optimization/llm_mentions/locations_and_languages</code><br>default value: <code class="long-string">2840</code><br><strong>Note: <code>chat_gpt</code> data is available for <code class="long-string">2840</code> only'
          nullable: true
        language_name:
          type: string
          description: '<em>full name of search language</em><br>optional field<br>if you use this field, you don''t need to specify <code>language_code</code>;<br>if you don''t specify this field, the <code>language_code</code> with <code class="long-string">en</code> value will be used by default;<br>you can receive the list of available languages of the search engine with their <code>language_name</code> by making a separate request to the <code>https://api.dataforseo.com/v3/ai_optimization/llm_mentions/locations_and_languages</code><br><strong>Note: <code>chat_gpt</code> data is available for <code class="long-string">English</code> only'
          nullable: true
        language_code:
          type: string
          description: '<em>search language code</em><br>optional field<br>if you use this field, you don''t need to specify <code>language_name</code>;<br>you can receive the list of available languages of the search engine with their <code>language_code</code> by making a separate request to the <code>https://api.dataforseo.com/v3/ai_optimization/llm_mentions/locations_and_languages</code><br>default value: <code class="long-string">en</code><br><strong>Note: <code>chat_gpt</code> data is available for <code class="long-string">en</code> only'
          nullable: true
        platform:
          type: string
          description: '<em>target platform</em><br>optional field<br>possible values:<br><code>chat_gpt</code>, <code>google</code><br><strong>Note:</strong> if the <code>platform</code> is not specified, the data is returned for both platforms<br><strong>Note #2:</strong><code>chat_gpt</code> data is available for the <code>United States</code> and <code>English</code> only'
          nullable: true
        filters:
          type: array
          items:
            type: object
            nullable: true
          description: '<em>array of results filtering parameters</em><br>optional field<br><strong>you can add several filters at once (8 filters maximum)</strong><br>you should set a logical operator <code>and</code>, <code>or</code> between the conditions<br>the following operators are supported:<br><code>=</code>, <code>&lt;&gt;</code>, <code>in</code>, <code>not_in</code>, <code>like</code>, <code>not_like</code>, <code>ilike</code>, <code>not_ilike</code>, <code>match</code>, <code>not_match</code><br>you can use the <code>%</code> operator with <code>like</code> and <code>not_like</code> to match any string of zero or more characters<br>example:<br><code>["ai_search_volume","&gt;",1000]</code><p>The full list of possible filters is available <a href="/v3/ai_optimization/llm_mentions/filters/" rel="noopener noreferrer" target="_blank">here.</a>'
          nullable: true
        order_by:
          type: array
          items:
            type: string
          description: '<em>results sorting rules</em><br>optional field<br>you can use the same values as in the <code>filters</code> array to sort the results<br>possible sorting types:<br><code>asc</code> - results will be sorted in the ascending order<br><code>desc</code> - results will be sorted in the descending order<br>you should use a comma to set up a sorting type<br>example:<br><code>["ai_search_volume,desc"]</code><br><strong>Note:</strong> you can set no more than three sorting rules in a single request<br>you should use a comma to separate several sorting rules'
          nullable: true
        offset:
          type: integer
          description: '<em>offset in the results array of the returned mentions data</em><br>optional field<p>default value: <code>0</code><br>example: if you specify the <code>10</code> value, the first ten mentions objects in the results array will be omitted and the data will be provided for the successive objects;<br><strong>Note:</strong> the maximum value is <code>1000000</code>, use the <code>search_after_token</code> if you would like to offset more results'
          nullable: true
        search_after_token:
          type: string
          description: '<em>token for subsequent requests</em><br>optional field<br>provided in the identical filed of the response to each request;<br>use this parameter to avoid timeouts while trying to obtain over <code>1000</code> results in a single request;<br>by specifying the unique <code>search_after_token</code> value from the response array, you will get the subsequent results of the initial task;<br><code>search_after_token</code> values are unique for each subsequent task ;<br><strong>Note:</strong> if the <code>search_after_token</code> is specified in the request, all other parameters should be identical to the previous request'
          nullable: true
        limit:
          type: integer
          description: '<em>the maximum number of returned objects</em><br>optional field<p>default value: <code>100</code><br>maximum value: <code>1000</code>'
          nullable: true
        tag:
          type: string
          description: <em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response
          nullable: true
      example:
        - language_name: English
          location_code: 2840
          target:
            - domain: dataforseo.com
              search_filter: exclude
            - keyword: bmw
              search_scope:
                - answer
          platform: google
          filters:
            - 
              - ai_search_volume
              - '>'
              - 1000
          order_by:
            - 'ai_search_volume,desc'
          offset: 0
          limit: 3
    Sources:
      type: object
      properties:
        snippet:
          type: string
          description: <em>source description</em>
          nullable: true
        source_name:
          type: string
          description: <em>source name</em>
          nullable: true
        thumbnail:
          type: string
          description: <em>source thumbnail</em>
          nullable: true
        markdown:
          type: string
          description: <em>content of the element in markdown format</em><br>content of the result formatted in the <a href="https://en.wikipedia.org/wiki/Markdown" target="_blank">markdown markup language</a>
          nullable: true
        rank:
          type: integer
          description: <em>rank in the results</em>
          nullable: true
        title:
          type: string
          description: <em>source title</em>
          nullable: true
        domain:
          type: string
          description: <em>source domain</em>
          nullable: true
        url:
          type: string
          description: <em>source URL</em>
          nullable: true
        publication_date:
          type: string
          description: '<em>date and time when the result was published</em><br>in the format: “year-month-date:minutes:UTC_difference_hours:UTC_difference_minutes”<br>example:<br><code class="long-string">2019-11-15 12:57:46 +00:00</code>'
          nullable: true
    SearchResults:
      type: object
      properties:
        description:
          type: string
          description: <em>result description</em>
          nullable: true
        breadcrumb:
          type: string
          description: <em>breadcrumb</em>
          nullable: true
        rank:
          type: integer
          description: <em>rank in the results</em>
          nullable: true
        title:
          type: string
          description: <em>source title</em>
          nullable: true
        domain:
          type: string
          description: <em>source domain</em>
          nullable: true
        url:
          type: string
          description: <em>source URL</em>
          nullable: true
        publication_date:
          type: string
          description: '<em>date and time when the result was published</em><br>in the format: “year-month-date:minutes:UTC_difference_hours:UTC_difference_minutes”<br>example:<br><code class="long-string">2019-11-15 12:57:46 +00:00</code>'
          nullable: true
    BrandEntities:
      type: object
      properties:
        rank:
          type: integer
          description: <em>rank in the results</em>
          nullable: true
        title:
          type: string
          description: <em>source title</em>
          nullable: true
        category:
          type: string
          description: <em>category of the brand</em>
          nullable: true
    AiOptimizationLlmMentionsSearchMentionsLiveItem:
      type: object
      properties:
        platform:
          type: string
          description: <em>platform received in a POST array</em>
          nullable: true
        model_name:
          type: string
          description: '<em>name of the AI model from which the data was retrieved</em><br><strong>Note:</strong> for the <code>google</code> platform type, the value is always <code>google_ai_overview</code>'
          nullable: true
        location_code:
          type: integer
          description: <em>location code in a POST array</em>
          nullable: true
        language_code:
          type: string
          description: <em>language code in a POST array</em>
          nullable: true
        question:
          type: string
          description: <em>relevant question</em>
          nullable: true
        answer:
          type: string
          description: <em>relevant answer in markdown format</em><br>content of the result formatted in the <a href="https://en.wikipedia.org/wiki/Markdown" target="_blank">markdown markup language</a>
          nullable: true
        sources:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/Sources'
            nullable: true
          description: <em>array of sources</em><br>the sources the model cited or relied on in its final answer<br>learn more about the sources and how to retrieve LLM citation data at our <a href="https://dataforseo.com/help-center/how-to-get-llm-citation-data-with-llm-mentions-api" target="_blank">Help Center</a>
          nullable: true
        search_results:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/SearchResults'
            nullable: true
          description: '<em>array of search results</em><br>all web search outputs the model retrieved when looking up information, including duplicates and unused entries<br><strong>Note:</strong> available only for <code>chat_gpt</code>'
          nullable: true
        ai_search_volume:
          type: integer
          description: <em>current AI search volume rate of a keyword</em><br>learn more about this metric <a href="https://dataforseo.com/help-center/how-the-ai-search-volume-metric-works-in-llm-mentions" rel="noopener noreferrer" target="_blank">here</a>
          format: int64
          nullable: true
        monthly_searches:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/MonthlySearchesInfo'
            nullable: true
          description: <em>monthly AI search volume rates</em><br>array of objects with AI search volume rates in a certain month of a year
          nullable: true
        first_response_at:
          type: string
          description: '<em>date and time when the response data was first recorded</em><br>in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”<br>example:<br><code>2025-10-21 06:25:30 +00:00</code>'
          nullable: true
        last_response_at:
          type: string
          description: '<em>date and time when the response data was last updated</em><br>in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”<br>example:<br><code>2025-10-21 06:25:30 +00:00</code>'
          nullable: true
        brand_entities:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/BrandEntities'
            nullable: true
          description: <em>array of brand entities</em><br>contains information on brands mentioned in the response<br><strong>Note:</strong> available only for <code>chat_gpt</code>
          nullable: true
        fan_out_queries:
          type: array
          items:
            type: string
            nullable: true
          description: <em>array of fan-out queries</em><br>contains related search queries derived from the main query to provide a more comprehensive response<br><strong>Note:</strong> available only for <code>chat_gpt</code>
          nullable: true
        is_web_search_based:
          type: boolean
          description: '<em>indicates whether the response was generated using web search results</em><br>if <code>true</code>, the model retrieved live web search results to produce the response<br>if <code>false</code>, the response was generated from the model''s internal knowledge'
          nullable: true
    AiOptimizationLlmMentionsSearchMentionsLiveResultInfo:
      type: object
      properties:
        total_count:
          type: integer
          description: <em>total amount of results relevant the request</em>
          format: int64
          nullable: true
        offset:
          type: integer
          nullable: true
        search_after_token:
          type: string
          description: '<em>token for subsequent requests</em><br>by specifying the unique <code>search_after_token</code> when setting a new task, you will get the subsequent results of the initial task;<br><code>search_after_token</code> values are unique for each subsequent task'
          nullable: true
        items_count:
          type: integer
          description: <em>the number of results returned in the <code>items</code> array</em>
          format: int64
          nullable: true
        items:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/AiOptimizationLlmMentionsSearchMentionsLiveItem'
            nullable: true
          description: <em>contains relevant mentions data</em>
          nullable: true
    AiOptimizationLlmMentionsSearchMentionsLiveTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AiOptimizationLlmMentionsSearchMentionsLiveResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    AiOptimizationLlmMentionsSearchMentionsLiveResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AiOptimizationLlmMentionsSearchMentionsLiveTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    AiOptimizationLlmMentionsTargetMetricsLiveRequestInfo:
      type: object
      properties:
        target:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/BaseAiOptimizationLLmMentionsTargetElement'
            nullable: true
          description: "array of objects containing target entities\nrequired field\nyou can specify up to 10 entities (objects) in the target field\none target entity can contain either one domain or one keyword and related parameters\nexamples:\n\ntarget array with a domain entity"
          nullable: true
        location_name:
          type: string
          description: '<em>full name of search location</em><br>optional field<br>if you use this field, you don''t need to specify <code>location_code</code><br>if you don''t specify this field, the <code>location_code</code> with <code class="long-string">2840</code> value will be used by default;<br>you can receive the list of available locations of the search engine with their <code>location_name</code> by making a separate request to the <code>https://api.dataforseo.com/v3/ai_optimization/llm_mentions/locations_and_languages</code><br><strong>Note: <code>chat_gpt</code> data is available for <code class="long-string">United States</code> only'
          nullable: true
        location_code:
          type: integer
          description: '<em>search location code</em><br>optional field<br>if you use this field, you don''t need to specify <code>location_name</code><br>you can receive the list of available locations of the search engine with their <code>location_code</code> by making a separate request to the <code>https://api.dataforseo.com/v3/ai_optimization/llm_mentions/locations_and_languages</code><br>default value: <code class="long-string">2840</code><br><strong>Note: <code>chat_gpt</code> data is available for <code class="long-string">2840</code> only'
          nullable: true
        language_name:
          type: string
          description: '<em>full name of search language</em><br>optional field<br>if you use this field, you don''t need to specify <code>language_code</code>;<br>if you don''t specify this field, the <code>language_code</code> with <code class="long-string">en</code> value will be used by default;<br>you can receive the list of available languages of the search engine with their <code>language_name</code> by making a separate request to the <code>https://api.dataforseo.com/v3/ai_optimization/llm_mentions/locations_and_languages</code><br><strong>Note: <code>chat_gpt</code> data is available for <code class="long-string">English</code> only'
          nullable: true
        language_code:
          type: string
          description: '<em>search language code</em><br>optional field<br>if you use this field, you don''t need to specify <code>language_name</code>;<br>you can receive the list of available languages of the search engine with their <code>language_code</code> by making a separate request to the <code>https://api.dataforseo.com/v3/ai_optimization/llm_mentions/locations_and_languages</code><br>default value: <code class="long-string">en</code><br><strong>Note: <code>chat_gpt</code> data is available for <code class="long-string">en</code> only'
          nullable: true
        platform:
          type: string
          description: '<em>target platform</em><br>optional field<br>possible values:<br><code>chat_gpt</code>, <code>google</code><br><strong>Note:</strong> if the <code>platform</code> is not specified, the data is returned for both platforms<br><strong>Note #2:</strong><code>chat_gpt</code> data is available for the <code>United States</code> and <code>English</code> only'
          nullable: true
        initial_dataset_filters:
          type: array
          items:
            type: object
            nullable: true
          description: '<em>array of filter expressions applied before aggregation</em><br>optional field<br>you can use this array to filter expressions applied to the raw mentions database before aggregation to limit the rows contributing to the result;<p><strong>you can add several filters at once (8 filters maximum)</strong><br>you should set a logical operator <code>and</code>, <code>or</code> between the conditions<br>the following operators are supported:<br><code>=</code>, <code>&lt;&gt;</code>, <code>in</code>, <code>not_in</code>, <code>like</code>, <code>not_like</code>, <code>ilike</code>, <code>not_ilike</code>, <code>match</code>, <code>not_match</code><br>you can use the <code>%</code> operator with <code>like</code> and <code>not_like</code> to match any string of zero or more characters<br>example:<br><code>["ai_search_volume","&gt;",1000]</code><p>the full list of possible filters is available <a href="/v3/ai_optimization/llm_mentions/filters" rel="noopener noreferrer" target="_blank">here.</a><br>learn more about the initial dataset filters in <a href="https://dataforseo.com/help-center/what-are-the-initial-dataset-filters-and-how-do-they-work" rel="noopener noreferrer" target="_blank">this help center article.</a>'
          nullable: true
        internal_list_limit:
          type: integer
          description: '<em>maximum number of elements within internal arrays</em><br>optional field<br>you can use this field to limit the number of elements within the following arrays:<br><code>sources_domain</code><br><code>search_results_domain</code><br>minimum value: <code>1</code><br>maximum value: <code>10</code><br>default value: <code>10</code>'
          nullable: true
        tag:
          type: string
          description: <em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response
          nullable: true
      example:
        - language_code: en
          location_code: 2840
          platform: chat_gpt
          target:
            - domain: en.wikipedia.org
              search_filter: exclude
            - keyword: bmw
              search_scope:
                - answer
          initial_dataset_filters:
            - 
              - ai_search_volume
              - '>'
              - 10
          internal_list_limit: 10
    AggregatedMetricsItemInfo:
      type: object
      properties:
        key:
          type: string
          description: <em>grouping identifier</em><br>the specific identifier for the grouping dimension
          nullable: true
        mentions:
          type: integer
          description: <em>total LLM mentions count</em><br>the number of times the target keyword or domain were mentioned in relation to this specific grouping key
          nullable: true
        ai_search_volume:
          type: integer
          description: <em>aggregated AI search volume for mentions within this grouping</em><br>learn more about this metric <a href="https://dataforseo.com/help-center/how-the-ai-search-volume-metric-works-in-llm-mentions" rel="noopener noreferrer" target="_blank">here</a>
          format: int64
          nullable: true
    AggregatedMetricsInfoTotalInfo:
      type: object
      properties:
        mentions:
          type: integer
          description: <em>total LLM mentions count</em><br>the number of times the target keyword or domain were mentioned in relation to this specific grouping key
          nullable: true
        ai_search_volume:
          type: integer
          description: <em>aggregated AI search volume for mentions within this grouping</em><br>learn more about this metric <a href="https://dataforseo.com/help-center/how-the-ai-search-volume-metric-works-in-llm-mentions" rel="noopener noreferrer" target="_blank">here</a>
          format: int64
          nullable: true
    LlmMentionsAggregatedMetricsInfo:
      type: object
      properties:
        location:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/AggregatedMetricsItemInfo'
            nullable: true
          description: <em>location-based grouping</em><br>array of objects containing mention metrics segmented by geographical location
          nullable: true
        language:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/AggregatedMetricsItemInfo'
            nullable: true
          description: <em>language-based grouping</em><br>array of objects containing mention metrics segmented by content language
          nullable: true
        platform:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/AggregatedMetricsItemInfo'
            nullable: true
          description: <em>platform-based grouping</em><br>array of group elements containing mention metrics segmented by AI platform
          nullable: true
        sources_domain:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/AggregatedMetricsItemInfo'
            nullable: true
          description: <em>found top source domains relevant to the target</em><br>array of objects containing data on top domains that are cited as sources in LLM responses<br>learn more about the sources and how to retrieve LLM citation data at our <a href="https://dataforseo.com/help-center/how-to-get-llm-citation-data-with-llm-mentions-api" target="_blank">Help Center</a>
          nullable: true
        search_results_domain:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/AggregatedMetricsItemInfo'
            nullable: true
          description: <em>found top search results domains relevant to the target</em><br>array of objects containing data on top domains that appear in search results related to LLM queries;<br><strong>Note:</strong> available only for <code>chat_gpt</code>
          nullable: true
        brand_entities_title:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/AggregatedMetricsItemInfo'
            nullable: true
          description: <em>data on brand entities relevant to the target</em><br>array of objects containing data on brand entity titles that appear in search results related to LLM queries;<br><strong>Note:</strong> available only for <code>chat_gpt</code>
          nullable: true
        brand_entities_category:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/AggregatedMetricsItemInfo'
            nullable: true
          description: <em>data on brand entities relevant to the target</em><br>array of objects containing data on brand entity categories that appear in search results related to LLM queries<br><strong>Note:</strong> available only for <code>chat_gpt</code>
          nullable: true
        total:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AggregatedMetricsInfoTotalInfo'
          description: <em>aggregated mentions metrics summary</em><br>contains overall aggregated LLM mention metrics across all found domains
          nullable: true
    AiOptimizationLlmMentionsTargetMetricsLiveResultInfo:
      type: object
      properties:
        total_count:
          type: integer
          description: '<em>total amount of results relevant to the request</em><br>in this case, always equals <code>0</code>'
          format: int64
          nullable: true
        offset:
          type: integer
          description: '<em>the number of mentions objects that are omitted in the <code>items</code> array</em><br>in this case, always equals <code>0</code>'
          nullable: true
        items_count:
          type: integer
          description: '<em>the number of results returned in the <code>items</code> array</em><br>in this case, always equals <code>0</code>'
          format: int64
          nullable: true
        aggregated_metrics:
          type: object
          oneOf:
            - $ref: '#/components/schemas/LlmMentionsAggregatedMetricsInfo'
          description: '<em>aggregated mentions metrics</em><br>contains aggregated LLM mention metrics across all found domains, grouped by various dimensions'
          nullable: true
        items:
          type: array
          items:
            type: object
            nullable: true
          description: '<em>individual target results</em><br>in this case, equals <code>null</code>'
          nullable: true
    AiOptimizationLlmMentionsTargetMetricsLiveTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AiOptimizationLlmMentionsTargetMetricsLiveResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    AiOptimizationLlmMentionsTargetMetricsLiveResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AiOptimizationLlmMentionsTargetMetricsLiveTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    AiOptimizationLlmMentionsMultiTargetMetricsLiveRequestInfo:
      type: object
      properties:
        targets:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/AiOptimizationLLmMentionsMultiTargetMetricsRequestInfo'
            nullable: true
          nullable: true
        location_name:
          type: string
          description: '<em>full name of search location</em><br>optional field<br>if you use this field, you don''t need to specify <code>location_code</code><br>if you don''t specify this field, the <code>location_code</code> with <code class="long-string">2840</code> value will be used by default;<br>you can receive the list of available locations of the search engine with their <code>location_name</code> by making a separate request to the <code>https://api.dataforseo.com/v3/ai_optimization/llm_mentions/locations_and_languages</code><br><strong>Note: <code>chat_gpt</code> data is available for <code class="long-string">United States</code> only'
          nullable: true
        location_code:
          type: integer
          description: '<em>search location code</em><br>optional field<br>if you use this field, you don''t need to specify <code>location_name</code><br>you can receive the list of available locations of the search engine with their <code>location_code</code> by making a separate request to the <code>https://api.dataforseo.com/v3/ai_optimization/llm_mentions/locations_and_languages</code><br>default value: <code class="long-string">2840</code><br><strong>Note: <code>chat_gpt</code> data is available for <code class="long-string">2840</code> only'
          nullable: true
        language_name:
          type: string
          description: '<em>full name of search language</em><br>optional field<br>if you use this field, you don''t need to specify <code>language_code</code>;<br>if you don''t specify this field, the <code>language_code</code> with <code class="long-string">en</code> value will be used by default;<br>you can receive the list of available languages of the search engine with their <code>language_name</code> by making a separate request to the <code>https://api.dataforseo.com/v3/ai_optimization/llm_mentions/locations_and_languages</code><br><strong>Note: <code>chat_gpt</code> data is available for <code class="long-string">English</code> only'
          nullable: true
        language_code:
          type: string
          description: '<em>search language code</em><br>optional field<br>if you use this field, you don''t need to specify <code>language_name</code>;<br>you can receive the list of available languages of the search engine with their <code>language_code</code> by making a separate request to the <code>https://api.dataforseo.com/v3/ai_optimization/llm_mentions/locations_and_languages</code><br>default value: <code class="long-string">en</code><br><strong>Note: <code>chat_gpt</code> data is available for <code class="long-string">en</code> only'
          nullable: true
        platform:
          type: string
          description: '<em>target platform</em><br>optional field<br>possible values:<br><code>chat_gpt</code>, <code>google</code><br>default value: <code class="long-string">google</code><br><strong>Note:</strong> if the <code>platform</code> is not specified, the data is returned for both platforms<br><strong>Note #2:</strong><code>chat_gpt</code> data is available for the <code>United States</code> and <code>English</code> only'
          nullable: true
        filters:
          type: array
          items:
            type: object
            nullable: true
          description: '<em>array of results filtering parameters</em><br>optional field<br><strong>you can add several filters at once (8 filters maximum)</strong><br>you should set a logical operator <code>and</code>, <code>or</code> between the conditions<br>the following operators are supported:<br><code>=</code>, <code>&lt;&gt;</code>, <code>in</code>, <code>not_in</code>, <code>like</code>, <code>not_like</code>, <code>ilike</code>, <code>not_ilike</code>, <code>match</code>, <code>not_match</code><br>you can use the <code>%</code> operator with <code>like</code> and <code>not_like</code> to match any string of zero or more characters<br>example:<br><code>["ai_search_volume","&gt;",1000]</code><p>The full list of possible filters is available <a href="/v3/ai_optimization/llm_mentions/filters/" rel="noopener noreferrer" target="_blank">here.</a>'
          nullable: true
        initial_dataset_filters:
          type: array
          items:
            type: object
            nullable: true
          description: '<em>array of filter expressions applied before aggregation</em><br>optional field<br>you can use this array to filter expressions applied to the raw mentions database before aggregation to limit the rows contributing to the result;<p><strong>you can add several filters at once (8 filters maximum)</strong><br>you should set a logical operator <code>and</code>, <code>or</code> between the conditions<br>the following operators are supported:<br><code>=</code>, <code>&lt;&gt;</code>, <code>in</code>, <code>not_in</code>, <code>like</code>, <code>not_like</code>, <code>ilike</code>, <code>not_ilike</code>, <code>match</code>, <code>not_match</code><br>you can use the <code>%</code> operator with <code>like</code> and <code>not_like</code> to match any string of zero or more characters<br>example:<br><code>["ai_search_volume","&gt;",1000]</code><p>the full list of possible filters is available <a href="/v3/ai_optimization/llm_mentions/filters" rel="noopener noreferrer" target="_blank">here.</a><br>learn more about the initial dataset filters in <a href="https://dataforseo.com/help-center/what-are-the-initial-dataset-filters-and-how-do-they-work" rel="noopener noreferrer" target="_blank">this help center article.</a>'
          nullable: true
        order_by:
          type: array
          items:
            type: string
          description: '<em>results sorting rules</em><br>optional field<br>you can use the same values as in the <code>filters</code> array to sort the results<br>possible sorting types:<br><code>asc</code> - results will be sorted in the ascending order<br><code>desc</code> - results will be sorted in the descending order<br>you should use a comma to set up a sorting type<br>example:<br><code>["ai_search_volume,desc"]</code><br><strong>Note:</strong> you can set no more than three sorting rules in a single request<br>you should use a comma to separate several sorting rules'
          nullable: true
        limit:
          type: integer
          description: '<em>the maximum number of returned objects</em><br>optional field<p>default value: <code>100</code><br>maximum value: <code>1000</code>'
          nullable: true
        offset:
          type: integer
          description: '<em>offset in the results array of the returned mentions data</em><br>optional field<p>default value: <code>0</code><br>example: if you specify the <code>10</code> value, the first ten mentions objects in the results array will be omitted and the data will be provided for the successive objects;<br><strong>Note:</strong> the maximum value is <code>1000000</code>, use the <code>search_after_token</code> if you would like to offset more results'
          nullable: true
        internal_list_limit:
          type: integer
          description: '<em>maximum number of elements within internal arrays</em><br>optional field<br>you can use this field to limit the number of elements within the following arrays:<br><code>sources_domain</code><br><code>search_results_domain</code><br>minimum value: <code>1</code><br>maximum value: <code>10</code><br>default value: <code>5</code>'
          nullable: true
        tag:
          type: string
          description: <em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response
          nullable: true
      example:
        - language_code: en
          location_code: 2840
          platform: google
          targets:
            - key: chat_gpt
              target:
                - keyword: chat gpt
            - key: claude
              target:
                - keyword: claude
            - key: gemini
              target:
                - keyword: gemini
            - key: perplexity
              target:
                - keyword: perplexity
                  search_filter: include
          initial_dataset_filters:
            - 
              - ai_search_volume
              - '>'
              - 10
          internal_list_limit: 5
    AiOptimizationLlmMentionsMultiTargetMetricsLiveItem:
      type: object
      properties:
        key:
          type: string
          description: <em>grouping key</em><br>the specific identifier for the group dimension
          nullable: true
        location:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/AggregatedMetricsItemInfo'
            nullable: true
          description: <em>location-based grouping</em><br>array of objects containing mention metrics segmented by geographical location
          nullable: true
        language:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/AggregatedMetricsItemInfo'
            nullable: true
          description: <em>language-based grouping</em><br>array of objects containing mention metrics segmented by content language
          nullable: true
        platform:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/AggregatedMetricsItemInfo'
            nullable: true
          description: <em>platform-based grouping</em><br>array of group elements containing mention metrics segmented by AI platform
          nullable: true
        sources_domain:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/AggregatedMetricsItemInfo'
            nullable: true
          description: <em>found top source domains relevant to the target</em><br>array of objects containing data on top domains that are cited as sources in LLM responses<br>learn more about the sources and how to retrieve LLM citation data at our <a href="https://dataforseo.com/help-center/how-to-get-llm-citation-data-with-llm-mentions-api" target="_blank">Help Center</a>
          nullable: true
        search_results_domain:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/AggregatedMetricsItemInfo'
            nullable: true
          description: <em>found top search results domains relevant to the target</em><br>array of objects containing data on top domains that appear in search results related to LLM queries;<br><strong>Note:</strong> available only for <code>chat_gpt</code>
          nullable: true
        brand_entities_title:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/AggregatedMetricsItemInfo'
            nullable: true
          description: <em>data on brand entities relevant to the target</em><br>array of objects containing data on brand entity titles that appear in search results related to LLM queries<br><strong>Note:</strong> available only for <code>chat_gpt</code>
          nullable: true
        brand_entities_category:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/AggregatedMetricsItemInfo'
            nullable: true
          description: <em>data on brand entities relevant to the target</em><br>array of objects containing data on brand entity categories that appear in search results related to LLM queries;<br><strong>Note:</strong> available only for <code>chat_gpt</code>
          nullable: true
        total:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AggregatedMetricsInfoTotalInfo'
          description: <em>data on total mentions and search volume for the target</em>
          nullable: true
    AiOptimizationLlmMentionsMultiTargetMetricsLiveResultInfo:
      type: object
      properties:
        total_count:
          type: integer
          description: <em>total number of results</em>
          format: int64
          nullable: true
        offset:
          type: integer
          description: <em>offset in the results array of the returned mentions data</em><br><code>offset</code> specified in the request
          nullable: true
        items_count:
          type: integer
          description: <em>number of items in the results array</em>
          format: int64
          nullable: true
        aggregated_metrics:
          type: object
          oneOf:
            - $ref: '#/components/schemas/LlmMentionsAggregatedMetricsInfo'
          description: <em>aggregated mentions metrics summary</em><br>contains overall aggregated LLM mention metrics across all LLM mentions that match at least one target specified in the request
          nullable: true
        items:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/AiOptimizationLlmMentionsMultiTargetMetricsLiveItem'
            nullable: true
          description: <em>contains relevant mentions data</em>
          nullable: true
    AiOptimizationLlmMentionsMultiTargetMetricsLiveTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AiOptimizationLlmMentionsMultiTargetMetricsLiveResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    AiOptimizationLlmMentionsMultiTargetMetricsLiveResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AiOptimizationLlmMentionsMultiTargetMetricsLiveTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    AiOptimizationLlmMentionsTopMentionedDomainsLiveRequestInfo:
      type: object
      properties:
        target:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/BaseAiOptimizationLLmMentionsTargetElement'
            nullable: true
          description: "array of objects containing target entities\nrequired field\nyou can specify up to 10 entities (objects) in the target field\none target entity can contain either one domain or one keyword and related parameters\nexamples:\n\ntarget array with a domain entity"
          nullable: true
        location_name:
          type: string
          description: '<em>full name of search location</em><br>optional field<br>if you use this field, you don''t need to specify <code>location_code</code><br>if you don''t specify this field, the <code>location_code</code> with <code class="long-string">2840</code> value will be used by default;<br>you can receive the list of available locations of the search engine with their <code>location_name</code> by making a separate request to the <code>https://api.dataforseo.com/v3/ai_optimization/llm_mentions/locations_and_languages</code><br><strong>Note: <code>chat_gpt</code> data is available for <code class="long-string">United States</code> only'
          nullable: true
        location_code:
          type: integer
          description: '<em>search location code</em><br>optional field<br>if you use this field, you don''t need to specify <code>location_name</code><br>you can receive the list of available locations of the search engine with their <code>location_code</code> by making a separate request to the <code>https://api.dataforseo.com/v3/ai_optimization/llm_mentions/locations_and_languages</code><br>default value: <code class="long-string">2840</code><br><strong>Note: <code>chat_gpt</code> data is available for <code class="long-string">2840</code> only'
          nullable: true
        language_name:
          type: string
          description: '<em>full name of search language</em><br>optional field<br>if you use this field, you don''t need to specify <code>language_code</code>;<br>if you don''t specify this field, the <code>language_code</code> with <code class="long-string">en</code> value will be used by default;<br>you can receive the list of available languages of the search engine with their <code>language_name</code> by making a separate request to the <code>https://api.dataforseo.com/v3/ai_optimization/llm_mentions/locations_and_languages</code><br><strong>Note: <code>chat_gpt</code> data is available for <code class="long-string">English</code> only'
          nullable: true
        language_code:
          type: string
          description: '<em>search language code</em><br>optional field<br>if you use this field, you don''t need to specify <code>language_name</code>;<br>you can receive the list of available languages of the search engine with their <code>language_code</code> by making a separate request to the <code>https://api.dataforseo.com/v3/ai_optimization/llm_mentions/locations_and_languages</code><br>default value: <code class="long-string">en</code><br><strong>Note: <code>chat_gpt</code> data is available for <code class="long-string">en</code> only'
          nullable: true
        platform:
          type: string
          description: '<em>target platform</em><br>optional field<br>possible values:<br><code>chat_gpt</code>, <code>google</code><br><strong>Note:</strong> if the <code>platform</code> is not specified, the data is returned for both platforms<br><strong>Note #2:</strong><code>chat_gpt</code> data is available for the <code>United States</code> and <code>English</code> only'
          nullable: true
        links_scope:
          type: string
          description: '<em>links source scope</em><br>optional field<br>this parameter specifies which links will be used to extract domains and aggregation data<br>possible values: <code>sources</code>, <code>search_results</code><br>default value: <code>sources</code><br><strong>Note:</strong>if you specify <code>search_results</code>, the data will be available for <code>chat_gpt</code> only'
          nullable: true
        filters:
          type: array
          items:
            type: object
            nullable: true
          description: '<em>array of results filtering parameters</em><br>optional field<br><strong>you can add several filters at once (8 filters maximum)</strong><br>you should set a logical operator <code>and</code>, <code>or</code> between the conditions<br>the following operators are supported:<br><code>=</code>, <code>&lt;&gt;</code>, <code>in</code>, <code>not_in</code>, <code>like</code>, <code>not_like</code>, <code>ilike</code>, <code>not_ilike</code>, <code>match</code>, <code>not_match</code><br>you can use the <code>%</code> operator with <code>like</code> and <code>not_like</code> to match any string of zero or more characters<br>example:<br><code>["ai_search_volume","&gt;",1000]</code><p>The full list of possible filters is available <a href="/v3/ai_optimization/llm_mentions/filters/" rel="noopener noreferrer" target="_blank">here.</a>'
          nullable: true
        initial_dataset_filters:
          type: array
          items:
            type: object
            nullable: true
          description: '<em>array of filter expressions applied before aggregation</em><br>optional field<br>you can use this array to filter expressions applied to the raw mentions database before aggregation to limit the rows contributing to the result;<p><strong>you can add several filters at once (8 filters maximum)</strong><br>you should set a logical operator <code>and</code>, <code>or</code> between the conditions<br>the following operators are supported:<br><code>=</code>, <code>&lt;&gt;</code>, <code>in</code>, <code>not_in</code>, <code>like</code>, <code>not_like</code>, <code>ilike</code>, <code>not_ilike</code>, <code>match</code>, <code>not_match</code><br>you can use the <code>%</code> operator with <code>like</code> and <code>not_like</code> to match any string of zero or more characters<br>example:<br><code>["ai_search_volume","&gt;",1000]</code><p>the full list of possible filters is available <a href="/v3/ai_optimization/llm_mentions/filters" rel="noopener noreferrer" target="_blank">here.</a><br>learn more about the initial dataset filters in <a href="https://dataforseo.com/help-center/what-are-the-initial-dataset-filters-and-how-do-they-work" rel="noopener noreferrer" target="_blank">this help center article.</a>'
          nullable: true
        limit:
          type: integer
          description: '<em>maximum number of results in the items array</em><br>optional field<br>you can use this parameter to limit the number of data objects you receive in the <code>items</code> array<br>minimum value: <code>1</code><br>maximum value: <code>1000</code><br>default value: <code>100</code>'
          nullable: true
        internal_list_limit:
          type: integer
          description: '<em>maximum number of elements within internal arrays</em><br>optional field<br>you can use this field to limit the number of elements within the following arrays:<br><code>sources_domain</code>, <code>search_results_domain</code>, <code>brand_entities_title</code>, <code>brand_entities_category</code><br>minimum value: <code>1</code><br>maximum value: <code>10</code><br>default value: <code>5</code>'
          nullable: true
        order_by:
          type: array
          items:
            type: string
          description: '<em>results sorting rules</em><br>optional field<br>you can use the same values as in the <code>filters</code> array to sort the results<br>possible sorting types:<br><code>asc</code> - results will be sorted in the ascending order<br><code>desc</code> - results will be sorted in the descending order<br>you should use a comma to set up a sorting type<br>example:<br><code>["ai_search_volume,desc"]</code><br><strong>Note:</strong> you can set no more than three sorting rules in a single request<br>you should use a comma to separate several sorting rules'
          nullable: true
        offset:
          type: integer
          description: '<em>offset in the results array of the returned mentions data</em><br>optional field<p>default value: <code>0</code><br>example: if you specify the <code>10</code> value, the first ten mentions objects in the results array will be omitted and the data will be provided for the successive objects;<br><strong>Note:</strong> the maximum value is <code>1000000</code>'
          nullable: true
        include_domains:
          type: array
          items:
            type: string
          description: '<em>array of domains to include in the response</em><br>optional field<br>if specified, only the listed domains will be returned in the <code>items</code> array<br>example:<br><code>"include_domains": ["en.wikipedia.org"]</code>'
          nullable: true
        exclude_domains:
          type: array
          items:
            type: string
          description: '<em>array of domains to exclude from the response</em><br>optional field<br>if specified, the listed domains will be omitted from the <code>items</code> array<br>example:<br><code>"exclude_domains": ["en.wikipedia.org"]</code>'
          nullable: true
        tag:
          type: string
          description: <em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response
          nullable: true
      example:
        - language_code: en
          location_code: 2840
          platform: chat_gpt
          target:
            - keyword: bmw
              search_scope:
                - answer
            - keyword: auto
              search_scope:
                - question
              match_type: partial_match
          links_scope: sources
          initial_dataset_filters:
            - 
              - ai_search_volume
              - '>'
              - 10
          limit: 3
          internal_list_limit: 2
    AiOptimizationLlmMentionsTopMentionedDomainsLiveItem:
      type: object
      properties:
        domain:
          type: string
          description: <em>domain name</em><br>the domain name of the website found in LLM mentions for the specified target
          nullable: true
        location:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/AggregatedMetricsItemInfo'
            nullable: true
          description: <em>location-based grouping</em><br>array of objects containing mention metrics segmented by geographical location
          nullable: true
        language:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/AggregatedMetricsItemInfo'
            nullable: true
          description: <em>language-based grouping</em><br>array of objects containing mention metrics segmented by content language
          nullable: true
        platform:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/AggregatedMetricsItemInfo'
            nullable: true
          description: <em>platform-based grouping</em><br>array of group elements containing mention metrics segmented by AI platform
          nullable: true
        sources_domain:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/AggregatedMetricsItemInfo'
            nullable: true
          description: <em>found top source domains relevant to the target</em><br>array of objects containing data on top domains that are cited as sources in LLM responses<br>learn more about the sources and how to retrieve LLM citation data at our <a href="https://dataforseo.com/help-center/how-to-get-llm-citation-data-with-llm-mentions-api" target="_blank">Help Center</a>
          nullable: true
        search_results_domain:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/AggregatedMetricsItemInfo'
            nullable: true
          description: <em>found top search results domains relevant to the target</em><br>array of objects containing data on top domains that appear in search results related to LLM queries;<br><strong>Note:</strong> available only for <code>chat_gpt</code>
          nullable: true
        brand_entities_title:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/AggregatedMetricsItemInfo'
            nullable: true
          description: <em>data on brand entities relevant to the target</em><br>array of objects containing data on brand entity titles that appear in search results related to LLM queries;<br><strong>Note:</strong> available only for <code>chat_gpt</code>
          nullable: true
        brand_entities_category:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/AggregatedMetricsItemInfo'
            nullable: true
          description: <em>data on brand entities relevant to the target</em><br>array of objects containing data on brand entity categories that appear in search results related to LLM queries;<br><strong>Note:</strong> available only for <code>chat_gpt</code>
          nullable: true
        total:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AggregatedMetricsInfoTotalInfo'
          description: <em>aggregated mentions metrics summary</em><br>contains overall aggregated LLM mention metrics across all dimensions
          nullable: true
    AiOptimizationLlmMentionsTopMentionedDomainsLiveResultInfo:
      type: object
      properties:
        total_count:
          type: integer
          description: <em>total amount of results relevant the request</em>
          format: int64
          nullable: true
        offset:
          type: integer
          description: <em>the number of mentions objects that are omitted in the <code>items</code> array</em>
          nullable: true
        items_count:
          type: integer
          description: <em>the number of results returned in the <code>items</code> array</em>
          format: int64
          nullable: true
        aggregated_metrics:
          type: object
          oneOf:
            - $ref: '#/components/schemas/LlmMentionsAggregatedMetricsInfo'
          description: '<em>aggregated mentions metrics</em><br>contains aggregated LLM mention metrics across all found domains, grouped by various dimensions'
          nullable: true
        items:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/AiOptimizationLlmMentionsTopMentionedDomainsLiveItem'
            nullable: true
          description: <em>individual domain results</em><br>array containing detailed mention metrics for each of the found top domains
          nullable: true
    AiOptimizationLlmMentionsTopMentionedDomainsLiveTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AiOptimizationLlmMentionsTopMentionedDomainsLiveResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    AiOptimizationLlmMentionsTopMentionedDomainsLiveResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AiOptimizationLlmMentionsTopMentionedDomainsLiveTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    AiOptimizationLlmMentionsTopMentionedPagesLiveRequestInfo:
      type: object
      properties:
        target:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/BaseAiOptimizationLLmMentionsTargetElement'
            nullable: true
          description: "array of objects containing target entities\nrequired field\nyou can specify up to 10 entities (objects) in the target field\none target entity can contain either one domain or one keyword and related parameters\nexamples:\n\ntarget array with a domain entity"
          nullable: true
        location_name:
          type: string
          description: '<em>full name of search location</em><br>optional field<br>if you use this field, you don''t need to specify <code>location_code</code><br>if you don''t specify this field, the <code>location_code</code> with <code class="long-string">2840</code> value will be used by default;<br>you can receive the list of available locations of the search engine with their <code>location_name</code> by making a separate request to the <code>https://api.dataforseo.com/v3/ai_optimization/llm_mentions/locations_and_languages</code><br><strong>Note: <code>chat_gpt</code> data is available for <code class="long-string">United States</code> only'
          nullable: true
        location_code:
          type: integer
          description: '<em>search location code</em><br>optional field<br>if you use this field, you don''t need to specify <code>location_name</code><br>you can receive the list of available locations of the search engine with their <code>location_code</code> by making a separate request to the <code>https://api.dataforseo.com/v3/ai_optimization/llm_mentions/locations_and_languages</code><br>default value: <code class="long-string">2840</code><br><strong>Note: <code>chat_gpt</code> data is available for <code class="long-string">2840</code> only'
          nullable: true
        language_name:
          type: string
          description: '<em>full name of search language</em><br>optional field<br>if you use this field, you don''t need to specify <code>language_code</code>;<br>if you don''t specify this field, the <code>language_code</code> with <code class="long-string">en</code> value will be used by default;<br>you can receive the list of available languages of the search engine with their <code>language_name</code> by making a separate request to the <code>https://api.dataforseo.com/v3/ai_optimization/llm_mentions/locations_and_languages</code><br><strong>Note: <code>chat_gpt</code> data is available for <code class="long-string">English</code> only'
          nullable: true
        language_code:
          type: string
          description: '<em>search language code</em><br>optional field<br>if you use this field, you don''t need to specify <code>language_name</code>;<br>you can receive the list of available languages of the search engine with their <code>language_code</code> by making a separate request to the <code>https://api.dataforseo.com/v3/ai_optimization/llm_mentions/locations_and_languages</code><br>default value: <code class="long-string">en</code><br><strong>Note: <code>chat_gpt</code> data is available for <code class="long-string">en</code> only'
          nullable: true
        platform:
          type: string
          description: '<em>target platform</em><br>optional field<br>possible values:<br><code>chat_gpt</code>, <code>google</code><br><strong>Note:</strong> if the <code>platform</code> is not specified, the data is returned for both platforms<br><strong>Note #2:</strong><code>chat_gpt</code> data is available for the <code>United States</code> and <code>English</code> only'
          nullable: true
        links_scope:
          type: string
          description: '<em>links source scope</em><br>optional field<br>this parameter specifies which links will be used to extract domains and aggregation data<br>possible values: <code>sources</code>, <code>search_results</code><br>default value: <code>sources</code>;<br><strong>Note:</strong>if you specify <code>search_results</code>, the data will be available for <code>chat_gpt</code> only'
          nullable: true
        filters:
          type: array
          items:
            type: object
            nullable: true
          description: '<em>array of results filtering parameters</em><br>optional field<br><strong>you can add several filters at once (8 filters maximum)</strong><br>you should set a logical operator <code>and</code>, <code>or</code> between the conditions<br>the following operators are supported:<br><code>=</code>, <code>&lt;&gt;</code>, <code>in</code>, <code>not_in</code>, <code>like</code>, <code>not_like</code>, <code>ilike</code>, <code>not_ilike</code>, <code>match</code>, <code>not_match</code><br>you can use the <code>%</code> operator with <code>like</code> and <code>not_like</code> to match any string of zero or more characters<br>example:<br><code>["ai_search_volume","&gt;",1000]</code><p>The full list of possible filters is available <a href="/v3/ai_optimization/llm_mentions/filters/" rel="noopener noreferrer" target="_blank">here.</a>'
          nullable: true
        initial_dataset_filters:
          type: array
          items:
            type: object
            nullable: true
          description: '<em>array of filter expressions applied before aggregation</em><br>optional field<br>you can use this array to filter expressions applied to the raw mentions database before aggregation to limit the rows contributing to the result;<p><strong>you can add several filters at once (8 filters maximum)</strong><br>you should set a logical operator <code>and</code>, <code>or</code> between the conditions<br>the following operators are supported:<br><code>=</code>, <code>&lt;&gt;</code>, <code>in</code>, <code>not_in</code>, <code>like</code>, <code>not_like</code>, <code>ilike</code>, <code>not_ilike</code>, <code>match</code>, <code>not_match</code><br>you can use the <code>%</code> operator with <code>like</code> and <code>not_like</code> to match any string of zero or more characters<br>example:<br><code>["ai_search_volume","&gt;",1000]</code><p>the full list of possible filters is available <a href="/v3/ai_optimization/llm_mentions/filters" rel="noopener noreferrer" target="_blank">here.</a><br>learn more about the initial dataset filters in <a href="https://dataforseo.com/help-center/what-are-the-initial-dataset-filters-and-how-do-they-work" rel="noopener noreferrer" target="_blank">this help center article.</a>'
          nullable: true
        limit:
          type: integer
          description: '<em>maximum number of results in the items array</em><br>optional field<br>you can use this parameter to limit the number of data objects you receive in the <code>items</code> array<br>minimum value: <code>1</code><br>maximum value: <code>1000</code><br>default value: <code>100</code>'
          nullable: true
        internal_list_limit:
          type: integer
          description: '<em>maximum number of elements within internal arrays</em><br>optional field<br>you can use this field to limit the number of elements within the following arrays:<br><code>sources_domain</code>, <code>search_results_domain</code>, <code>brand_entities_title</code>, <code>brand_entities_category</code><br>minimum value: <code>1</code><br>maximum value: <code>10</code><br>default value: <code>5</code>'
          nullable: true
        order_by:
          type: array
          items:
            type: string
          description: '<em>results sorting rules</em><br>optional field<br>you can use the same values as in the <code>filters</code> array to sort the results<br>possible sorting types:<br><code>asc</code> - results will be sorted in the ascending order<br><code>desc</code> - results will be sorted in the descending order<br>you should use a comma to set up a sorting type<br>example:<br><code>["ai_search_volume,desc"]</code><br><strong>Note:</strong> you can set no more than three sorting rules in a single request<br>you should use a comma to separate several sorting rules'
          nullable: true
        offset:
          type: integer
          description: '<em>offset in the results array of the returned mentions data</em><br>optional field<p>default value: <code>0</code><br>example: if you specify the <code>10</code> value, the first ten mentions objects in the results array will be omitted and the data will be provided for the successive objects;<br><strong>Note:</strong> the maximum value is <code>1000000</code>'
          nullable: true
        include_pages:
          type: array
          items:
            type: string
          description: '<em>array of pages to include in the response</em><br>optional field<br>if specified, only the listed pages will be returned in the <code>items</code> array<br>example:<br><code>"include_pages": ["https://example.page/"]</code>'
          nullable: true
        exclude_pages:
          type: array
          items:
            type: string
          description: '<em>array of pages to exclude from the response</em><br>optional field<br>if specified, the listed pages will be omitted from the <code>items</code> array<br>example:<br><code>"exclude_pages": ["https://example.page/"]</code>'
          nullable: true
        tag:
          type: string
          description: <em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response
          nullable: true
      example:
        - language_code: en
          location_code: 2840
          platform: chat_gpt
          target:
            - keyword: bmw
              search_scope:
                - answer
            - keyword: auto
              search_scope:
                - question
              match_type: partial_match
          links_scope: sources
          initial_dataset_filters:
            - 
              - ai_search_volume
              - '>'
              - 10
          limit: 3
          internal_list_limit: 2
    AiOptimizationLlmMentionsTopMentionedPagesLiveItem:
      type: object
      properties:
        page:
          type: string
          description: <em>URL of a found page</em><br>the URL of a page found in LLM mentions for the specified target
          nullable: true
        location:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/AggregatedMetricsItemInfo'
            nullable: true
          description: <em>location-based grouping</em><br>array of objects containing mention metrics segmented by geographical location
          nullable: true
        language:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/AggregatedMetricsItemInfo'
            nullable: true
          description: <em>language-based grouping</em><br>array of objects containing mention metrics segmented by content language
          nullable: true
        platform:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/AggregatedMetricsItemInfo'
            nullable: true
          description: <em>platform-based grouping</em><br>array of group elements containing mention metrics segmented by AI platform
          nullable: true
        sources_domain:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/AggregatedMetricsItemInfo'
            nullable: true
          description: <em>found top source domains relevant to the target</em><br>array of objects containing data on top domains that are cited as sources in LLM responses<br>learn more about the sources and how to retrieve LLM citation data at our <a href="https://dataforseo.com/help-center/how-to-get-llm-citation-data-with-llm-mentions-api" target="_blank">Help Center</a>
          nullable: true
        search_results_domain:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/AggregatedMetricsItemInfo'
            nullable: true
          description: <em>found top search results domains relevant to the target</em><br>array of objects containing data on top domains that appear in search results related to LLM queries;<br><strong>Note:</strong> available only for <code>chat_gpt</code>
          nullable: true
        brand_entities_title:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/AggregatedMetricsItemInfo'
            nullable: true
          description: <em>data on brand entities relevant to the target</em><br>array of objects containing data on brand entity titles that appear in search results related to LLM queries;<br><strong>Note:</strong> available only for <code>chat_gpt</code>
          nullable: true
        brand_entities_category:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/AggregatedMetricsItemInfo'
            nullable: true
          description: <em>data on brand entities relevant to the target</em><br>array of objects containing data on brand entity categories that appear in search results related to LLM queries;<br><strong>Note:</strong> available only for <code>chat_gpt</code>
          nullable: true
        total:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AggregatedMetricsInfoTotalInfo'
          description: <em>aggregated mentions metrics summary</em><br>contains overall aggregated LLM mention metrics across all dimensions
          nullable: true
    AiOptimizationLlmMentionsTopMentionedPagesLiveResultInfo:
      type: object
      properties:
        total_count:
          type: integer
          description: <em>total amount of results relevant the request</em>
          format: int64
          nullable: true
        offset:
          type: integer
          description: <em>the number of mentions objects that are omitted in the <code>items</code> array</em>
          nullable: true
        items_count:
          type: integer
          description: <em>the number of results returned in the <code>items</code> array</em>
          format: int64
          nullable: true
        aggregated_metrics:
          type: object
          oneOf:
            - $ref: '#/components/schemas/LlmMentionsAggregatedMetricsInfo'
          description: '<em>aggregated mentions metrics</em><br>contains aggregated LLM mention metrics across all found pages, grouped by various dimensions'
          nullable: true
        items:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/AiOptimizationLlmMentionsTopMentionedPagesLiveItem'
            nullable: true
          description: <em>individual page results</em><br>array containing detailed mention metrics for each of the found top mentioned pages
          nullable: true
    AiOptimizationLlmMentionsTopMentionedPagesLiveTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AiOptimizationLlmMentionsTopMentionedPagesLiveResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    AiOptimizationLlmMentionsTopMentionedPagesLiveResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AiOptimizationLlmMentionsTopMentionedPagesLiveTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    AiOptimizationLlmMentionsTopMentionedBrandsLiveRequestInfo:
      type: object
      properties:
        target:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/BaseAiOptimizationLLmMentionsTargetElement'
            nullable: true
          description: "array of objects containing target entities\nrequired field\nyou can specify up to 10 entities (objects) in the target field\none target entity can contain either one domain or one keyword and related parameters\nexamples:\n\ntarget array with a domain entity"
          nullable: true
        location_name:
          type: string
          description: '<em>full name of search location</em><br>optional field<br>if you use this field, you don''t need to specify <code>location_code</code><br>if you don''t specify this field, the <code>location_code</code> with <code class="long-string">2840</code> value will be used by default;<br>you can receive the list of available locations of the search engine with their <code>location_name</code> by making a separate request to the <code>https://api.dataforseo.com/v3/ai_optimization/llm_mentions/locations_and_languages</code><br><strong>Note: <code>chat_gpt</code> data is available for <code class="long-string">United States</code> only'
          nullable: true
        location_code:
          type: integer
          description: '<em>search location code</em><br>optional field<br>if you use this field, you don''t need to specify <code>location_name</code><br>you can receive the list of available locations of the search engine with their <code>location_code</code> by making a separate request to the <code>https://api.dataforseo.com/v3/ai_optimization/llm_mentions/locations_and_languages</code><br>default value: <code class="long-string">2840</code><br><strong>Note: <code>chat_gpt</code> data is available for <code class="long-string">2840</code> only'
          nullable: true
        language_name:
          type: string
          description: '<em>full name of search language</em><br>optional field<br>if you use this field, you don''t need to specify <code>language_code</code>;<br>if you don''t specify this field, the <code>language_code</code> with <code class="long-string">en</code> value will be used by default;<br>you can receive the list of available languages of the search engine with their <code>language_name</code> by making a separate request to the <code>https://api.dataforseo.com/v3/ai_optimization/llm_mentions/locations_and_languages</code><br><strong>Note: <code>chat_gpt</code> data is available for <code class="long-string">English</code> only'
          nullable: true
        language_code:
          type: string
          description: '<em>search language code</em><br>optional field<br>if you use this field, you don''t need to specify <code>language_name</code>;<br>you can receive the list of available languages of the search engine with their <code>language_code</code> by making a separate request to the <code>https://api.dataforseo.com/v3/ai_optimization/llm_mentions/locations_and_languages</code><br>default value: <code class="long-string">en</code><br><strong>Note: <code>chat_gpt</code> data is available for <code class="long-string">en</code> only'
          nullable: true
        platform:
          type: string
          description: '<em>target platform</em><br>optional field<br>possible values:<br><code>chat_gpt</code>, <code>google</code><br><strong>Note:</strong> data specific to brand entities is available for <code>chat_gpt</code> only;<br><strong>Note #2:</strong><code>chat_gpt</code> data is available for the <code>United States</code> and <code>English</code> only'
          nullable: true
        filters:
          type: array
          items:
            type: object
            nullable: true
          description: '<em>array of results filtering parameters</em><br>optional field<br><strong>you can add several filters at once (8 filters maximum)</strong><br>you should set a logical operator <code>and</code>, <code>or</code> between the conditions<br>the following operators are supported:<br><code>=</code>, <code>&lt;&gt;</code>, <code>in</code>, <code>not_in</code>, <code>like</code>, <code>not_like</code>, <code>ilike</code>, <code>not_ilike</code>, <code>match</code>, <code>not_match</code><br>you can use the <code>%</code> operator with <code>like</code> and <code>not_like</code> to match any string of zero or more characters<br>example:<br><code>["ai_search_volume","&gt;",1000]</code><p>The full list of possible filters is available <a href="/v3/ai_optimization/llm_mentions/filters/" rel="noopener noreferrer" target="_blank">here.</a>'
          nullable: true
        initial_dataset_filters:
          type: array
          items:
            type: object
            nullable: true
          description: '<em>array of filter expressions applied before aggregation</em><br>optional field<br>you can use this array to filter expressions applied to the raw mentions database before aggregation to limit the rows contributing to the result;<p><strong>you can add several filters at once (8 filters maximum)</strong><br>you should set a logical operator <code>and</code>, <code>or</code> between the conditions<br>the following operators are supported:<br><code>=</code>, <code>&lt;&gt;</code>, <code>in</code>, <code>not_in</code>, <code>like</code>, <code>not_like</code>, <code>ilike</code>, <code>not_ilike</code>, <code>match</code>, <code>not_match</code><br>you can use the <code>%</code> operator with <code>like</code> and <code>not_like</code> to match any string of zero or more characters<br>example:<br><code>["ai_search_volume","&gt;",1000]</code><p>the full list of possible filters is available <a href="/v3/ai_optimization/llm_mentions/filters" rel="noopener noreferrer" target="_blank">here.</a><br>learn more about the initial dataset filters in <a href="https://dataforseo.com/help-center/what-are-the-initial-dataset-filters-and-how-do-they-work" rel="noopener noreferrer" target="_blank">this help center article.</a>'
          nullable: true
        limit:
          type: integer
          description: '<em>maximum number of results in the items array</em><br>optional field<br>you can use this parameter to limit the number of data objects you receive in the <code>items</code> array<br>minimum value: <code>1</code><br>maximum value: <code>1000</code><br>default value: <code>100</code>'
          nullable: true
        internal_list_limit:
          type: integer
          description: '<em>maximum number of elements within internal arrays</em><br>optional field<br>you can use this field to limit the number of elements within the following arrays:<br><code>sources_domain</code>, <code>search_results_domain</code>, <code>brand_entities_title</code>, <code>brand_entities_category</code><br>minimum value: <code>1</code><br>maximum value: <code>10</code><br>default value: <code>5</code>'
          nullable: true
        order_by:
          type: array
          items:
            type: string
          description: '<em>results sorting rules</em><br>optional field<br>you can use the same values as in the <code>filters</code> array to sort the results<br>possible sorting types:<br><code>asc</code> - results will be sorted in the ascending order<br><code>desc</code> - results will be sorted in the descending order<br>you should use a comma to set up a sorting type<br>example:<br><code>["ai_search_volume,desc"]</code><br><strong>Note:</strong> you can set no more than three sorting rules in a single request<br>you should use a comma to separate several sorting rules'
          nullable: true
        offset:
          type: integer
          description: '<em>offset in the results array of the returned mentions data</em><br>optional field<p>default value: <code>0</code><br>example: if you specify the <code>10</code> value, the first ten mentions objects in the results array will be omitted and the data will be provided for the successive objects;<br><strong>Note:</strong> the maximum value is <code>1000000</code>'
          nullable: true
        include_brands:
          type: array
          items:
            type: string
          description: '<em>array of brands to include in the response</em><br>optional field<br>if specified, only the listed brands will be returned in the <code>items</code> array<br>example:<br><code>"include_brands": ["Audi"]</code>'
          nullable: true
        exclude_brands:
          type: array
          items:
            type: string
          description: '<em>array of brands to exclude from the response</em><br>optional field<br>if specified, the listed brands will be omitted from the <code>items</code> array<br>example:<br><code>"exclude_brands": ["Audi"]</code>'
          nullable: true
        tag:
          type: string
          description: <em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response
          nullable: true
      example:
        - language_code: en
          location_code: 2840
          platform: chat_gpt
          target:
            - keyword: bmw
              search_scope:
                - answer
            - keyword: auto
              search_scope:
                - question
              match_type: partial_match
          initial_dataset_filters:
            - 
              - ai_search_volume
              - '>'
              - 10
          limit: 3
          internal_list_limit: 2
    AiOptimizationLlmMentionsTopMentionedBrandsLiveItem:
      type: object
      properties:
        brand:
          type: string
          description: <em>brand name</em><br>name of the brand found in LLM mentions for the specified target
          nullable: true
        location:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/AggregatedMetricsItemInfo'
            nullable: true
          description: <em>location-based grouping</em><br>array of objects containing mention metrics segmented by geographical location
          nullable: true
        language:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/AggregatedMetricsItemInfo'
            nullable: true
          description: <em>language-based grouping</em><br>array of objects containing mention metrics segmented by content language
          nullable: true
        platform:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/AggregatedMetricsItemInfo'
            nullable: true
          description: <em>platform-based grouping</em><br>array of group elements containing mention metrics segmented by AI platform
          nullable: true
        sources_domain:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/AggregatedMetricsItemInfo'
            nullable: true
          description: <em>found top source domains relevant to the target</em><br>array of objects containing data on top domains that are cited as sources in LLM responses<br>learn more about the sources and how to retrieve LLM citation data at our <a href="https://dataforseo.com/help-center/how-to-get-llm-citation-data-with-llm-mentions-api" target="_blank">Help Center</a>
          nullable: true
        search_results_domain:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/AggregatedMetricsItemInfo'
            nullable: true
          description: <em>found top search results domains relevant to the target</em><br>array of objects containing data on top domains that appear in search results related to LLM queries
          nullable: true
        brand_entities_title:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/AggregatedMetricsItemInfo'
            nullable: true
          description: <em>data on brand entities relevant to the target</em><br>array of objects containing data on brand entity titles that appear in search results related to LLM queries
          nullable: true
        brand_entities_category:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/AggregatedMetricsItemInfo'
            nullable: true
          description: <em>data on brand entities relevant to the target</em><br>array of objects containing data on brand entity categories that appear in search results related to LLM queries
          nullable: true
        total:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AggregatedMetricsInfoTotalInfo'
          description: <em>aggregated mentions metrics summary</em><br>contains overall aggregated LLM mention metrics across all dimensions
          nullable: true
    AiOptimizationLlmMentionsTopMentionedBrandsLiveResultInfo:
      type: object
      properties:
        total_count:
          type: integer
          description: <em>total amount of results relevant the request</em>
          format: int64
          nullable: true
        offset:
          type: integer
          description: <em>the number of mentions objects that are omitted in the <code>items</code> array</em>
          nullable: true
        items_count:
          type: integer
          description: <em>the number of results returned in the <code>items</code> array</em>
          format: int64
          nullable: true
        aggregated_metrics:
          type: object
          oneOf:
            - $ref: '#/components/schemas/LlmMentionsAggregatedMetricsInfo'
          description: '<em>aggregated mentions metrics</em><br>contains aggregated LLM mention metrics across all found brands, grouped by various dimensions'
          nullable: true
        items:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/AiOptimizationLlmMentionsTopMentionedBrandsLiveItem'
            nullable: true
          description: <em>individual domain results</em><br>array containing detailed mention metrics for each of the found top domains
          nullable: true
    AiOptimizationLlmMentionsTopMentionedBrandsLiveTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AiOptimizationLlmMentionsTopMentionedBrandsLiveResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    AiOptimizationLlmMentionsTopMentionedBrandsLiveResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AiOptimizationLlmMentionsTopMentionedBrandsLiveTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    AiOptimizationLlmMentionsTopMentionedBrandCategoriesLiveRequestInfo:
      type: object
      properties:
        target:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/BaseAiOptimizationLLmMentionsTargetElement'
            nullable: true
          description: "array of objects containing target entities\nrequired field\nyou can specify up to 10 entities (objects) in the target field\none target entity can contain either one domain or one keyword and related parameters\nexamples:\n\ntarget array with a domain entity"
          nullable: true
        location_name:
          type: string
          description: '<em>full name of search location</em><br>optional field<br>if you use this field, you don''t need to specify <code>location_code</code><br>if you don''t specify this field, the <code>location_code</code> with <code class="long-string">2840</code> value will be used by default;<br>you can receive the list of available locations of the search engine with their <code>location_name</code> by making a separate request to the <code>https://api.dataforseo.com/v3/ai_optimization/llm_mentions/locations_and_languages</code><br><strong>Note: <code>chat_gpt</code> data is available for <code class="long-string">United States</code> only'
          nullable: true
        location_code:
          type: integer
          description: '<em>search location code</em><br>optional field<br>if you use this field, you don''t need to specify <code>location_name</code><br>you can receive the list of available locations of the search engine with their <code>location_code</code> by making a separate request to the <code>https://api.dataforseo.com/v3/ai_optimization/llm_mentions/locations_and_languages</code><br>default value: <code class="long-string">2840</code><br><strong>Note: <code>chat_gpt</code> data is available for <code class="long-string">2840</code> only'
          nullable: true
        language_name:
          type: string
          description: '<em>full name of search language</em><br>optional field<br>if you use this field, you don''t need to specify <code>language_code</code>;<br>if you don''t specify this field, the <code>language_code</code> with <code class="long-string">en</code> value will be used by default;<br>you can receive the list of available languages of the search engine with their <code>language_name</code> by making a separate request to the <code>https://api.dataforseo.com/v3/ai_optimization/llm_mentions/locations_and_languages</code><br><strong>Note: <code>chat_gpt</code> data is available for <code class="long-string">English</code> only'
          nullable: true
        language_code:
          type: string
          description: '<em>search language code</em><br>optional field<br>if you use this field, you don''t need to specify <code>language_name</code>;<br>you can receive the list of available languages of the search engine with their <code>language_code</code> by making a separate request to the <code>https://api.dataforseo.com/v3/ai_optimization/llm_mentions/locations_and_languages</code><br>default value: <code class="long-string">en</code><br><strong>Note: <code>chat_gpt</code> data is available for <code class="long-string">en</code> only'
          nullable: true
        platform:
          type: string
          description: '<em>target platform</em><br>optional field<br>possible values:<br><code>chat_gpt</code>, <code>google</code><br><strong>Note:</strong> data specific to brand entities is available for <code>chat_gpt</code> only;<br><strong>Note #2:</strong><code>chat_gpt</code> data is available for the <code>United States</code> and <code>English</code> only'
          nullable: true
        filters:
          type: array
          items:
            type: object
            nullable: true
          description: '<em>array of results filtering parameters</em><br>optional field<br><strong>you can add several filters at once (8 filters maximum)</strong><br>you should set a logical operator <code>and</code>, <code>or</code> between the conditions<br>the following operators are supported:<br><code>=</code>, <code>&lt;&gt;</code>, <code>in</code>, <code>not_in</code>, <code>like</code>, <code>not_like</code>, <code>ilike</code>, <code>not_ilike</code>, <code>match</code>, <code>not_match</code><br>you can use the <code>%</code> operator with <code>like</code> and <code>not_like</code> to match any string of zero or more characters<br>example:<br><code>["ai_search_volume","&gt;",1000]</code><p>The full list of possible filters is available <a href="/v3/ai_optimization/llm_mentions/filters/" rel="noopener noreferrer" target="_blank">here.</a>'
          nullable: true
        initial_dataset_filters:
          type: array
          items:
            type: object
            nullable: true
          description: '<em>array of filter expressions applied before aggregation</em><br>optional field<br>you can use this array to filter expressions applied to the raw mentions database before aggregation to limit the rows contributing to the result;<p><strong>you can add several filters at once (8 filters maximum)</strong><br>you should set a logical operator <code>and</code>, <code>or</code> between the conditions<br>the following operators are supported:<br><code>=</code>, <code>&lt;&gt;</code>, <code>in</code>, <code>not_in</code>, <code>like</code>, <code>not_like</code>, <code>ilike</code>, <code>not_ilike</code>, <code>match</code>, <code>not_match</code><br>you can use the <code>%</code> operator with <code>like</code> and <code>not_like</code> to match any string of zero or more characters<br>example:<br><code>["ai_search_volume","&gt;",1000]</code><p>the full list of possible filters is available <a href="/v3/ai_optimization/llm_mentions/filters" rel="noopener noreferrer" target="_blank">here.</a><br>learn more about the initial dataset filters in <a href="https://dataforseo.com/help-center/what-are-the-initial-dataset-filters-and-how-do-they-work" rel="noopener noreferrer" target="_blank">this help center article.</a>'
          nullable: true
        limit:
          type: integer
          description: '<em>maximum number of results in the items array</em><br>optional field<br>you can use this parameter to limit the number of data objects you receive in the <code>items</code> array<br>minimum value: <code>1</code><br>maximum value: <code>1000</code><br>default value: <code>100</code>'
          nullable: true
        internal_list_limit:
          type: integer
          description: '<em>maximum number of elements within internal arrays</em><br>optional field<br>you can use this field to limit the number of elements within the following arrays:<br><code>sources_domain</code>, <code>search_results_domain</code>, <code>brand_entities_title</code>, <code>brand_entities_category</code><br>minimum value: <code>1</code><br>maximum value: <code>10</code><br>default value: <code>5</code>'
          nullable: true
        order_by:
          type: array
          items:
            type: string
          description: '<em>results sorting rules</em><br>optional field<br>you can use the same values as in the <code>filters</code> array to sort the results<br>possible sorting types:<br><code>asc</code> - results will be sorted in the ascending order<br><code>desc</code> - results will be sorted in the descending order<br>you should use a comma to set up a sorting type<br>example:<br><code>["ai_search_volume,desc"]</code><br><strong>Note:</strong> you can set no more than three sorting rules in a single request<br>you should use a comma to separate several sorting rules'
          nullable: true
        offset:
          type: integer
          description: '<em>offset in the results array of the returned mentions data</em><br>optional field<p>default value: <code>0</code><br>example: if you specify the <code>10</code> value, the first ten mentions objects in the results array will be omitted and the data will be provided for the successive objects;<br><strong>Note:</strong> the maximum value is <code>1000000</code>'
          nullable: true
        include_brand_categories:
          type: array
          items:
            type: string
          description: '<em>array of brand_categories to include in the response</em><br>optional field<br>if specified, only the listed brand categories will be returned in the <code>items</code> array<br>example:<br><code>"include_brand_categories": ["business"]</code>'
          nullable: true
        exclude_brand_categories:
          type: array
          items:
            type: string
          description: '<em>array of brand categories to exclude from the response</em><br>optional field<br>if specified, the listed brand categories will be omitted from the <code>items</code> array<br>example:<br><code>"exclude_brand_categories": ["business"]</code>'
          nullable: true
        tag:
          type: string
          description: <em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response
          nullable: true
      example:
        - language_code: en
          location_code: 2840
          platform: chat_gpt
          target:
            - keyword: bmw
              search_scope:
                - answer
            - keyword: auto
              search_scope:
                - question
              match_type: partial_match
          initial_dataset_filters:
            - 
              - ai_search_volume
              - '>'
              - 10
          limit: 3
          internal_list_limit: 2
    AiOptimizationLlmMentionsTopMentionedBrandCategoriesLiveItem:
      type: object
      properties:
        brand_category:
          type: string
          description: <em>brand category</em><br>brand category found in LLM mentions for the specified target
          nullable: true
        location:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/AggregatedMetricsItemInfo'
            nullable: true
          description: <em>location-based grouping</em><br>array of objects containing mention metrics segmented by geographical location
          nullable: true
        language:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/AggregatedMetricsItemInfo'
            nullable: true
          description: <em>language-based grouping</em><br>array of objects containing mention metrics segmented by content language
          nullable: true
        platform:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/AggregatedMetricsItemInfo'
            nullable: true
          description: <em>platform-based grouping</em><br>array of group elements containing mention metrics segmented by AI platform
          nullable: true
        sources_domain:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/AggregatedMetricsItemInfo'
            nullable: true
          description: <em>found top source domains relevant to the target</em><br>array of objects containing data on top domains that are cited as sources in LLM responses<br>learn more about the sources and how to retrieve LLM citation data at our <a href="https://dataforseo.com/help-center/how-to-get-llm-citation-data-with-llm-mentions-api" target="_blank">Help Center</a>
          nullable: true
        search_results_domain:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/AggregatedMetricsItemInfo'
            nullable: true
          description: <em>found top search results domains relevant to the target</em><br>array of objects containing data on top domains that appear in search results related to LLM queries
          nullable: true
        brand_entities_title:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/AggregatedMetricsItemInfo'
            nullable: true
          description: <em>data on brand entities relevant to the target</em><br>array of objects containing data on brand entity titles that appear in search results related to LLM queries
          nullable: true
        brand_entities_category:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/AggregatedMetricsItemInfo'
            nullable: true
          description: <em>data on brand entities relevant to the target</em><br>array of objects containing data on brand entity categories that appear in search results related to LLM queries
          nullable: true
        total:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AggregatedMetricsInfoTotalInfo'
          description: <em>aggregated mentions metrics summary</em><br>contains overall aggregated LLM mention metrics across all dimensions
          nullable: true
    AiOptimizationLlmMentionsTopMentionedBrandCategoriesLiveResultInfo:
      type: object
      properties:
        total_count:
          type: integer
          description: <em>total amount of results relevant the request</em>
          format: int64
          nullable: true
        offset:
          type: integer
          description: <em>the number of mentions objects that are omitted in the <code>items</code> array</em>
          nullable: true
        items_count:
          type: integer
          description: <em>the number of results returned in the <code>items</code> array</em>
          format: int64
          nullable: true
        aggregated_metrics:
          type: object
          oneOf:
            - $ref: '#/components/schemas/LlmMentionsAggregatedMetricsInfo'
          description: '<em>aggregated mentions metrics</em><br>contains aggregated LLM mention metrics across all found brand categories, grouped by various dimensions'
          nullable: true
        items:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/AiOptimizationLlmMentionsTopMentionedBrandCategoriesLiveItem'
            nullable: true
          description: <em>individual brand categories results</em><br>array containing detailed mention metrics for each of the found brand categories
          nullable: true
    AiOptimizationLlmMentionsTopMentionedBrandCategoriesLiveTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AiOptimizationLlmMentionsTopMentionedBrandCategoriesLiveResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    AiOptimizationLlmMentionsTopMentionedBrandCategoriesLiveResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AiOptimizationLlmMentionsTopMentionedBrandCategoriesLiveTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    AiOptimizationLlmMentionsTargetMetricsLiteLiveRequestInfo:
      type: object
      properties:
        target:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/BaseAiOptimizationLLmMentionsTargetElement'
            nullable: true
          description: "array of objects containing target entities\nrequired field\nyou can specify up to 10 entities (objects) in the target field\none target entity can contain either one domain or one keyword and related parameters\nexamples:\n\ntarget array with a domain entity"
          nullable: true
        location_name:
          type: string
          description: '<em>full name of search location</em><br>optional field<br>if you use this field, you don''t need to specify <code>location_code</code><br>if you don''t specify this field, the <code>location_code</code> with <code class="long-string">2840</code> value will be used by default;<br>you can receive the list of available locations of the search engine with their <code>location_name</code> by making a separate request to the <code>https://api.dataforseo.com/v3/ai_optimization/llm_mentions/locations_and_languages</code><br><strong>Note: <code>chat_gpt</code> data is available for <code class="long-string">United States</code> only'
          nullable: true
        location_code:
          type: integer
          description: '<em>search location code</em><br>optional field<br>if you use this field, you don''t need to specify <code>location_name</code><br>you can receive the list of available locations of the search engine with their <code>location_code</code> by making a separate request to the <code>https://api.dataforseo.com/v3/ai_optimization/llm_mentions/locations_and_languages</code><br>default value: <code class="long-string">2840</code><br><strong>Note: <code>chat_gpt</code> data is available for <code class="long-string">2840</code> only'
          nullable: true
        language_name:
          type: string
          description: '<em>full name of search language</em><br>optional field<br>if you use this field, you don''t need to specify <code>language_code</code>;<br>if you don''t specify this field, the <code>language_code</code> with <code class="long-string">en</code> value will be used by default;<br>you can receive the list of available languages of the search engine with their <code>language_name</code> by making a separate request to the <code>https://api.dataforseo.com/v3/ai_optimization/llm_mentions/locations_and_languages</code><br><strong>Note: <code>chat_gpt</code> data is available for <code class="long-string">English</code> only'
          nullable: true
        language_code:
          type: string
          description: '<em>search language code</em><br>optional field<br>if you use this field, you don''t need to specify <code>language_name</code>;<br>you can receive the list of available languages of the search engine with their <code>language_code</code> by making a separate request to the <code>https://api.dataforseo.com/v3/ai_optimization/llm_mentions/locations_and_languages</code><br>default value: <code class="long-string">en</code><br><strong>Note: <code>chat_gpt</code> data is available for <code class="long-string">en</code> only'
          nullable: true
        platform:
          type: string
          description: '<em>target platform</em><br>optional field<br>possible values:<br><code>chat_gpt</code>, <code>google</code><br><strong>Note:</strong> if the <code>platform</code> is not specified, the data is returned for both platforms<br><strong>Note #2:</strong><code>chat_gpt</code> data is available for the <code>United States</code> and <code>English</code> only'
          nullable: true
        initial_dataset_filters:
          type: array
          items:
            type: object
            nullable: true
          description: '<em>array of filter expressions applied before aggregation</em><br>optional field<br>you can use this array to filter expressions applied to the raw mentions database before aggregation to limit the rows contributing to the result;<p><strong>you can add several filters at once (8 filters maximum)</strong><br>you should set a logical operator <code>and</code>, <code>or</code> between the conditions<br>the following operators are supported:<br><code>=</code>, <code>&lt;&gt;</code>, <code>in</code>, <code>not_in</code>, <code>like</code>, <code>not_like</code>, <code>ilike</code>, <code>not_ilike</code>, <code>match</code>, <code>not_match</code><br>you can use the <code>%</code> operator with <code>like</code> and <code>not_like</code> to match any string of zero or more characters<br>example:<br><code>["ai_search_volume","&gt;",1000]</code><p>the full list of possible filters is available <a href="/v3/ai_optimization/llm_mentions/filters" rel="noopener noreferrer" target="_blank">here.</a><br>learn more about the initial dataset filters in <a href="https://dataforseo.com/help-center/what-are-the-initial-dataset-filters-and-how-do-they-work" rel="noopener noreferrer" target="_blank">this help center article.</a>'
          nullable: true
        limit:
          type: integer
          description: '<em>maximum number of results in the items array</em><br>optional field<br>you can use this parameter to limit the number of data objects you receive in the <code>items</code> array<br>minimum value: <code>1</code><br>maximum value: <code>1000</code><br>default value: <code>100</code>'
          nullable: true
        order_by:
          type: array
          items:
            type: string
          description: '<em>results sorting rules</em><br>optional field<br>you can use the same values as in the <code>filters</code> array to sort the results<br>possible sorting types:<br><code>asc</code> - results will be sorted in the ascending order<br><code>desc</code> - results will be sorted in the descending order<br>you should use a comma to set up a sorting type<br>example:<br><code>["ai_search_volume,desc"]</code><br><strong>note that you can set no more than three sorting rules in a single request</strong><br>you should use a comma to separate several sorting rules'
          nullable: true
        offset:
          type: integer
          description: '<em>offset in the results array of the returned mentions data</em><br>optional field<p>default value: <code>0</code><br>example: if you specify the <code>10</code> value, the first ten mentions objects in the results array will be omitted and the data will be provided for the successive objects;<br><strong>Note:</strong> the maximum value is <code>1000000</code>'
          nullable: true
        tag:
          type: string
          description: <em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response
          nullable: true
      example:
        - language_code: es
          location_code: 2840
          platform: google
          target:
            - domain: en.wikipedia.org
              search_filter: exclude
            - keyword: bmw
              search_scope:
                - answer
          initial_dataset_filters:
            - 
              - ai_search_volume
              - '>'
              - 10
          limit: 6
    AiOptimizationLlmMentionsTargetMetricsLiteLiveItem:
      type: object
      properties:
        location:
          type: integer
          description: <em>location identifier</em><br>location of aggregated metrics
          nullable: true
        language:
          type: string
          description: <em>language identifier</em><br>language of aggregated metrics
          nullable: true
        platform:
          type: string
          description: <em>LLM platform identifiers</em><br>LLM platform of aggregated metrics
          nullable: true
        metrics:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AggregatedMetricsInfoTotalInfo'
          description: <em>LLM metrics</em><br>metrics aggregated by specific parameters and respective identifiers
          nullable: true
    AiOptimizationLlmMentionsTargetMetricsLiteLiveResultInfo:
      type: object
      properties:
        total_count:
          type: integer
          description: <em>total amount of results relevant the request</em>
          format: int64
          nullable: true
        offset:
          type: integer
          description: <em>the number of mentions objects that are omitted in the <code>items</code> array</em>
          nullable: true
        items_count:
          type: integer
          description: <em>the number of results returned in the <code>items</code> array</em>
          format: int64
          nullable: true
        aggregated_metrics:
          type: object
          description: '<em>aggregated mentions metrics</em><br>in this case, always returns <code>null</code>'
          nullable: true
        items:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/AiOptimizationLlmMentionsTargetMetricsLiteLiveItem'
            nullable: true
          description: <em>array of aggregated mentions metrics</em><br>contains objects with aggregated mention metrics for the specified target
          nullable: true
    AiOptimizationLlmMentionsTargetMetricsLiteLiveTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AiOptimizationLlmMentionsTargetMetricsLiteLiveResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    AiOptimizationLlmMentionsTargetMetricsLiteLiveResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AiOptimizationLlmMentionsTargetMetricsLiteLiveTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    AiOptimizationLlmMentionsTopMentionedDomainsLiteLiveRequestInfo:
      type: object
      properties:
        target:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/BaseAiOptimizationLLmMentionsTargetElement'
            nullable: true
          description: "array of objects containing target entities\nrequired field\nyou can specify up to 10 entities (objects) in the target field\none target entity can contain either one domain or one keyword and related parameters\nexamples:\n\ntarget array with a domain entity"
          nullable: true
        location_name:
          type: string
          description: '<em>full name of search location</em><br>optional field<br>if you use this field, you don''t need to specify <code>location_code</code><br>if you don''t specify this field, the <code>location_code</code> with <code class="long-string">2840</code> value will be used by default;<br>you can receive the list of available locations of the search engine with their <code>location_name</code> by making a separate request to the <code>https://api.dataforseo.com/v3/ai_optimization/llm_mentions/locations_and_languages</code><br><strong>Note: <code>chat_gpt</code> data is available for <code class="long-string">United States</code> only'
          nullable: true
        location_code:
          type: integer
          description: '<em>search location code</em><br>optional field<br>if you use this field, you don''t need to specify <code>location_name</code><br>you can receive the list of available locations of the search engine with their <code>location_code</code> by making a separate request to the <code>https://api.dataforseo.com/v3/ai_optimization/llm_mentions/locations_and_languages</code><br>default value: <code class="long-string">2840</code><br><strong>Note: <code>chat_gpt</code> data is available for <code class="long-string">2840</code> only'
          nullable: true
        language_name:
          type: string
          description: '<em>full name of search language</em><br>optional field<br>if you use this field, you don''t need to specify <code>language_code</code>;<br>if you don''t specify this field, the <code>language_code</code> with <code class="long-string">en</code> value will be used by default;<br>you can receive the list of available languages of the search engine with their <code>language_name</code> by making a separate request to the <code>https://api.dataforseo.com/v3/ai_optimization/llm_mentions/locations_and_languages</code><br><strong>Note: <code>chat_gpt</code> data is available for <code class="long-string">English</code> only'
          nullable: true
        language_code:
          type: string
          description: '<em>search language code</em><br>optional field<br>if you use this field, you don''t need to specify <code>language_name</code>;<br>you can receive the list of available languages of the search engine with their <code>language_code</code>_by making a separate request to the <code>https://api.dataforseo.com/v3/ai_optimization/llm_mentions/locations_and_languages</code><br>default value: <code class="long-string">en</code><br><strong>Note: <code>chat_gpt</code> data is available for <code class="long-string">en</code> onlyn'
          nullable: true
        platform:
          type: string
          description: '<em>target platform</em><br>optional field<br>possible values:<br><code>chat_gpt</code>, <code>google</code><br>default value: <code class="long-string">google</code><br><strong>Note:</strong> if the <code>platform</code> is not specified, the data is returned for both platforms<br><strong>Note #2:</strong><code>chat_gpt</code> data is available for the <code>United States</code> and <code>English</code> only'
          nullable: true
        links_scope:
          type: string
          description: '<em>links source scope</em><br>optional field<br>this parameter specifies which links will be used to extract domains and aggregation data<br>possible values: <code>sources</code>, <code>search_results</code><br>default value: <code>sources</code>;<br><strong>Note:</strong> if you specify <code>search_results</code>, the data will be available for <code>chat_gpt</code> only'
          nullable: true
        filters:
          type: array
          items:
            type: object
            nullable: true
          description: '<em>array of results filtering parameters</em><br>optional field<br><strong>you can add several filters at once (8 filters maximum)</strong><br>you should set a logical operator <code>and</code>, <code>or</code> between the conditions<br>the following operators are supported:<br><code>=</code>, <code>&lt;&gt;</code>, <code>in</code>, <code>not_in</code>, <code>like</code>, <code>not_like</code>, <code>ilike</code>, <code>not_ilike</code>, <code>match</code>, <code>not_match</code><br>you can use the <code>%</code> operator with <code>like</code> and <code>not_like</code> to match any string of zero or more characters<br>example:<br><code>["ai_search_volume","&gt;",1000]</code><p>The full list of possible filters is available <a href="/v3/ai_optimization/llm_mentions/filters/" rel="noopener noreferrer" target="_blank">here.</a>'
          nullable: true
        initial_dataset_filters:
          type: array
          items:
            type: object
            nullable: true
          description: '<em>array of filter expressions applied before aggregation</em><br>optional field<br>you can use this array to filter expressions applied to the raw mentions database before aggregation to limit the rows contributing to the result;<p><strong>you can add several filters at once (8 filters maximum)</strong><br>you should set a logical operator <code>and</code>, <code>or</code> between the conditions<br>the following operators are supported:<br><code>=</code>, <code>&lt;&gt;</code>, <code>in</code>, <code>not_in</code>, <code>like</code>, <code>not_like</code>, <code>ilike</code>, <code>not_ilike</code>, <code>match</code>, <code>not_match</code><br>you can use the <code>%</code> operator with <code>like</code> and <code>not_like</code> to match any string of zero or more characters<br>example:<br><code>["ai_search_volume","&gt;",1000]</code><p>the full list of possible filters is available <a href="/v3/ai_optimization/llm_mentions/filters" rel="noopener noreferrer" target="_blank">here.</a><br>learn more about the initial dataset filters in <a href="https://dataforseo.com/help-center/what-are-the-initial-dataset-filters-and-how-do-they-work" rel="noopener noreferrer" target="_blank">this help center article.</a>'
          nullable: true
        limit:
          type: integer
          description: '<em>maximum number of results in the items array</em><br>optional field<br>you can use this parameter to limit the number of data objects you receive in the <code>items</code> array<br>minimum value: <code>1</code><br>maximum value: <code>1000</code><br>default value: <code>100</code>'
          nullable: true
        internal_list_limit:
          type: integer
          description: '<em>maximum number of elements within internal arrays</em><br>optional field<br>you can use this field to limit the number of elements within the following arrays:<br><code>sources_domain</code>, <code>search_results_domain</code>, <code>brand_entities_title</code>, <code>brand_entities_category</code><br>minimum value: <code>1</code><br>maximum value: <code>10</code><br>default value: <code>5</code>'
          nullable: true
        order_by:
          type: array
          items:
            type: string
          description: '<em>results sorting rules</em><br>optional field<br>you can use the same values as in the <code>filters</code> array to sort the results<br>possible sorting types:<br><code>asc</code> - results will be sorted in the ascending order<br><code>desc</code> - results will be sorted in the descending order<br>you should use a comma to set up a sorting type<br>example:<br><code>["ai_search_volume,desc"]</code><br><strong>Note:</strong> you can set no more than three sorting rules in a single request<br>you should use a comma to separate several sorting rules'
          nullable: true
        offset:
          type: integer
          description: '<em>offset in the results array of the returned mentions data</em><br>optional field<p>default value: <code>0</code><br>example: if you specify the <code>10</code> value, the first ten mentions objects in the results array will be omitted and the data will be provided for the successive objects;<br><strong>Note:</strong> the maximum value is <code>1000000</code>'
          nullable: true
        include_domains:
          type: array
          items:
            type: string
          description: '<em>array of domains to include in the response</em><br>optional field<br>if specified, only the listed domains will be returned in the <code>items</code> array<br>example:<br><code>["dataforseo.com","seoinsider.com"]</code>'
          nullable: true
        exclude_domains:
          type: array
          items:
            type: string
          description: '<em>array of domains to exclude from the response</em><br>optional field<br>if specified, the listed domains will be omitted from the <code>items</code> array<br>example:<br><code>["google.com","bing.com"]</code>'
          nullable: true
        tag:
          type: string
          description: <em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response
          nullable: true
      example:
        - language_code: en
          location_code: 2840
          platform: chat_gpt
          target:
            - keyword: bmw
              search_scope:
                - answer
            - keyword: auto
              search_scope:
                - question
              match_type: partial_match
          links_scope: sources
          initial_dataset_filters:
            - 
              - ai_search_volume
              - '>'
              - 10
          limit: 3
          internal_list_limit: 2
    AiOptimizationLlmMentionsTopMentionedDomainsLiteLiveItem:
      type: object
      properties:
        domain:
          type: string
          description: <em>domain name</em><br>domain of aggregated metrics
          nullable: true
        location:
          type: integer
          description: <em>location identifier</em><br>location of aggregated metrics
          nullable: true
        language:
          type: string
          description: <em>language identifier</em><br>language of aggregated metrics
          nullable: true
        platform:
          type: string
          description: <em>LLM platform identifiers</em><br>LLM platform of aggregated metrics
          nullable: true
        metrics:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AggregatedMetricsInfoTotalInfo'
          description: <em>LLM metrics</em><br>metrics aggregated by specific parameters and respective identifiers
          nullable: true
    AiOptimizationLlmMentionsTopMentionedDomainsLiteLiveResultInfo:
      type: object
      properties:
        total_count:
          type: integer
          description: <em>total number of results</em>
          format: int64
          nullable: true
        offset:
          type: integer
          description: <em>offset in the results array of the returned mentions data</em><br><code>offset</code> specified in the reqest
          nullable: true
        items_count:
          type: integer
          description: <em>number of items in the results array</em>
          format: int64
          nullable: true
        aggregated_metrics:
          type: object
          description: '<em>aggregated mentions metrics summary</em><br>contains overall aggregated LLM mention metrics across all found domains, grouped by various dimensions</br>in this case, the value will be <code>null</code>'
          nullable: true
        items:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/AiOptimizationLlmMentionsTopMentionedDomainsLiteLiveItem'
            nullable: true
          description: <em>contains relevant mentions data</em>
          nullable: true
    AiOptimizationLlmMentionsTopMentionedDomainsLiteLiveTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AiOptimizationLlmMentionsTopMentionedDomainsLiteLiveResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    AiOptimizationLlmMentionsTopMentionedDomainsLiteLiveResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AiOptimizationLlmMentionsTopMentionedDomainsLiteLiveTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    AiOptimizationLlmMentionsTopMentionedPagesLiteLiveRequestInfo:
      type: object
      properties:
        target:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/BaseAiOptimizationLLmMentionsTargetElement'
            nullable: true
          description: "array of objects containing target entities\nrequired field\nyou can specify up to 10 entities (objects) in the target field\none target entity can contain either one domain or one keyword and related parameters\nexamples:\n\ntarget array with a domain entity"
          nullable: true
        location_name:
          type: string
          description: '<em>full name of search location</em><br>optional field<br>if you use this field, you don''t need to specify <code>location_code</code><br>if you don''t specify this field, the <code>location_code</code> with <code class="long-string">2840</code> value will be used by default;<br>you can receive the list of available locations of the search engine with their <code>location_name</code> by making a separate request to the <code>https://api.dataforseo.com/v3/ai_optimization/llm_mentions/locations_and_languages</code><br><strong>Note: <code>chat_gpt</code> data is available for <code class="long-string">United States</code> only'
          nullable: true
        location_code:
          type: integer
          description: '<em>search location code</em><br>optional field<br>if you use this field, you don''t need to specify <code>location_name</code><br>you can receive the list of available locations of the search engine with their <code>location_code</code> by making a separate request to the <code>https://api.dataforseo.com/v3/ai_optimization/llm_mentions/locations_and_languages</code><br>default value: <code class="long-string">2840</code><br><strong>Note: <code>chat_gpt</code> data is available for <code class="long-string">2840</code> only'
          nullable: true
        language_name:
          type: string
          description: '<em>full name of search language</em><br>optional field<br>if you use this field, you don''t need to specify <code>language_code</code>;<br>if you don''t specify this field, the <code>language_code</code> with <code class="long-string">en</code> value will be used by default;<br>you can receive the list of available languages of the search engine with their <code>language_name</code> by making a separate request to the <code>https://api.dataforseo.com/v3/ai_optimization/llm_mentions/locations_and_languages</code><br><strong>Note: <code>chat_gpt</code> data is available for <code class="long-string">English</code> only'
          nullable: true
        language_code:
          type: string
          description: '<em>search language code</em><br>optional field<br>if you use this field, you don''t need to specify <code>language_name</code>;<br>you can receive the list of available languages of the search engine with their <code>language_code</code> by making a separate request to the <code>https://api.dataforseo.com/v3/ai_optimization/llm_mentions/locations_and_languages</code><br>default value: <code class="long-string">en</code><br><strong>Note: <code>chat_gpt</code> data is available for <code class="long-string">en</code> only'
          nullable: true
        platform:
          type: string
          description: '<em>target platform</em><br>optional field<br>possible values:<br><code>chat_gpt</code>, <code>google</code><br>default value: <code class="long-string">google</code><br><strong>Note:</strong> if the <code>platform</code> is not specified, the data is returned for both platforms<br><strong>Note #2:</strong><code>chat_gpt</code> data is available for the <code>United States</code> and <code>English</code> only'
          nullable: true
        links_scope:
          type: string
          description: '<em>links source scope</em><br>optional field<br>this parameter specifies which links will be used to extract domains and aggregation data<br>possible values: <code>sources</code>, <code>search_results</code><br>default value: <code>sources</code>; ;<br><strong>Note:</strong> if you specify <code>search_results</code>, the data will be available for <code>chat_gpt</code> only'
          nullable: true
        filters:
          type: array
          items:
            type: object
            nullable: true
          description: '<em>array of results filtering parameters</em><br>optional field<br><strong>you can add several filters at once (8 filters maximum)</strong><br>you should set a logical operator <code>and</code>, <code>or</code> between the conditions<br>the following operators are supported:<br><code>=</code>, <code>&lt;&gt;</code>, <code>in</code>, <code>not_in</code>, <code>like</code>, <code>not_like</code>, <code>ilike</code>, <code>not_ilike</code>, <code>match</code>, <code>not_match</code><br>you can use the <code>%</code> operator with <code>like</code> and <code>not_like</code> to match any string of zero or more characters<br>example:<br><code>["ai_search_volume","&gt;",1000]</code><p>The full list of possible filters is available <a href="/v3/ai_optimization/llm_mentions/filters/" rel="noopener noreferrer" target="_blank">here.</a>'
          nullable: true
        initial_dataset_filters:
          type: array
          items:
            type: object
            nullable: true
          description: '<em>array of filter expressions applied before aggregation</em><br>optional field<br>you can use this array to filter expressions applied to the raw mentions database before aggregation to limit the rows contributing to the result;<p><strong>you can add several filters at once (8 filters maximum)</strong><br>you should set a logical operator <code>and</code>, <code>or</code> between the conditions<br>the following operators are supported:<br><code>=</code>, <code>&lt;&gt;</code>, <code>in</code>, <code>not_in</code>, <code>like</code>, <code>not_like</code>, <code>ilike</code>, <code>not_ilike</code>, <code>match</code>, <code>not_match</code><br>you can use the <code>%</code> operator with <code>like</code> and <code>not_like</code> to match any string of zero or more characters<br>example:<br><code>["ai_search_volume","&gt;",1000]</code><p>the full list of possible filters is available <a href="/v3/ai_optimization/llm_mentions/filters" rel="noopener noreferrer" target="_blank">here.</a><br>learn more about the initial dataset filters in <a href="https://dataforseo.com/help-center/what-are-the-initial-dataset-filters-and-how-do-they-work" rel="noopener noreferrer" target="_blank">this help center article.</a>'
          nullable: true
        limit:
          type: integer
          description: '<em>maximum number of results in the items array</em><br>optional field<br>you can use this parameter to limit the number of data objects you receive in the <code>items</code> array<br>minimum value: <code>1</code><br>maximum value: <code>1000</code><br>default value: <code>100</code>'
          nullable: true
        internal_list_limit:
          type: integer
          description: '<em>maximum number of elements within internal arrays</em><br>optional field<br>you can use this field to limit the number of elements within the following arrays:<br><code>sources_domain</code>, <code>search_results_domain</code>, <code>brand_entities_title</code>, <code>brand_entities_category</code><br>minimum value: <code>1</code><br>maximum value: <code>10</code><br>default value: <code>5</code>'
          nullable: true
        order_by:
          type: array
          items:
            type: string
          description: '<em>results sorting rules</em><br>optional field<br>you can use the same values as in the <code>filters</code> array to sort the results<br>possible sorting types:<br><code>asc</code> - results will be sorted in the ascending order<br><code>desc</code> - results will be sorted in the descending order<br>you should use a comma to set up a sorting type<br>example:<br><code>["ai_search_volume,desc"]</code><br><strong>Note:</strong> you can set no more than three sorting rules in a single request<br>you should use a comma to separate several sorting rules'
          nullable: true
        offset:
          type: integer
          description: '<em>offset in the results array of the returned mentions data</em><br>optional field<p>default value: <code>0</code><br>example: if you specify the <code>10</code> value, the first ten mentions objects in the results array will be omitted and the data will be provided for the successive objects;<br><strong>Note:</strong> the maximum value is <code>1000000</code>'
          nullable: true
        include_pages:
          type: array
          items:
            type: string
          description: '<em>array of page URLs to include in the response</em><br>optional field<br>if specified, only the listed pages will be returned in the <code>items</code> array<br>example:<br>`["https://dataforseo.com/apis/ai-optimization-api/llm-mentions-api", "https://dataforseo.com/apis/ai-optimization-api"]`'
          nullable: true
        exclude_pages:
          type: array
          items:
            type: string
          description: '<em>array of page URLs to exclude from the response</em><br>optional field<br>if specified, the listed pages will be omitted from the <code>items</code> array<br>example:<br>`["https://dataforseo.com/apis/ai-optimization-api/llm-mentions-api", "https://dataforseo.com/apis/ai-optimization-api"]`'
          nullable: true
        tag:
          type: string
          description: <em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response
          nullable: true
      example:
        - language_code: en
          location_code: 2840
          platform: chat_gpt
          target:
            - keyword: bmw
              search_scope:
                - answer
            - keyword: auto
              search_scope:
                - question
              match_type: partial_match
          links_scope: sources
          initial_dataset_filters:
            - 
              - ai_search_volume
              - '>'
              - 10
          limit: 3
          internal_list_limit: 2
    AiOptimizationLlmMentionsTopMentionedPagesLiteLiveItem:
      type: object
      properties:
        page:
          type: string
          description: <em>page URL </em><br>page identifier of aggregated metrics
          nullable: true
        location:
          type: integer
          description: <em>location identifier</em><br>location of aggregated metrics
          nullable: true
        language:
          type: string
          description: <em>language identifier</em><br>language of aggregated metrics
          nullable: true
        platform:
          type: string
          description: <em>LLM platform identifiers</em><br>LLM platform of aggregated metrics
          nullable: true
        metrics:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AggregatedMetricsInfoTotalInfo'
          description: <em>LLM metrics</em><br>metrics aggregated by specific parameters and respective identifiers
          nullable: true
    AiOptimizationLlmMentionsTopMentionedPagesLiteLiveResultInfo:
      type: object
      properties:
        total_count:
          type: integer
          description: <em>total number of results</em>
          format: int64
          nullable: true
        offset:
          type: integer
          description: <em>offset in the results array of the returned mentions data</em><br><code>offset</code> specified in the request
          nullable: true
        items_count:
          type: integer
          description: <em>number of items in the results array</em>
          format: int64
          nullable: true
        aggregated_metrics:
          type: object
          description: '<em>aggregated mentions metrics summary</em><br>contains overall aggregated LLM mention metrics across all found domains, grouped by various dimensions</br>in this case, the value will be <code>null</code>'
          nullable: true
        items:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/AiOptimizationLlmMentionsTopMentionedPagesLiteLiveItem'
            nullable: true
          description: <em>contains relevant mentions data</em>
          nullable: true
    AiOptimizationLlmMentionsTopMentionedPagesLiteLiveTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AiOptimizationLlmMentionsTopMentionedPagesLiteLiveResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    AiOptimizationLlmMentionsTopMentionedPagesLiteLiveResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AiOptimizationLlmMentionsTopMentionedPagesLiteLiveTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    AiOptimizationLlmMentionsTopMentionedBrandsLiteLiveRequestInfo:
      type: object
      properties:
        target:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/BaseAiOptimizationLLmMentionsTargetElement'
            nullable: true
          description: "array of objects containing target entities\nrequired field\nyou can specify up to 10 entities (objects) in the target field\none target entity can contain either one domain or one keyword and related parameters\nexamples:\n\ntarget array with a domain entity"
          nullable: true
        location_name:
          type: string
          description: '<em>full name of search location</em><br>optional field<br>if you use this field, you don''t need to specify <code>location_code</code><br>if you don''t specify this field, the <code>location_code</code> with <code class="long-string">2840</code> value will be used by default;<br>you can receive the list of available locations of the search engine with their <code>location_name</code> by making a separate request to the <code>https://api.dataforseo.com/v3/ai_optimization/llm_mentions/locations_and_languages</code><br><strong>Note: <code>chat_gpt</code> data is available for <code class="long-string">United States</code> only'
          nullable: true
        location_code:
          type: integer
          description: '<em>search location code</em><br>optional field<br>if you use this field, you don''t need to specify <code>location_name</code><br>you can receive the list of available locations of the search engine with their <code>location_code</code> by making a separate request to the <code>https://api.dataforseo.com/v3/ai_optimization/llm_mentions/locations_and_languages</code><br>default value: <code class="long-string">2840</code><br><strong>Note: <code>chat_gpt</code> data is available for <code class="long-string">2840</code> only'
          nullable: true
        language_name:
          type: string
          description: '<em>full name of search language</em><br>optional field<br>if you use this field, you don''t need to specify <code>language_code</code>;<br>if you don''t specify this field, the <code>language_code</code> with <code class="long-string">en</code> value will be used by default;<br>you can receive the list of available languages of the search engine with their <code>language_name</code> by making a separate request to the <code>https://api.dataforseo.com/v3/ai_optimization/llm_mentions/locations_and_languages</code><br><strong>Note: <code>chat_gpt</code> data is available for <code class="long-string">English</code> only'
          nullable: true
        language_code:
          type: string
          description: '<em>search language code</em><br>optional field<br>if you use this field, you don''t need to specify <code>language_name</code>;<br>you can receive the list of available languages of the search engine with their <code>language_code</code> by making a separate request to the <code>https://api.dataforseo.com/v3/ai_optimization/llm_mentions/locations_and_languages</code><br>default value: <code class="long-string">en</code><br><strong>Note: <code>chat_gpt</code> data is available for <code class="long-string">en</code> only'
          nullable: true
        platform:
          type: string
          description: '<em>target platform</em><br>optional field<br>possible values:<br><code>chat_gpt</code>, <code>google</code><br>default value: <code class="long-string">google</code><br><strong>Note:</strong> data specific to brand entities is available for <code>chat_gpt</code> only;<br><strong>Note #2:</strong><code>chat_gpt</code> data is available for the <code>United States</code> and <code>English</code> only'
          nullable: true
        filters:
          type: array
          items:
            type: object
            nullable: true
          description: '<em>array of results filtering parameters</em><br>optional field<br><strong>you can add several filters at once (8 filters maximum)</strong><br>you should set a logical operator <code>and</code>, <code>or</code> between the conditions<br>the following operators are supported:<br><code>=</code>, <code>&lt;&gt;</code>, <code>in</code>, <code>not_in</code>, <code>like</code>, <code>not_like</code>, <code>ilike</code>, <code>not_ilike</code>, <code>match</code>, <code>not_match</code><br>you can use the <code>%</code> operator with <code>like</code> and <code>not_like</code> to match any string of zero or more characters<br>example:<br><code>["ai_search_volume","&gt;", 1000]</code><p>The full list of possible filters is available <a href="/v3/ai_optimization/llm_mentions/filters/" rel="noopener noreferrer" target="_blank">here.</a>'
          nullable: true
        initial_dataset_filters:
          type: array
          items:
            type: object
            nullable: true
          description: '<em>array of filter expressions applied before aggregation</em><br>optional field<br>you can use this array to filter expressions applied to the raw mentions database before aggregation to limit the rows contributing to the result;<p><strong>you can add several filters at once (8 filters maximum)</strong><br>you should set a logical operator <code>and</code>, <code>or</code> between the conditions<br>the following operators are supported:<br><code>=</code>, <code>&lt;&gt;</code>, <code>in</code>, <code>not_in</code>, <code>like</code>, <code>not_like</code>, <code>ilike</code>, <code>not_ilike</code>, <code>match</code>, <code>not_match</code><br>you can use the <code>%</code> operator with <code>like</code> and <code>not_like</code> to match any string of zero or more characters<br>example:<br><code>["ai_search_volume","&gt;",1000]</code><p>the full list of possible filters is available <a href="/v3/ai_optimization/llm_mentions/filters" rel="noopener noreferrer" target="_blank">here.</a><br>learn more about the initial dataset filters in <a href="https://dataforseo.com/help-center/what-are-the-initial-dataset-filters-and-how-do-they-work" rel="noopener noreferrer" target="_blank">this help center article.</a>'
          nullable: true
        limit:
          type: integer
          description: '<em>maximum number of results in the items array</em><br>optional field<br>you can use this parameter to limit the number of data objects you receive in the <code>items</code> array<br>minimum value: <code>1</code><br>maximum value: <code>1000</code><br>default value: <code>100</code>'
          nullable: true
        internal_list_limit:
          type: integer
          description: '<em>maximum number of elements within internal arrays</em><br>optional field<br>you can use this field to limit the number of elements within the following arrays:<br><code>sources_domain</code>, <code>search_results_domain</code>, <code>brand_entities_title</code>, <code>brand_entities_category</code><br>minimum value: <code>1</code><br>maximum value: <code>10</code><br>default value: <code>5</code>'
          nullable: true
        order_by:
          type: array
          items:
            type: string
          description: '<em>results sorting rules</em><br>optional field<br>you can use the same values as in the <code>filters</code> array to sort the results<br>possible sorting types:<br><code>asc</code> - results will be sorted in the ascending order<br><code>desc</code> - results will be sorted in the descending order<br>you should use a comma to set up a sorting type<br>example:<br><code>["ai_search_volume,desc"]</code><br><strong>Note:</strong> you can set no more than three sorting rules in a single request<br>you should use a comma to separate several sorting rules'
          nullable: true
        offset:
          type: integer
          description: '<em>offset in the results array of the returned mentions data</em><br>optional field<p>default value: <code>0</code><br>example: if you specify the <code>10</code> value, the first ten mentions objects in the results array will be omitted and the data will be provided for the successive objects;<br><strong>Note:</strong> the maximum value is <code>1000000</code>'
          nullable: true
        include_brands:
          type: array
          items:
            type: string
          description: '<em>array of brands to include in the response</em><br>optional field<br>if specified, only the listed brands will be returned in the <code>items</code> array<br>example:<br><code>["BMW","Audi"]</code>'
          nullable: true
        exclude_brands:
          type: array
          items:
            type: string
          description: '<em>array of brands to exclude from the response</em><br>optional field<br>if specified, the listed brands will be omitted from the <code>items</code> array<br>example:<br><code>["BMW","Audi"]</code>'
          nullable: true
        tag:
          type: string
          description: <em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response
          nullable: true
      example:
        - language_code: en
          location_code: 2840
          platform: chat_gpt
          target:
            - keyword: bmw
              search_scope:
                - answer
            - keyword: auto
              search_scope:
                - question
              match_type: partial_match
          initial_dataset_filters:
            - 
              - ai_search_volume
              - '>'
              - 10
          limit: 3
          internal_list_limit: 2
    AiOptimizationLlmMentionsTopMentionedBrandsLiteLiveItem:
      type: object
      properties:
        brand:
          type: string
          description: <em>brand name</em><br>brand identifier of aggregated metrics
          nullable: true
        location:
          type: integer
          description: <em>location identifier</em><br>location of aggregated metrics
          nullable: true
        language:
          type: string
          description: <em>language identifier</em><br>language of aggregated metrics
          nullable: true
        platform:
          type: string
          description: <em>LLM platform identifiers</em><br>LLM platform of aggregated metrics
          nullable: true
        metrics:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AggregatedMetricsInfoTotalInfo'
          description: <em>LLM metrics</em><br>metrics aggregated by specific parameters and respective identifiers
          nullable: true
    AiOptimizationLlmMentionsTopMentionedBrandsLiteLiveResultInfo:
      type: object
      properties:
        total_count:
          type: integer
          description: <em>total number of results</em>
          format: int64
          nullable: true
        offset:
          type: integer
          description: <em>offset in the results array of the returned mentions data</em><br><code>offset</code> specified in the reqest
          nullable: true
        items_count:
          type: integer
          description: <em>number of items in the results array</em>
          format: int64
          nullable: true
        aggregated_metrics:
          type: object
          description: '<em>aggregated mentions metrics summary</em><br>contains overall aggregated LLM mention metrics across all found domains, grouped by various dimensions</br>in this case, the value will be <code>null</code>'
          nullable: true
        items:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/AiOptimizationLlmMentionsTopMentionedBrandsLiteLiveItem'
            nullable: true
          description: <em>contains relevant mentions data</em>
          nullable: true
    AiOptimizationLlmMentionsTopMentionedBrandsLiteLiveTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AiOptimizationLlmMentionsTopMentionedBrandsLiteLiveResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    AiOptimizationLlmMentionsTopMentionedBrandsLiteLiveResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AiOptimizationLlmMentionsTopMentionedBrandsLiteLiveTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    AiOptimizationLlmMentionsTopMentionedBrandCategoriesLiteLiveRequestInfo:
      type: object
      properties:
        target:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/BaseAiOptimizationLLmMentionsTargetElement'
            nullable: true
          description: "array of objects containing target entities\nrequired field\nyou can specify up to 10 entities (objects) in the target field\none target entity can contain either one domain or one keyword and related parameters\nexamples:\n\ntarget array with a domain entity"
          nullable: true
        location_name:
          type: string
          description: '<em>full name of search location</em><br>optional field<br>if you use this field, you don''t need to specify <code>location_code</code><br>if you don''t specify this field, the <code>location_code</code> with <code class="long-string">2840</code> value will be used by default;<br>you can receive the list of available locations of the search engine with their <code>location_name</code> by making a separate request to the <code>https://api.dataforseo.com/v3/ai_optimization/llm_mentions/locations_and_languages</code><br><strong>Note: <code>chat_gpt</code> data is available for <code class="long-string">United States</code> only'
          nullable: true
        location_code:
          type: integer
          description: '<em>search location code</em><br>optional field<br>if you use this field, you don''t need to specify <code>location_name</code><br>you can receive the list of available locations of the search engine with their <code>location_code</code> by making a separate request to the <code>https://api.dataforseo.com/v3/ai_optimization/llm_mentions/locations_and_languages</code><br>default value: <code class="long-string">2840</code><br><strong>Note: <code>chat_gpt</code> data is available for <code class="long-string">2840</code> only'
          nullable: true
        language_name:
          type: string
          description: '<em>full name of search language</em><br>optional field<br>if you use this field, you don''t need to specify <code>language_code</code>;<br>if you don''t specify this field, the <code>language_code</code> with <code class="long-string">en</code> value will be used by default;<br>you can receive the list of available languages of the search engine with their <code>language_name</code> by making a separate request to the <code>https://api.dataforseo.com/v3/ai_optimization/llm_mentions/locations_and_languages</code><br><strong>Note: <code>chat_gpt</code> data is available for <code class="long-string">English</code> only'
          nullable: true
        language_code:
          type: string
          description: '<em>search language code</em><br>optional field<br>if you use this field, you don''t need to specify <code>language_name</code>;<br>you can receive the list of available languages of the search engine with their <code>language_code</code> by making a separate request to the <code>https://api.dataforseo.com/v3/ai_optimization/llm_mentions/locations_and_languages</code><br>default value: <code class="long-string">en</code><br><strong>Note: <code>chat_gpt</code> data is available for <code class="long-string">en</code> only'
          nullable: true
        platform:
          type: string
          description: '<em>target platform</em><br>optional field<br>possible values:<br><code>chat_gpt</code>, <code>google</code><br>default value: <code class="long-string">google</code><br><strong>Note:</strong> data specific to brand entities is available for <code>chat_gpt</code> only;<br><strong>Note #2:</strong><code>chat_gpt</code> data is available for the <code>United States</code> and <code>English</code> only'
          nullable: true
        filters:
          type: array
          items:
            type: object
            nullable: true
          description: '<em>array of results filtering parameters</em><br>optional field<br><strong>you can add several filters at once (8 filters maximum)</strong><br>you should set a logical operator <code>and</code>, <code>or</code> between the conditions<br>the following operators are supported:<br><code>=</code>, <code>&lt;&gt;</code>, <code>in</code>, <code>not_in</code>, <code>like</code>, <code>not_like</code>, <code>ilike</code>, <code>not_ilike</code>, <code>match</code>, <code>not_match</code><br>you can use the <code>%</code> operator with <code>like</code> and <code>not_like</code> to match any string of zero or more characters<br>example:<br><code>["ai_search_volume","&gt;",1000]</code><p>The full list of possible filters is available <a href="/v3/ai_optimization/llm_mentions/filters/" rel="noopener noreferrer" target="_blank">here.</a>'
          nullable: true
        initial_dataset_filters:
          type: array
          items:
            type: object
            nullable: true
          description: '<em>array of filter expressions applied before aggregation</em><br>optional field<br>you can use this array to filter expressions applied to the raw mentions database before aggregation to limit the rows contributing to the result;<p><strong>you can add several filters at once (8 filters maximum)</strong><br>you should set a logical operator <code>and</code>, <code>or</code> between the conditions<br>the following operators are supported:<br><code>=</code>, <code>&lt;&gt;</code>, <code>in</code>, <code>not_in</code>, <code>like</code>, <code>not_like</code>, <code>ilike</code>, <code>not_ilike</code>, <code>match</code>, <code>not_match</code><br>you can use the <code>%</code> operator with <code>like</code> and <code>not_like</code> to match any string of zero or more characters<br>example:<br><code>["ai_search_volume","&gt;",1000]</code><p>the full list of possible filters is available <a href="/v3/ai_optimization/llm_mentions/filters" rel="noopener noreferrer" target="_blank">here.</a><br>learn more about the initial dataset filters in <a href="https://dataforseo.com/help-center/what-are-the-initial-dataset-filters-and-how-do-they-work" rel="noopener noreferrer" target="_blank">this help center article.</a>'
          nullable: true
        limit:
          type: integer
          description: '<em>maximum number of results in the items array</em><br>optional field<br>you can use this parameter to limit the number of data objects you receive in the <code>items</code> array<br>minimum value: <code>1</code><br>maximum value: <code>1000</code><br>default value: <code>100</code>'
          nullable: true
        internal_list_limit:
          type: integer
          description: '<em>maximum number of elements within internal arrays</em><br>optional field<br>you can use this field to limit the number of elements within the following arrays:<br><code>sources_domain</code>, <code>search_results_domain</code>, <code>brand_entities_title</code>, <code>brand_entities_category</code><br>minimum value: <code>1</code><br>maximum value: <code>10</code><br>default value: <code>5</code>'
          nullable: true
        order_by:
          type: array
          items:
            type: string
          description: '<em>results sorting rules</em><br>optional field<br>you can use the same values as in the <code>filters</code> array to sort the results<br>possible sorting types:<br><code>asc</code> - results will be sorted in the ascending order<br><code>desc</code> - results will be sorted in the descending order<br>you should use a comma to set up a sorting type<br>example:<br><code>["ai_search_volume,desc"]</code><br><strong>Note:</strong> you can set no more than three sorting rules in a single request<br>you should use a comma to separate several sorting rules'
          nullable: true
        offset:
          type: integer
          description: '<em>offset in the results array of the returned mentions data</em><br>optional field<p>default value: <code>0</code><br>example: if you specify the <code>10</code> value, the first ten mentions objects in the results array will be omitted and the data will be provided for the successive objects;<br><strong>Note:</strong> the maximum value is <code>1000000</code>'
          nullable: true
        include_brand_categories:
          type: array
          items:
            type: string
          description: '<em>array of brand categories to include in the response</em><br>optional field<br>if specified, only the listed brand categories will be returned in the <code>items</code> array<br>example:<br><code>["company","insurance"]</code>'
          nullable: true
        exclude_brand_categories:
          type: array
          items:
            type: string
          description: '<em>array of brand categories to exclude from the response</em><br>optional field<br>if specified, the listed brand categories will be omitted from the <code>items</code> array<br>example:<br><code>["company","insurance"]</code>'
          nullable: true
        tag:
          type: string
          description: <em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response
          nullable: true
      example:
        - language_code: en
          location_code: 2840
          platform: chat_gpt
          target:
            - keyword: bmw
              search_scope:
                - answer
            - keyword: auto
              search_scope:
                - question
              match_type: partial_match
          initial_dataset_filters:
            - 
              - ai_search_volume
              - '>'
              - 10
          limit: 3
          internal_list_limit: 2
    AiOptimizationLlmMentionsTopMentionedBrandCategoriesLiteLiveItem:
      type: object
      properties:
        brand_category:
          type: string
          description: <em>brand category</em><br>brand category identifier of aggregated metrics
          nullable: true
        location:
          type: integer
          description: <em>location identifier</em><br>location of aggregated metrics
          nullable: true
        language:
          type: string
          description: <em>language identifier</em><br>language of aggregated metrics
          nullable: true
        platform:
          type: string
          description: <em>LLM platform identifiers</em><br>LLM platform of aggregated metrics
          nullable: true
        metrics:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AggregatedMetricsInfoTotalInfo'
          description: <em>LLM metrics</em><br>metrics aggregated by specific parameters and respective identifiers
          nullable: true
    AiOptimizationLlmMentionsTopMentionedBrandCategoriesLiteLiveResultInfo:
      type: object
      properties:
        total_count:
          type: integer
          description: <em>total number of results</em>
          format: int64
          nullable: true
        offset:
          type: integer
          description: <em>offset in the results array of the returned mentions data</em><br><code>offset</code> specified in the request
          nullable: true
        items_count:
          type: integer
          description: <em>number of items in the results array</em>
          format: int64
          nullable: true
        aggregated_metrics:
          type: object
          description: '<em>aggregated mentions metrics summary</em><br>contains overall aggregated LLM mention metrics across all found domains, grouped by various dimensions</br>in this case, the value will be <code>null</code>'
          nullable: true
        items:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/AiOptimizationLlmMentionsTopMentionedBrandCategoriesLiteLiveItem'
            nullable: true
          description: <em>contains relevant mentions data</em>
          nullable: true
    AiOptimizationLlmMentionsTopMentionedBrandCategoriesLiteLiveTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AiOptimizationLlmMentionsTopMentionedBrandCategoriesLiteLiveResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    AiOptimizationLlmMentionsTopMentionedBrandCategoriesLiteLiveResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AiOptimizationLlmMentionsTopMentionedBrandCategoriesLiteLiveTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    AiOptimizationLlmMentionsHistoricalLiveRequestInfo:
      type: object
      properties:
        target:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/BaseAiOptimizationLLmMentionsTargetElement'
            nullable: true
          description: "array of objects containing target entities\nrequired field\nyou can specify up to 10 entities (objects) in the target field\none target entity can contain either one domain or one keyword and related parameters\nexamples:\n\ntarget array with a domain entity"
          nullable: true
        date_from:
          type: string
          description: <em>start date of the time range</em><br>optional field<br>minimal value <code>2025-08-01</code><br>date format <code>"yyyy-mm-dd"</code>
          nullable: true
        date_to:
          type: string
          description: <em>end date of the time range</em><br>optional field<br><strong>Note</strong> value specified in <code>date_from</code> cannot exceed the value in <code>date_to</code><br>date format <code>"yyyy-mm-dd"</code>
          nullable: true
        location_name:
          type: string
          description: '<em>full name of search location</em><br>optional field<br>if you use this field, you don''t need to specify <code>location_code</code><br>if you don''t specify this field, the <code>location_code</code> with <code class="long-string">2840</code> value will be used by default;<br>you can receive the list of available locations of the search engine with their <code>location_name</code> by making a separate request to the <code>https://api.dataforseo.com/v3/ai_optimization/llm_mentions/locations_and_languages</code><br><strong>Note:</strong> <code>chat_gpt</code> data is available for <code class="long-string">United States</code> only'
          nullable: true
        location_code:
          type: integer
          description: '<em>search location code</em><br>optional field<br>if you use this field, you don''t need to specify <code>location_name</code><br>you can receive the list of available locations of the search engine with their <code>location_code</code> by making a separate request to the <code>https://api.dataforseo.com/v3/ai_optimization/llm_mentions/locations_and_languages</code><br>default value: <code class="long-string">2840</code><br><strong>Note: <code>chat_gpt</code> data is available for <code class="long-string">2840</code> only'
          nullable: true
        language_name:
          type: string
          description: '<em>full name of search language</em><br>optional field<br>if you use this field, you don''t need to specify <code>language_code</code>;<br>if you don''t specify this field, the <code>language_code</code> with <code class="long-string">en</code> value will be used by default;<br>you can receive the list of available languages of the search engine with their <code>language_name</code> by making a separate request to the <code>https://api.dataforseo.com/v3/ai_optimization/llm_mentions/locations_and_languages</code><br><strong>Note: <code>chat_gpt</code> data is available for <code class="long-string">English</code> only'
          nullable: true
        language_code:
          type: string
          description: '<em>search language code</em><br>optional field<br>if you use this field, you don''t need to specify <code>language_name</code>;<br>you can receive the list of available languages of the search engine with their <code>language_code</code> by making a separate request to the <code>https://api.dataforseo.com/v3/ai_optimization/llm_mentions/locations_and_languages</code><br>default value: <code class="long-string">en</code><br><strong>Note: <code>chat_gpt</code> data is available for <code class="long-string">en</code> only'
          nullable: true
        platform:
          type: string
          description: '<em>target platform</em><br>optional field<br>possible values:<br><code>chat_gpt</code>, <code>google</code><br><strong>Note:</strong> if the <code>platform</code> is not specified, the data is returned for both platforms<br><strong>Note #2:</strong><code>chat_gpt</code> data is available for the <code>United States</code> and <code>English</code> only'
          nullable: true
        tag:
          type: string
          description: <em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response
          nullable: true
      example:
        - language_code: es
          location_code: 2840
          platform: google
          target:
            - domain: en.wikipedia.org
              search_filter: exclude
            - keyword: bmw
              search_scope:
                - answer
    AiOptimizationLlmMentionsHistoricalLiveItem:
      type: object
      properties:
        year:
          type: integer
          description: <em>year</em>
          nullable: true
        month:
          type: integer
          description: <em>month</em>
          nullable: true
        metrics:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AggregatedMetricsInfoTotalInfo'
          description: <em>aggregated mentions metrics for the given month of a year</em>
          nullable: true
    AiOptimizationLlmMentionsHistoricalLiveResultInfo:
      type: object
      properties:
        items_count:
          type: integer
          description: <em>the number of resuts returned in the <code>items</code> array</em><br>
          format: int64
          nullable: true
        items:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/AiOptimizationLlmMentionsHistoricalLiveItem'
            nullable: true
          description: <em>array of historical mention metrics</em><br>contains objects with historical mention metrics for the specified target<br>each object contains aggregated mentions metrics for one calendar month
          nullable: true
    AiOptimizationLlmMentionsHistoricalLiveTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AiOptimizationLlmMentionsHistoricalLiveResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    AiOptimizationLlmMentionsHistoricalLiveResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AiOptimizationLlmMentionsHistoricalLiveTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    AiOptimizationLlmMentionsTimeseriesDeltaLiveRequestInfo:
      type: object
      properties:
        target:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/BaseAiOptimizationLLmMentionsTargetElement'
            nullable: true
          description: "array of objects containing target entities\nrequired field\nyou can specify up to 10 entities (objects) in the target field\none target entity can contain either one domain or one keyword and related parameters\nexamples:\n\ntarget array with a domain entity"
          nullable: true
        date_from:
          type: string
          description: '<em>start date of the time range</em><br><strong>required field</strong><br>minimal value: <code>2025-08-01</code><br>date format: <code>"yyyy-mm-dd"</code>'
        date_to:
          type: string
          description: '<em>end date of the time range</em><br><strong>required field</strong><br><strong>Note:</strong>the value specified in <code>date_from</code> cannot exceed the value in <code>date_to</code><br>date format: <code>"yyyy-mm-dd"</code>'
        group_range:
          type: string
          description: '<em>timeseries delta range</em><br><strong>required field</strong><br>possible values:<br><code>day</code>, <code>week</code>, <code>month</code>, <code>year</code>'
        location_name:
          type: string
          description: '<em>full name of search location</em><br>optional field<br>if you use this field, you don''t need to specify <code>location_code</code><br>if you don''t specify this field, the <code>location_code</code> with <code class="long-string">2840</code> value will be used by default;<br>you can receive the list of available locations of the search engine with their <code>location_name</code> by making a separate request to the <code>https://api.dataforseo.com/v3/ai_optimization/llm_mentions/locations_and_languages</code><br><strong>Note: <code>chat_gpt</code> data is available for <code class="long-string">United States</code> only'
          nullable: true
        location_code:
          type: integer
          description: '<em>search location code</em><br>optional field<br>if you use this field, you don''t need to specify <code>location_name</code><br>you can receive the list of available locations of the search engine with their <code>location_code</code> by making a separate request to the <code>https://api.dataforseo.com/v3/ai_optimization/llm_mentions/locations_and_languages</code><br>default value: <code class="long-string">2840</code><br><strong>Note: <code>chat_gpt</code> data is available for <code class="long-string">2840</code> only'
          nullable: true
        language_name:
          type: string
          description: '<em>full name of search language</em><br>optional field<br>if you use this field, you don''t need to specify <code>language_code</code>;<br>if you don''t specify this field, the <code>language_code</code> with <code class="long-string">en</code> value will be used by default;<br>you can receive the list of available languages of the search engine with their <code>language_name</code> by making a separate request to the <code>https://api.dataforseo.com/v3/ai_optimization/llm_mentions/locations_and_languages</code><br><strong>Note: <code>chat_gpt</code> data is available for <code class="long-string">English</code> only'
          nullable: true
        language_code:
          type: string
          description: '<em>search language code</em><br>optional field<br>if you use this field, you don''t need to specify <code>language_name</code>;<br>you can receive the list of available languages of the search engine with their <code>language_code</code> by making a separate request to the <code>https://api.dataforseo.com/v3/ai_optimization/llm_mentions/locations_and_languages</code><br>default value: <code class="long-string">en</code><br><strong>Note: <code>chat_gpt</code> data is available for <code class="long-string">en</code> only'
          nullable: true
        platform:
          type: string
          description: '<em>target platform</em><br>optional field<br>possible values:<br><code>chat_gpt</code>, <code>google</code><br>default value: <code class="long-string">google</code><br><strong>Note:</strong> if the <code>platform</code> is not specified, the data is returned for both platforms<br><strong>Note #2:</strong><code>chat_gpt</code> data is available for the <code>United States</code> and <code>English</code> only'
          nullable: true
        tag:
          type: string
          description: <em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response
          nullable: true
      example:
        - language_name: English
          location_code: 2840
          target:
            - domain: dataforseo.com
              search_filter: exclude
            - keyword: bmw
              search_scope:
                - answer
          platform: google
          date_from: '2025-08-01'
          date_to: '2025-12-01'
          group_range: month
    AiOptimizationLlmMentionsTimeseriesDeltaLiveItem:
      type: object
      properties:
        date:
          type: string
          description: '<em>date timestamp</em><br> date format: <code>"yyyy-mm-dd"</code>'
          nullable: true
        delta_mentions:
          type: integer
          description: <em>LLM mentions count delta</em><br>the difference in <code>mentions</code> between the current timestamp and the previous one
          nullable: true
        delta_ai_search_volume:
          type: integer
          description: <em>LLM mentions count delta</em><br>the difference in <code>ai_search_volume</code> values between the current timestamp and the previous one<br>learn more about this metric <a href="https://dataforseo.com/help-center/how-ai-search-volume-metrics-work-in-the-llm-mentions-timeseries-endpoints" rel="noopener noreferrer" target="_blank">here</a>
          format: int64
          nullable: true
    AiOptimizationLlmMentionsTimeseriesDeltaLiveResultInfo:
      type: object
      properties:
        items_count:
          type: integer
          description: <em>the number of results returned in the <code>items</code> array</em>
          format: int64
          nullable: true
        items:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/AiOptimizationLlmMentionsTimeseriesDeltaLiveItem'
            nullable: true
          description: <em>contains relevant LLM mentions timeseries data</em>
          nullable: true
    AiOptimizationLlmMentionsTimeseriesDeltaLiveTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AiOptimizationLlmMentionsTimeseriesDeltaLiveResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    AiOptimizationLlmMentionsTimeseriesDeltaLiveResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AiOptimizationLlmMentionsTimeseriesDeltaLiveTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    AiOptimizationLlmMentionsTimeseriesNewLostLiveRequestInfo:
      type: object
      properties:
        target:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/BaseAiOptimizationLLmMentionsTargetElement'
            nullable: true
          description: "array of objects containing target entities\nrequired field\nyou can specify up to 10 entities (objects) in the target field\none target entity can contain either one domain or one keyword and related parameters\nexamples:\n\ntarget array with a domain entity"
          nullable: true
        date_from:
          type: string
          description: '<em>start date of the time range</em><br><strong>required field</strong><br>minimal value: <code>2025-08-01</code><br>date format: <code>"yyyy-mm-dd"</code>'
        date_to:
          type: string
          description: '<em>end date of the time range</em><br><strong>required field</strong><br><strong>Note:</strong>the value specified in <code>date_from</code> cannot exceed the value in <code>date_to</code><br>date format: <code>"yyyy-mm-dd"</code>'
        group_range:
          type: string
          description: '<em>timeseries range</em><br><strong>required field</strong><br>possible values:<br><code>day</code>, <code>week</code>, <code>month</code>, <code>year</code>'
        location_name:
          type: string
          description: '<em>full name of search location</em><br>optional field<br>if you use this field, you don''t need to specify <code>location_code</code><br>if you don''t specify this field, the <code>location_code</code> with <code class="long-string">2840</code> value will be used by default;<br>you can receive the list of available locations of the search engine with their <code>location_name</code> by making a separate request to the <code>https://api.dataforseo.com/v3/ai_optimization/llm_mentions/locations_and_languages</code><br><strong>Note: <code>chat_gpt</code> data is available for <code class="long-string">United States</code> only'
          nullable: true
        location_code:
          type: integer
          description: '<em>search location code</em><br>optional field<br>if you use this field, you don''t need to specify <code>location_name</code><br>you can receive the list of available locations of the search engine with their <code>location_code</code> by making a separate request to the <code>https://api.dataforseo.com/v3/ai_optimization/llm_mentions/locations_and_languages</code><br>default value: <code class="long-string">2840</code><br><strong>Note: <code>chat_gpt</code> data is available for <code class="long-string">2840</code> only'
          nullable: true
        language_name:
          type: string
          description: '<em>full name of search language</em><br>optional field<br>if you use this field, you don''t need to specify <code>language_code</code>;<br>if you don''t specify this field, the <code>language_code</code> with <code class="long-string">en</code> value will be used by default;<br>you can receive the list of available languages of the search engine with their <code>language_name</code> by making a separate request to the <code>https://api.dataforseo.com/v3/ai_optimization/llm_mentions/locations_and_languages</code><br><strong>Note: <code>chat_gpt</code> data is available for <code class="long-string">English</code> only'
          nullable: true
        language_code:
          type: string
          description: '<em>search language code</em><br>optional field<br>if you use this field, you don''t need to specify <code>language_name</code>;<br>you can receive the list of available languages of the search engine with their <code>language_code</code> by making a separate request to the <code>https://api.dataforseo.com/v3/ai_optimization/llm_mentions/locations_and_languages</code><br>default value: <code class="long-string">en</code><br><strong>Note: <code>chat_gpt</code> data is available for <code class="long-string">en</code> only'
          nullable: true
        platform:
          type: string
          description: '<em>target platform</em><br>optional field<br>possible values:<br><code>chat_gpt</code>, <code>google</code><br>default value: <code class="long-string">google</code><br><strong>Note:</strong> if the <code>platform</code> is not specified, the data is returned for both platforms<br><strong>Note #2:</strong><code>chat_gpt</code> data is available for the <code>United States</code> and <code>English</code> only'
          nullable: true
        tag:
          type: string
          description: <em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response
          nullable: true
      example:
        - language_name: English
          location_code: 2840
          target:
            - domain: dataforseo.com
              search_filter: exclude
            - keyword: serp
              search_scope:
                - answer
          platform: google
          date_from: '2025-08-01'
          date_to: '2025-12-01'
          group_range: month
    AiOptimizationLlmMentionsTimeseriesNewLostLiveItem:
      type: object
      properties:
        date:
          type: string
          description: '<em>date timestamp</em><br> date format: <code>"yyyy-mm-dd"</code>'
          nullable: true
        new_mentions:
          type: integer
          description: '<em>new LLM mentions</em><br>indicates the LLM responses that contain the target at the <code>date_to</code> timestamp, did not contain it at the <code>date_from</code> timestamp'
          nullable: true
        lost_mentions:
          type: integer
          description: '<em>lost LLM mentions</em><br>indicates the LLM responses that contained the specified target at the <code>date_from</code> timestamp, do not contain it at the <code>date_to</code> timestamp'
          nullable: true
        new_ai_search_volume:
          type: integer
          description: <em>ai_search_volume increment</em><br>indicates the increase of <code>ai_search_volume</code> values between the current timestamp and the previous one<br>learn more about this metric <a href="https://dataforseo.com/help-center/how-ai-search-volume-metrics-work-in-the-llm-mentions-timeseries-endpoints" rel="noopener noreferrer" target="_blank">here</a>
          format: int64
          nullable: true
        lost_ai_search_volume:
          type: integer
          description: <em>ai_search_volume decrement</em><br>indicates the decrease of <code>ai_search_volume</code> values between the current timestamp and the previous one<br>learn more about this metric <a href="https://dataforseo.com/help-center/how-ai-search-volume-metrics-work-in-the-llm-mentions-timeseries-endpoints" rel="noopener noreferrer" target="_blank">here</a>
          format: int64
          nullable: true
    AiOptimizationLlmMentionsTimeseriesNewLostLiveResultInfo:
      type: object
      properties:
        items_count:
          type: integer
          description: <em>the number of results returned in the <code>items</code> array</em>
          format: int64
          nullable: true
        items:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/AiOptimizationLlmMentionsTimeseriesNewLostLiveItem'
            nullable: true
          description: <em>contains relevant LLM mentions timeseries data</em>
          nullable: true
    AiOptimizationLlmMentionsTimeseriesNewLostLiveTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AiOptimizationLlmMentionsTimeseriesNewLostLiveResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    AiOptimizationLlmMentionsTimeseriesNewLostLiveResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AiOptimizationLlmMentionsTimeseriesNewLostLiveTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    OnPageIdListRequestInfo:
      type: object
      properties:
        datetime_from:
          type: string
          description: '<em>start time for filtering results</em><br><strong>required field</strong><br>if <code>include_metadata</code> is set to <code>true</code>, maximum value: a month from current datetime;<br>if <code>include_metadata</code> is set to <code>false</code>, maximum value: six months from current datetime;<br>must be specified in the UTC format: "yyyy-mm-dd hh-mm-ss +00:00"<br>example:<br><code>2023-01-15 12:57:46 +00:00</code>'
        datetime_to:
          type: string
          description: '<em>finish time for filtering results</em><br><strong>required field</strong><br>maximum value: current datetime;<br>must be specified in the UTC format: "yyyy-mm-dd hh-mm-ss +00:00"<br>example:<br><code>2023-01-31 13:57:46 +00:00</code>'
        limit:
          type: integer
          description: '<em>the maximum number of returned task IDs</em><br>optional field<br>default value: <code>1000</code><br>maximum value: <code>1000</code>'
          nullable: true
        offset:
          type: integer
          description: '<em>offset in the results array of returned task IDs</em><br>optional field<br>default value: <code>0</code><br>if you specify the <code>10</code> value, the first ten tasks in the results array will be omitted'
          nullable: true
        sort:
          type: string
          description: '<em>sorting by task execution time</em><br>optional field<br>possible values: <code>"asc"</code>, <code>"desc"</code><br>default value: <code>"asc"</code>'
          nullable: true
        include_metadata:
          type: boolean
          description: '<em>include task metadata in the respond</em><br>optional field<br>default value: <code>false</code>'
          nullable: true
      example:
        - datetime_from: '2026-09-10 11:12:35'
          datetime_to: '2026-09-20 11:12:35'
          limit: 10
          include_metadata: true
    OnPageIdListResultInfo:
      type: object
      properties:
        id:
          type: string
          description: <em>task identifier</em><br><strong>unique task identifier in our system in the <a href="https://en.wikipedia.org/wiki/Universally_unique_identifier">UUID</a> format</strong>
          nullable: true
        url:
          type: string
          description: <em>URL of the task</em><br>URL you used for making an API call
          nullable: true
        datetime_posted:
          type: string
          description: '<em>date and time when the task was made</em><br>in the UTC format: "yyyy-mm-dd hh-mm-ss +00:00"<br>example:<br><code>2023-01-15 12:57:46 +00:00</code>'
          nullable: true
        datetime_done:
          type: string
          description: '<em>date and time when the task was completed</em><br>in the UTC format: "yyyy-mm-dd hh-mm-ss +00:00"<br>example:<br><code>2023-01-15 12:57:46 +00:00</code>'
          nullable: true
        status:
          type: string
          description: <em>informational message of the task</em><br>you can find the full list of general informational messages <a href="/v3/appendix-errors/">here</a>
          nullable: true
        cost:
          type: number
          description: '<em>total tasks cost, USD</em>'
          nullable: true
        metadata:
          type: object
          additionalProperties:
            type: object
            nullable: true
          description: <em>contains parameters you specified in the POST request</em>
          nullable: true
    OnPageIdListTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/OnPageIdListResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    OnPageIdListResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/OnPageIdListTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    OnPageErrorsRequestInfo:
      type: object
      properties:
        limit:
          type: integer
          description: '<em>the maximum number of returned tasks that responded with an error</em><br>optional field<br>default value: <code>1000</code><br>maximum value: <code>1000</code>'
          nullable: true
        offset:
          type: integer
          description: '<em>offset in the results array of returned tasks</em><br>optional field<br>default value: <code>0</code><br>if you specify the <code>10</code> value, the first ten tasks in the results array will be omitted and the data will be provided for the successive tasks'
          nullable: true
        filtered_function:
          type: string
          description: '<em>return tasks with a certain function</em><br>use this field to obtain a list of tasks that returned an error filtered by a certain function<br>you can filter the results by the values you receive in the <code>function</code> fields of the API response<br>i.e., once you receive unfiltered results, you can call this API again to filter them by <code>function</code> <br>example: <code>on_page/task_post</code>, <code>postback_url</code>, <code>pingback_url</code>'
          nullable: true
        datetime_from:
          type: string
          description: '<em>start time for filtering results</em><br>optional field<br>allows filtering results by the <code>datetime</code> parameter within the range of the last 7 days;<br>must be specified in the UTC format: "yyyy-mm-dd hh-mm-ss +00:00"<br>example:<br><code>2021-11-15 12:57:46 +00:00</code>'
          nullable: true
        datetime_to:
          type: string
          description: '<em>finish time for filtering results</em><br>optional field<br>allows filtering results by the <code>datetime</code> parameter within the range of the last 7 days;<br>must be specified in the UTC format: "yyyy-mm-dd hh-mm-ss +00:00"<br>example:<br><code>2021-11-15 13:57:46 +00:00</code>'
          nullable: true
      example:
        - limit: 10
          offset: 0
          filtered_function: pingback_url
    OnPageErrorsResultInfo:
      type: object
      properties:
        id:
          type: string
          description: <em>task identifier</em><br><strong>unique task identifier in our system in the <a href="https://en.wikipedia.org/wiki/Universally_unique_identifier">UUID</a> format</strong>
          nullable: true
        datetime:
          type: string
          description: '<em>date and time when an error occurred</em><br>in the UTC format: "yyyy-mm-dd hh-mm-ss +00:00"<br>example:<br><code>2019-11-15 12:57:46 +00:00</code>'
          nullable: true
        function:
          type: string
          description: <em>corresponding API function</em>
          nullable: true
        error_code:
          type: integer
          description: <em>error code</em>
          nullable: true
        error_message:
          type: string
          description: <em>error message or error URL</em><br>error message <a href="https://docs.dataforseo.com/v3/appendix/errors/" rel="noopener noreferrer" target="_blank">(see full list)</a> or URL that caused an error
          nullable: true
        http_url:
          type: string
          description: <em>URL that caused an error</em><br>URL you used for making an API call or pingback/postback URL
          nullable: true
        http_method:
          type: string
          description: <em>HTTP method</em>
          nullable: true
        http_code:
          type: integer
          description: <em>HTTP status code</em>
          nullable: true
        http_time:
          type: number
          description: '<em>time taken by HTTP request</em><br>for tasks set with a pingback/postback, this field will show the time it took your server to respond'
          nullable: true
        http_response:
          type: string
          description: <em>HTTP response</em><br>server response
          nullable: true
    OnPageErrorsTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/OnPageErrorsResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    OnPageErrorsResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/OnPageErrorsTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    OnPageForceStopRequestInfo:
      type: object
      properties:
        id:
          type: string
          description: '<em>ID of the task</em><br><strong>required field</strong><br>you can get this ID in the response of the <a href="/v3/on_page/task_post/">Task POST</a> endpoint<br>example:<br>"07131248-1535-0216-1000-17384017ad04"<p><strong>note</strong>: you can set up to 1000 <code>id</code> values as separate objects in the POST array'
      example:
        - id: 08121600-1535-0216-0000-37b4c7a34453
        - id: 08121600-1535-0216-0000-d6a5000b6897
    OnPageForceStopTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: object
              description: <em>array of results</em>
              nullable: true
    OnPageForceStopResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/OnPageForceStopTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    OnPageAvailableFiltersResultInfo:
      type: object
      properties:
        resources:
          type: object
          additionalProperties:
            type: string
            nullable: true
          nullable: true
        pages:
          type: object
          additionalProperties:
            type: string
            nullable: true
          nullable: true
        non_indexable:
          type: object
          additionalProperties:
            type: string
            nullable: true
          nullable: true
        links:
          type: object
          additionalProperties:
            type: string
            description: type of element
            nullable: true
          nullable: true
        pages_by_resource:
          type: object
          additionalProperties:
            type: string
            nullable: true
          nullable: true
        redirect_chains:
          type: object
          additionalProperties:
            type: string
            nullable: true
          nullable: true
        keyword_density:
          type: object
          additionalProperties:
            type: string
            nullable: true
          nullable: true
        uncrawlable_resources:
          type: object
          additionalProperties:
            type: string
            nullable: true
          nullable: true
    OnPageAvailableFiltersTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/OnPageAvailableFiltersResultInfo'
                nullable: true
              description: <em>array of results</em><br>contains the full list of available parameters that can be used for data filtration<br>the parameters are grouped by the endpoint they can be used with
              nullable: true
    OnPageAvailableFiltersResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/OnPageAvailableFiltersTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    OnPageTaskPostRequestInfo:
      type: object
      properties:
        target:
          type: string
          description: '<em>target domain</em><br><strong>required field</strong><br>domain name should be specified without <code>https://</code> and <code>www.</code><br>if you specify the page URL, the results will be returned for the domain included in the URL'
        max_crawl_pages:
          type: integer
          description: '<em>crawled pages limit</em><br><strong>required field</strong><br>the number of pages to crawl on the specified domain<br><strong>Note:</strong><br>if you set <code>max_crawl_pages</code> to 1 and do not specify <code>start_url</code> or set a homepage in it, the following sitewide checks will be disabled:<br><code>test_canonicalization</code>, <code>enable_www_redirect_check</code>, <code>test_hidden_server_signature</code>, <code>test_page_not_found</code>, <code>test_directory_browsing</code>, <code>test_https_redirect</code><br>to enable them anyway, set <code>force_sitewide_checks</code> to <code>true</code>if you set <code>max_crawl_pages</code> to 1 and specify <code>start_url</code> other than a homepage, all sitewide checks will be disabled;<br>to enable them anyway, set <code>force_sitewide_checks</code> to <code>true</code>'
        start_url:
          type: string
          description: '<em>the first url to crawl </em><br>optional field<br><strong>Note:</strong> you should specify an absolute URL<br>if you want to crawl a single page, specify its URL in this field and additionally set the <code>max_crawl_pages</code> parameter to <code>1</code><br>you can also use the <a href="/v3/on_page/instant_pages/?bash" target="_blank" rel="noopener noreferrer">live Instant Pages endpoint</a> to get page-specific data'
          nullable: true
        force_sitewide_checks:
          type: boolean
          description: '<em>enable sitewide checks when crawling a single page</em><br>optional field<br>set to <code>true</code> to get data on sitewide checks when crawling a single page;<br>default value: <code>false</code>'
          nullable: true
        priority_urls:
          type: array
          items:
            type: string
          description: '<em>urls to be crawled bypassing the queue</em><br>optional field<br>URLs specified in this array will be crawled in the first instance, bypassing the crawling queue;<br><strong>Note:</strong> you should specify the absolute URL;<br>you can specify up to <strong>20 URLs</strong>;<br>all URLs in the array must belong to the <code>target</code> domain;<br>subdomains will be ignored unless the <code>allow_subdomains</code> parameter is set to <code>true</code>example:<br>`"priority_urls": [<br>"https://dataforseo.com/apis/serp-api",<br>"https://dataforseo.com/contact"<br>]`'
          nullable: true
        max_crawl_depth:
          type: integer
          description: '<em>crawl depth</em><br>optional field<br>the linking depth of the pages to crawl;<br>for example, starting page of the crawl is level 0, pages that have links from that page are level 1, etc.'
          nullable: true
        crawl_delay:
          type: integer
          description: '<em>delay between hits, ms</em><br>optional field<br>the custom delay between crawler hits to the server<br>default value: <code>2000</code>'
          nullable: true
        store_raw_html:
          type: boolean
          description: '<em>store HTML of crawled pages</em><br>optional field<br>set to <code>true</code> if you want to get the HTML of the page using the <a href="/v3/on_page/raw_html/" target="_blank" rel="noopener noreferrer">OnPage Raw HTML endpoint</a><br>default value: <code>false</code>'
          nullable: true
        enable_content_parsing:
          type: boolean
          description: '<em>parse content on crawled pages</em><br>optional field<br>set to <code>true</code> to use the <a href="/v3/on_page/content_parsing/live/" target="_blank" rel="noopener noreferrer">OnPage Content Parsing endpoint</a><br>default value: <code>false</code>'
          nullable: true
        support_cookies:
          type: boolean
          description: '<em>support cookies on crawled pages</em><br>optional field<br>set to <code>true</code> to support cookies when crawling the pages<br>default value: <code>false</code>'
          nullable: true
        accept_language:
          type: string
          description: '<em>language header for accessing the website</em><br>optional field<br>all locale formats are supported (xx, xx-XX, xxx-XX, etc.)<br><strong>Note:</strong> if you do not specify this parameter, some websites may deny access; in this case, pages will be returned with the <code>"type":"broken</code> in the response array'
          nullable: true
        custom_robots_txt:
          type: string
          description: '<em>custom robots.txt settings</em><br>optional field<br>example: <code>Disallow: /directory1/</code>'
          nullable: true
        robots_txt_merge_mode:
          type: string
          description: '<em>merge with or override robots.txt settings</em><br>optional field<br>possible values: <code>merge</code>, <code>override</code>;<br>set to <code>override</code> if you want to ignore website crawling restrictions and other robots.txt settings<br>default value: <code>merge</code>;<br><strong>Note:</strong> if set to <code>override</code>, specify the <code>custom_robots_txt</code> parameter'
          nullable: true
        custom_user_agent:
          type: string
          description: '<em>custom user agent</em><br>optional field<br>custom user agent for crawling a website<br>example: <code>Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_5) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/83.0.4103.116 Safari/537.36<br></code><br>default value: <code>Mozilla/5.0 (compatible; RSiteAuditor)</code>'
          nullable: true
        browser_preset:
          type: string
          description: '<em>preset for browser screen parameters</em><br>optional field<br>if you use this field, you don''t need to indicate <code>browser_screen_width</code>, <code>browser_screen_height</code>, <code>browser_screen_scale_factor</code>possible values:<br><code>desktop</code>, <code>mobile</code>, <code>tablet</code><code>desktop</code> preset will apply the following values:<code>browser_screen_width: 1920</code><br><code>browser_screen_height: 1080</code><br><code>browser_screen_scale_factor: 1</code><code>mobile</code> preset will apply the following values:<code>browser_screen_width: 390</code><br><code>browser_screen_height: 844</code><br><code>browser_screen_scale_factor: 3</code><code>tablet</code> preset will apply the following values:<code>browser_screen_width: 1024</code><br><code>browser_screen_height: 1366</code><br><code>browser_screen_scale_factor: 2</code><br><strong>Note:</strong> to use this parameter, set <code>enable_javascript</code> or <code>enable_browser_rendering</code> to <code>true</code>'
          nullable: true
        browser_screen_width:
          type: integer
          description: '<em>browser screen width</em><br>optional field<br>you can set a custom browser screen width to perform audit for a particular device;<br>if you use this field, you don''t need to indicate <code>browser_preset</code> as it will be ignored;<br><strong>Note:</strong> to use this parameter, set <code>enable_javascript</code> or <code>enable_browser_rendering</code> to <code>true</code>minimum value, in pixels: <code>240</code><br>maximum value, in pixels: <code>9999</code>'
          format: int64
          nullable: true
        browser_screen_height:
          type: integer
          description: '<em>browser screen height</em><br>optional field<br>you can set a custom browser screen height to perform an audit for a particular device;<br>if you use this field, you don''t need to indicate <code>browser_preset</code> as it will be ignored;<br><strong>Note:</strong> to use this parameter, set <code>enable_javascript</code> or <code>enable_browser_rendering</code> to <code>true</code>minimum value, in pixels: <code>240</code><br>maximum value, in pixels: <code>9999</code>'
          nullable: true
        browser_screen_scale_factor:
          type: number
          description: '<em>browser screen scale factor</em><br>optional field<br>you can set a custom browser screen resolution ratio to perform audit for a particular device;<br>if you use this field, you don''t need to indicate <code>browser_preset</code> as it will be ignored;<br><strong>Note:</strong> to use this parameter, set <code>enable_javascript</code> or <code>enable_browser_rendering</code> to <code>true</code>minimum value: <code>0.5</code><br>maximum value: <code>3</code>'
          nullable: true
        respect_sitemap:
          type: boolean
          description: '<em>respect sitemap when crawling</em><br>optional field<br>set to <code>true</code> if you want to follow the order of pages indicated in the primary sitemap when crawling;<br>default value: <code>false</code><br><strong>Note:</strong> if set to <code>true</code>, the <code>click_depth</code> value in the API response will equal <code>0</code>;<br>the <code>max_crawl_depth</code> field of the request will be ignored, you can specify the number of pages to crawl using the <code>max_crawl_pages</code> parameter'
          nullable: true
        custom_sitemap:
          type: string
          description: '<em>custom sitemap url</em><br>optional field<br>the URL of the page where the alternative sitemap is located<br><strong>Note:</strong> if you want to use this parameter, <code>respect_sitemap</code> should be <code>true</code>'
          nullable: true
        crawl_sitemap_only:
          type: boolean
          description: '<em>crawl only pages indicated in the sitemap</em><br>optional field<br>set to <code>true</code> if you want to crawl only the pages indicated in the sitemap<br>if you set this parameter to <code>true</code> and do not specify <code>custom_sitemap</code>, we will crawl the default sitemap<br>default value: <code>false</code><br><strong>Note:</strong> if you want to use this parameter, <code>respect_sitemap</code> should be <code>true</code>'
          nullable: true
        load_resources:
          type: boolean
          description: '<em>load resources</em><br>optional field<br>set to <code>true</code> if you want to load image, stylesheets, scripts, and broken resources<br>default value: <code>false</code><br><strong>Note:</strong> if you use this parameter, additional charges will apply; learn more about the cost of tasks with this parameter <a href="https://dataforseo.com/help-center/cost-of-onpage-api-parameters" target="_blank" rel="noopener noreferrer">in our help article</a>; the cost can be calculated on the <a href="https://dataforseo.com/pricing/on-page/onpage-api" target="_blank" rel="noopener noreferrer">Pricing Page</a>'
          nullable: true
        enable_www_redirect_check:
          type: boolean
          description: '<em>check if the domain implemented the www redirection</em><br>optional field<br>set to <code>true</code> if you want to check if the requested domain implemented the www to non-www or non-www to www redirect;<br>default value: <code>false</code>'
          nullable: true
        enable_javascript:
          type: boolean
          description: '<em>load javascript on a page</em><br>optional field<br>set to <code>true</code> if you want to load the scripts available on a page<br>default value: <code>false</code><br><strong>Note:</strong> if you use this parameter, additional charges will apply; learn more about the cost of tasks with this parameter <a href="https://dataforseo.com/help-center/cost-of-onpage-api-parameters" target="_blank" rel="noopener noreferrer">in our help article</a>; the cost can be calculated on the <a href="https://dataforseo.com/pricing/on-page/onpage-api" target="_blank" rel="noopener noreferrer">Pricing Page</a>'
          nullable: true
        enable_xhr:
          type: boolean
          description: '<em>enable XMLHttpRequest on a page</em><br>optional field<br>set to <code>true</code> if you want our crawler to request data from a web server using the XMLHttpRequest object<br>default value: <code>false</code>;if you use this field, <code>enable_javascript</code> must be set to <code>true</code>;'
          nullable: true
        enable_browser_rendering:
          type: boolean
          description: '<em>emulate browser rendering to measure Core Web Vitals</em><br>optional field<br>by using this parameter you will be able to emulate a browser when loading a web page;<br><code>enable_browser_rendering</code> loads styles, images, fonts, animations, videos, and other resources on a page;<br>default value: <code>false</code><br>set to <code>true</code> to obtain Core Web Vitals (FID, CLS, LCP) metrics in the response;<br><strong>if you use this field, <code>enable_javascript</code>, and <code>load_resources</code> parameters must be set to <code>true</code></strong><br><strong>Note:</strong> if you use this parameter, additional charges will apply; learn more about the cost of tasks with this parameter <a href="https://dataforseo.com/help-center/cost-of-onpage-api-parameters" target="_blank" rel="noopener noreferrer">in our help article</a>; the cost can be calculated on the <a href="https://dataforseo.com/pricing/on-page/onpage-api" target="_blank" rel="noopener noreferrer">Pricing Page</a>'
          nullable: true
        disable_cookie_popup:
          type: boolean
          description: <em>disable the cookie popup</em><br>optional field<br>set to <code>true</code> if you want to disable the popup requesting cookie consent from the user;<br>default value:<br><code>false</code>
          nullable: true
        custom_js:
          type: string
          description: '<em>custom javascript</em><br>optional field<br><strong>Note</strong> that the execution time for the script you enter here should be 700 ms maximum, for example, you can use the following JS snippet to check if the website contains Google Tag Manager as a <code>scr</code> attribute:<br><code>let meta = { haveGoogleAnalytics: false, haveTagManager: false };rnfor (var i = 0; i &lt; document.scripts.length; i++) {rn let src = document.scripts[i].getAttribute("src");rn if (src != undefined) {rn if (src.indexOf("analytics.js") &gt;= 0)rn      meta.haveGoogleAnalytics = true;rntif (src.indexOf("gtm.js") &gt;= 0)rn      meta.haveTagManager = true;rn  }rn}rnmeta;</code>the returned value depends on what you specified in this field. For instance, if you specify the following script:<br>`meta = {}; meta.url = document.URL; meta.test = ''test''; meta;`<br>as a response you will receive the following data:<br>`"custom_js_response": {<br>"url": "https://dataforseo.com/",<br>"test": "test"<br>}`<br><strong>Note:</strong> the length of the script you enter must be no more than 2000 characters'
          nullable: true
        validate_micromarkup:
          type: boolean
          description: '<em>enable microdata validation</em><br>optional field<br>set to <code>true</code> if you want to use the <a href="/v3/on_page/microdata/" target="_blank" rel="noopener noreferrer">OnPage API Microdata endpoint</a><br>default value: <code>false</code>'
          nullable: true
        allow_subdomains:
          type: boolean
          description: '<em>include pages on subdomains</em><br>optional field<br>set to <code>true</code> if you want to crawl all subdomains of a target website<br>default value: <code>false</code>'
          nullable: true
        allowed_subdomains:
          type: array
          items:
            type: string
          description: '<em>subdomains to crawl</em><br>optional field<br>specify subdomains that you want to crawl<br>example: <code>["blog.site.com", "my.site.com", "shop.site.com"]</code><br><strong>Note:</strong> to use this parameter, the <code>allow_subdomains</code> parameter should be set to <code>false</code>;<br>otherwise, the content of <code>allowed_subdomains</code> field will be ignored and the results will be returned for all subdomains'
          nullable: true
        disallowed_subdomains:
          type: array
          items:
            type: string
          description: '<em>subdomains not to crawl</em><br>optional field<br>specify subdomains that you don''t want to crawl<br>example: <code>["status.site.com", "docs.site.com"]</code><br><strong>Note:</strong> to use this parameter, the <code>allow_subdomains</code> parameter should be set to <code>true</code>'
          nullable: true
        check_spell:
          type: boolean
          description: '<em>check spelling</em><br>optional field<br>set to <code>true</code> to check spelling on a website using <a href="http://hunspell.github.io/" target="_blank" rel="noopener noreferrer">Hunspell</a> library<br>default value: <code>false</code>'
          nullable: true
        check_spell_language:
          type: string
          description: '<em>language of the spell check</em><br>optional field<br>supported languages: ''hy'', ''eu'', ''bg'', ''ca'', ''hr'', ''cs'', ''da'', ''nl'', ''en'', ''eo'', ''et'', ''fo'', ''fa'', ''fr'', ''fy'', ''gl'', ''ka'', ''de'', ''el'', ''he'', ''hu'', ''is'', ''ia'', ''ga'', ''it'', ''rw'', ''la'', ''lv'', ''lt'', ''mk'', ''mn'', ''ne'', ''nb'', ''nn'', ''pl'', ''pt'', ''ro'', ''gd'', ''sr'', ''sk'', ''sl'', ''es'', ''sv'', ''tr'', ''tk'', ''uk'', ''vi''<br><strong>Note:</strong> if no language is specified, it will be set automatically based on page content'
          nullable: true
        check_spell_exceptions:
          type: array
          items:
            type: string
          description: '<em>words excluded from spell check</em><br>optional field<br>specify the words that you want to exclude from spell check<br>maximum word length: 100 characters<br>maximum amount of words: 1000<br>example: <code>"SERP", "minifiers", "JavaScript"</code>'
          nullable: true
        calculate_keyword_density:
          type: boolean
          description: '<em>calculate keyword density for the target domain</em><br>optional field<br>set to <code>true</code> if you want to calculate keyword density for website pages<br>default value: <code>false</code><br><strong>Note:</strong> if you use this parameter, additional charges will apply; learn more about the cost of tasks with this parameter <a href="https://dataforseo.com/help-center/cost-of-onpage-api-parameters" target="_blank" rel="noopener noreferrer">in our help article</a><br>once the crawl is completed, you can obtain keyword density values with <a href="/v3/on_page/keyword_density?bash" target="_blank" rel="noopener noreferrer">the Keyword Density endpoint</a>'
          nullable: true
        checks_threshold:
          type: object
          additionalProperties:
            type: integer
            format: int64
            nullable: true
          description: '<em>custom threshold values for checks</em><br>optional field<br>you can specify custom threshold values for the parameters included in the <code>checks</code> object of OnPage API responses;<br><strong>Note:</strong> only integer threshold values can be modified;<br>for example, the <code>high_loading_time</code> and <code>large_page_size</code> parameters are set to 3 seconds and 1 megabyte respectively by default;<br>if you want to change these thresholds to 1 second and 1000 kbytes, use the following snippet:<br>`"checks_threshold": {<br>"high_loading_time": 1,<br>"large_page_size": 1000<br>}`<br>available customizable parameters with default values:<br>`"title_too_short", default value: 30, type: "int"<br>"title_too_long", default value: 65, type: "int"<br>"small_page_size", default value: 1024, type: "int"<br>"large_page_size", default value: 1048576 (1024 * 1024), type: "int"<br>"low_character_count", default value: 1024, type: "int"<br>"high_character_count", default value: 256000 (250 * 1024), type: "int"<br>"low_content_rate", default value: 0.1, type: "float"<br>"high_content_rate", default value: 0.9, type: "float"<br>"high_loading_time", default value: 3000, type: "int"<br>"high_waiting_time", default value: 1500, type: "int"<br>"low_readability_rate", default value: 15.0, type: "float"<br>"irrelevant_description", default value: 0.2, type: "float"<br>"irrelevant_title", default value: 0.3, type: "float"<br>"irrelevant_meta_keywords", default value: 0.6, type: "float"`'
          nullable: true
        disable_sitewide_checks:
          type: array
          items:
            type: string
          description: '<em>prevent certain sitewide checks from running</em><br>optional field<br>specify the following <code>checks</code> to prevent them from running on the <code>target</code> website:<br><code>"test_page_not_found"</code><br><code>"test_canonicalization"</code><br><code>"test_https_redirect"</code><br><code>"test_directory_browsing"</code>example:<br><code>"disable_sitewide_checks": ["test_directory_browsing", "test_page_not_found"]</code>learn more on <a href="https://dataforseo.com/help-center/how-to-disable-sitewide-checks-in-onpage-api" target="_blank" rel="noopener noreferrer">our help center</a>'
          nullable: true
        disable_page_checks:
          type: array
          items:
            type: string
          description: '<em>prevent certain page checks from running</em><br>optional field<br>specify certain <code>checks</code> to prevent them from running and impacting the <code>onpage_score</code>example:<br><code>"disable_page_checks": ["is_5xx_code", "is_4xx_code"]</code>'
          nullable: true
        switch_pool:
          type: boolean
          description: '<em>switch proxy pool</em><br>optional field<br>if <code>true</code>, additional proxy pools will be used to obtain the requested data;<br>the parameter can be used if a multitude of tasks is set simultaneously, resulting in occasional <code>rate-limit</code> and/or <code>site_unreachable</code> errors'
          nullable: true
        return_despite_timeout:
          type: boolean
          description: '<em>return data on pages despite the timeout error</em><br>optional field<br>if <code>true</code>, the data will be provided on pages that failed to load within 120 seconds and responded with a timeout error;<br>default value: <code>false</code>'
          nullable: true
        tag:
          type: string
          description: <em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response
          nullable: true
        pingback_url:
          type: string
          description: '<em>notification URL of a completed task</em><br>optional field<br>when a task is completed we will notify you by GET request sent to the URL you have specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/pingscript?id=$id</code><br><code>http://your-server.com/pingscript?id=$id&amp;tag=$tag</code><br><strong>Note:</strong> special characters in <code>pingback_url</code> will be urlencoded;<br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href="https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api" target="_blank" rel="noopener noreferrer">Help Center</a>'
          nullable: true
      example:
        - target: dataforseo.com
          max_crawl_pages: 10
          load_resources: true
          enable_javascript: true
          custom_js: 'meta = {}; meta.url = document.URL; meta;'
          tag: some_string_123
          pingback_url: https://your-server.com/pingscript?id=$id&tag=$tag
    OnPageTaskPostTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: object
              description: '<em>array of results</em><br>in this case, the value will be <code>null</code>'
              nullable: true
    OnPageTaskPostResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/OnPageTaskPostTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    OnPageTasksReadyResultInfo:
      type: object
      properties:
        id:
          type: string
          description: <em>task identifier of the completed task</em><br><strong>unique task identifier in our system in the <a href="https://en.wikipedia.org/wiki/Universally_unique_identifier">UUID</a> format</strong>
          nullable: true
        target:
          type: string
          description: <em>target website specified when setting a task</em>
          nullable: true
        date_posted:
          type: string
          description: <em>date when the task was posted (in the UTC format)</em>
          nullable: true
        tag:
          type: string
          description: <em>user-defined task identifier</em>
          nullable: true
    OnPageTasksReadyTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/OnPageTasksReadyResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    OnPageTasksReadyResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/OnPageTasksReadyTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    SslInfo:
      type: object
      properties:
        valid_certificate:
          type: boolean
          description: '<em>ssl certificate validity</em><br>indicates whether the ssl certificate detected on a website is not expired, suspended, revoked or invalid'
          nullable: true
        certificate_issuer:
          type: string
          description: <em>ssl certificate authority</em><br>the entity that issued the detected ssl certificate
          nullable: true
        certificate_subject:
          type: string
          description: <em>ssl certificate subject</em><br>the entity associated with the public key
          nullable: true
        certificate_version:
          type: integer
          description: <em>ssl certificate version</em><br>indicates the version of <a href="https://en.wikipedia.org/wiki/X.509" target="_blank" rel="noopener noreferrer">X.509</a> used by an ssl certificate
          nullable: true
        certificate_hash:
          type: string
          description: <em>ssl certificate hash</em><br>the version of the ssl certificate's hash function
          nullable: true
        certificate_expiration_date:
          type: string
          description: '<em>ssl certificate expiration date</em><br>the date and time when the ssl certificate expires<br>in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”<br>example:<br><code class="long-string">2019-11-15 12:57:46 +00:00</code>'
          nullable: true
    DomainInfo:
      type: object
      properties:
        name:
          type: string
          description: <em>domain name</em>
          nullable: true
        cms:
          type: string
          description: '<em>content management system</em><br>content management system identified on a website<br>the content of_the <code>generator</code>_meta tag<br>the data is taken from the first random page that returns the 200 response code<br>if our crawler was unable to identify the cms, the value would be <code>null</code>n'
          nullable: true
        ip:
          type: string
          description: <em>domain ip address</em>
          nullable: true
        server:
          type: string
          description: <em>website server</em><br>the version of the server detected on a website<br>the content of the <code class="prettyprint">server</code> header<br>the information is taken from the first page which response code is 200
          nullable: true
        crawl_start:
          type: string
          description: '<em>time when the crawling start</em><br>date and time when the website was sent for crawling<br>in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”<br>example:<br><code class="long-string">2019-11-15 12:57:46 +00:00</code>'
          nullable: true
        crawl_end:
          type: string
          description: '<em>time when the crawling ended</em><br>date and time when the crawling was finished<br>in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”<br>example:<br><code class="long-string">2019-11-15 12:57:46 +00:00</code><br><strong>Note:</strong> informative only if <code>"crawl_progress"</code> is <code>"finished"</code><br>if <code>"crawl_progress"</code> is <code>in_progress</code>, the value will be <code>null</code>'
          nullable: true
        extended_crawl_status:
          type: string
          description: '<em>crawl status and errors</em><br>indicates the reason why a website was not crawled;<br>can take the following values:<br><code>no_errors</code> - no crawling errors were detected;<br><code>site_unreachable</code> - our crawler could not reach a website and thus was not able to obtain a status code;<br><code>invalid_page_status_code</code> - status code of the first crawled page &gt;= 400;<br><code>forbidden_meta_tag</code> - the first crawled page contains the &lt;meta robots="noindex"&gt; tag;<br><code>forbidden_robots</code> - robots.txt forbids crawling the page;<br><code>forbidden_http_header</code> - HTTP header of the page contains "X-Robots-Tag: noindex" ;<br><code>too_many_redirects</code> - the first crawled page has more than 10 redirects;<br><code>unknown</code> - the reason is unknown'
          nullable: true
        ssl_info:
          type: object
          oneOf:
            - $ref: '#/components/schemas/SslInfo'
          description: <em>ssl certificate info</em><br>information about the Secure Sockets Layer protocol detected on a website
          nullable: true
        checks:
          type: object
          additionalProperties:
            type: boolean
            nullable: true
          description: <em>website checks</em><br>other on-page check-ups related to the website
          nullable: true
        total_pages:
          type: integer
          description: <em>total crawled pages</em><br>the total number of crawled pages
          format: int64
          nullable: true
        total_uncrawlable_resources:
          type: integer
          description: <em>total uncrawlable resources</em><br>the total number of resources that could not be crawled;<br>the resource is considered uncrawlable when the actual content type of the resource doesn't match the content type expected by the crawler
          format: int64
          nullable: true
        page_not_found_status_code:
          type: integer
          description: '<em>status code returned by a non-existent page</em><br>in most cases, it is recommended a server returns a 404 response code'
          nullable: true
        canonicalization_status_code:
          type: integer
          description: '<em>status code returned by a canonicalized page</em><br>the checkup of the server behavior when our crawler tries to access the website via IP;<br>in most cases, it is recommended that canonicalized pages respond with a <code>301</code> or <code>302</code> status code'
          nullable: true
        directory_browsing_status_code:
          type: integer
          description: '<em>status code returned by a directory</em><br>the status code returned by a directory page on a target website<br>in most cases, it is recommended that directories respond with a <code>403</code> or <code>401</code> status code'
          nullable: true
        www_redirect_status_code:
          type: integer
          description: '<em>redirect status code</em><br>the status code of the www to non-www redirect<br>in most cases, it is recommended that redirect returns a <code>301</code> status code'
          nullable: true
        main_domain:
          type: string
          description: <em>root domain name</em>
          nullable: true
    PageMetrics:
      type: object
      properties:
        links_external:
          type: integer
          description: <em>number of external links</em><br>the number of links pointing to other websites
          nullable: true
        links_internal:
          type: integer
          description: <em>number of internal links</em><br>the number of links pointing to other pages within the target website
          nullable: true
        duplicate_title:
          type: integer
          description: <em>number of pages with duplicate titles</em>
          nullable: true
        duplicate_description:
          type: integer
          description: <em>number of pages with duplicate descriptions</em>
          nullable: true
        duplicate_content:
          type: integer
          description: <em>number of pages with duplicate content</em>
          nullable: true
        broken_links:
          type: integer
          description: <em>number of broken links</em><br>number of broken links across all crawled pages on a target website
          nullable: true
        broken_resources:
          type: integer
          description: <em>number of broken resources</em><br>the number of images and other resources with broken links
          nullable: true
        links_relation_conflict:
          type: integer
          description: '<em>number of links present on the target website that may have a conflict</em><br>for example, if <code>"links_relation_conflict": 2</code>, the target website is referring to the same source by at least one internal link with the <code>rel="nofollow"</code> attribute <strong>and</strong> by at least one dofollow link'
          nullable: true
        redirect_loop:
          type: integer
          description: <em>number of redirect chains that start and end at the same URL</em><br>number of redirect chains where the destination URL redirects back to the original URL
          nullable: true
        onpage_score:
          type: number
          description: <em>shows how website is optimized on a 100-point scale</em><br>this field shows how website is optimized considering critical on-page issues and warnings detected;<br><code>100</code> is the highest possible score that means website does not have any critical on-page issues and important warnings;<br><strong>note</strong> that this value depends on the number of crawled pages;<br>learn more about how the metric is calculated in <a href="https://dataforseo.com/help-center/how-is-onpage-score-of-a-domain-calculated" target="_blank" rel="noopener noreferrer">this help center article</a>
          nullable: true
        non_indexable:
          type: integer
          description: '<em>number of non-indexable pages</em><br>number of pages that are blocked from being indexed by Google and other search engines by robots.txt, HTTP headers, or meta tags settings;<br>you can receive a list of non-indexable URLs using <a href="https://docs.dataforseo.com/v3/on_page/non_indexable/?bash" target="_blank" rel="noopener noreferrer">this endpoint</a>'
          nullable: true
        checks:
          type: object
          additionalProperties:
            type: integer
            format: int64
            nullable: true
          description: <em>page-specific on-page check-ups</em>
          nullable: true
    OnPageSummaryResultInfo:
      type: object
      properties:
        crawl_progress:
          type: string
          description: '<em>status of the crawling session</em><br>possible values: <code>in_progress</code>, <code>finished</code>'
          nullable: true
        crawl_status:
          type: object
          oneOf:
            - $ref: '#/components/schemas/CrawlStatusInfo'
          description: <em>details of the crawling session</em>
          nullable: true
        crawl_gateway_address:
          type: string
          description: <em>crawler ip address</em><br>displays the IP address used by the crawler to initiate the current crawling session<br>you can find the full list of IPs used by our crawler in the <a href="/v3/on_page/overview" target="_blank" rel="noopener noreferrer">Overview section</a>
          nullable: true
        crawl_stop_reason:
          type: string
          description: '<em>reason why the crawling stopped</em><br>information about the reason why the crawling process stopped;<br>possible values:<br><code>limit_exceeded</code> - the limit set in the <code>max_crawl_pages</code> was exceeded;<br><code>empty_queue</code> - all URLs in the queue were crawled;<br><code>force_stopped</code> - the crawling process was halted using the<a href="/v3/on_page/force_stop" target="_blank" rel="noopener noreferrer"> On Page API Force Stop</a> function;<br><code>unexpected_exception</code> - an internal error was encountered while crawling the <code>target</code>, contact support for more info'
          nullable: true
        domain_info:
          type: object
          oneOf:
            - $ref: '#/components/schemas/DomainInfo'
          description: <em>domain-wide info</em><br>on-page information about the target domain and crawling process
          nullable: true
        page_metrics:
          type: object
          oneOf:
            - $ref: '#/components/schemas/PageMetrics'
          description: <em>page-specific info</em><br>metrics information on the target website pages
          nullable: true
    OnPageSummaryTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/OnPageSummaryResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    OnPageSummaryResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/OnPageSummaryTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    OnPagePagesRequestInfo:
      type: object
      properties:
        id:
          type: string
          description: ID of the taskrequired fieldyou can get this ID in the response of the Task POST endpointexample:"07131248-1535-0216-1000-17384017ad04"
        limit:
          type: integer
          description: 'the maximum number of returned pagesoptional fielddefault value: 100maximum value: 1000'
          nullable: true
        offset:
          type: integer
          description: 'offset in the results array of returned pagesoptional fielddefault value: 0maximum value: 2000000if you specify the 10 value, the first ten pages in the results array will be omitted and the data will be provided for the successive pages'
          nullable: true
        filters:
          type: array
          items:
            type: object
            nullable: true
          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_likeyou can use the % operator with like and not_like to match any string of zero or more charactersexample:["meta.external_links_count","<=",50]["url","like","https://dataforseo.com/apis/dataforseo-labs-api"][["checks.high_waiting_time","=",false],"and",["resource_type","=","html"]][["page_timing.duration_time","<",100],"and",[["checks.large_page_size","=",false],"or",["checks.high_waiting_time","=",false]]]The full list of possible filters is available by this link.'
          nullable: true
        order_by:
          type: array
          items:
            type: string
          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:["meta.external_links_count,desc"]note that you can set no more than three sorting rules in a single requestyou should use a comma to separate several sorting rulesexample:["page_timing.dom_complete,asc","size,desc"]'
          nullable: true
        search_after_token:
          type: string
          description: 'token for subsequent requestsoptional fieldprovided in the identical filed of the response to each request;use this parameter to avoid timeouts while trying to obtain over 20,000 results in a single request;by specifying the unique search_after_token value from the response array, you will get the subsequent results of the initial task;search_after_token values are unique for each subsequent task ;Note: if the search_after_token is specified in the request, all other parameters should be identical to the previous request'
          nullable: true
        tag:
          type: string
          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
          nullable: true
      example:
        - id: 07281559-0695-0216-0000-c269be8b7592
          filters:
            - 
              - resource_type
              - =
              - html
            - and
            - 
              - meta.scripts_count
              - '>'
              - 40
          order_by:
            - 'meta.content.plain_text_word_count,desc'
          limit: 10
    HtmlContentInfo:
      type: object
      properties:
        plain_text_size:
          type: integer
          description: total size of the text on the page measured in bytes
          nullable: true
        plain_text_rate:
          type: number
          description: "plaintext rate value\nplain_text_size to size ratio"
          format: double
          nullable: true
        plain_text_word_count:
          type: integer
          description: number of words on the page
          nullable: true
        automated_readability_index:
          type: number
          description: Automated Readability Index
          nullable: true
        coleman_liau_readability_index:
          type: number
          description: Coleman–Liau Index
          nullable: true
        dale_chall_readability_index:
          type: number
          description: Dale–Chall Readability Index
          nullable: true
        flesch_kincaid_readability_index:
          type: number
          description: Flesch–Kincaid Readability Index
          nullable: true
        smog_readability_index:
          type: number
          description: SMOG Readability Index
          nullable: true
        description_to_content_consistency:
          type: number
          description: consistency of the meta description tag with the page contentmeasured from 0 to 1
          nullable: true
        title_to_content_consistency:
          type: number
          description: consistency of the meta title tag with the page contentmeasured from 0 to 1
          nullable: true
        meta_keywords_to_content_consistency:
          type: number
          description: consistency of meta keywordstag with the page contentmeasured from 0 to 1
          nullable: true
    HunspellMisspelledInfo:
      type: object
      properties:
        word:
          type: string
          description: misspelled word
          nullable: true
    HunspellInfo:
      type: object
      properties:
        hunspell_language_code:
          type: string
          description: spellcheck language code
          nullable: true
        misspelled:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/HunspellMisspelledInfo'
            nullable: true
          description: array of misspelled words
          nullable: true
    PageMetaInfo:
      type: object
      properties:
        title:
          type: string
          description: page title
          nullable: true
        charset:
          type: integer
          description: 'code pageexample: 65001'
          nullable: true
        follow:
          type: boolean
          description: 'indicates whether a page''s ''meta robots'' allows crawlers to follow the links on the pageif false, the page''s ''meta robots'' tag contains "nofollow" parameter instructing crawlers not to follow the links on the page'
          nullable: true
        generator:
          type: string
          description: meta tag generator
          nullable: true
        htags:
          type: object
          additionalProperties:
            type: array
            items:
              type: string
            nullable: true
          description: HTML header tags
          nullable: true
        description:
          type: string
          description: content of the meta description tag
          nullable: true
        favicon:
          type: string
          description: favicon of the page
          nullable: true
        meta_keywords:
          type: string
          description: content of the keywords meta tag
          nullable: true
        canonical:
          type: string
          description: canonical page
          nullable: true
        internal_links_count:
          type: integer
          description: number of internal links on the page
          format: int64
          nullable: true
        external_links_count:
          type: integer
          description: number of external links on the page
          format: int64
          nullable: true
        inbound_links_count:
          type: integer
          description: number of internal links pointing at the page
          format: int64
          nullable: true
        images_count:
          type: integer
          description: number of images on the page
          format: int64
          nullable: true
        images_size:
          type: integer
          description: total size of images on the page measured in bytes
          nullable: true
        scripts_count:
          type: integer
          description: number of scripts on the page
          format: int64
          nullable: true
        scripts_size:
          type: integer
          description: total size of scripts on the page measured in bytes
          nullable: true
        stylesheets_count:
          type: integer
          description: number of stylesheets on the page
          format: int64
          nullable: true
        stylesheets_size:
          type: integer
          description: total size of stylesheets on the page measured in bytes
          nullable: true
        title_length:
          type: integer
          description: length of the title tag in characters
          nullable: true
        description_length:
          type: integer
          description: length of the description tag in characters
          nullable: true
        render_blocking_scripts_count:
          type: integer
          description: number of scripts on the page that block page rendering
          format: int64
          nullable: true
        render_blocking_stylesheets_count:
          type: integer
          description: number of CSS styles on the page that block page rendering
          format: int64
          nullable: true
        cumulative_layout_shift:
          type: number
          description: Core Web Vitals metric measuring the layout stability of the pagemeasures the sum total of all individual layout shift scores for every unexpected layout shift that occurs during the entire lifespan of the page. Learn more.
          nullable: true
        meta_title:
          type: string
          description: meta title of the pagemeta tag in the head section of an HTML document that defines the title of a page
          nullable: true
        content:
          type: object
          oneOf:
            - $ref: '#/components/schemas/HtmlContentInfo'
          description: overall information about content of the page
          nullable: true
        deprecated_tags:
          type: array
          items:
            type: string
            nullable: true
          description: deprecated tags on the page
          nullable: true
        duplicate_meta_tags:
          type: array
          items:
            type: string
            nullable: true
          description: duplicate meta tags on the page
          nullable: true
        spell:
          type: object
          oneOf:
            - $ref: '#/components/schemas/HunspellInfo'
          description: spellcheckhunspell spellcheck errors
          nullable: true
        social_media_tags:
          type: object
          additionalProperties:
            type: string
            nullable: true
          description: object of social media tags found on the pagecontains social media tags and their contentsupported tags include but are not limited to Open Graph and Twitter card
          nullable: true
        broken_html:
          type: object
          oneOf:
            - $ref: '#/components/schemas/OnPageResourceIssueInfo'
          description: resource errors and warnings
          nullable: true
    PageTiming:
      type: object
      properties:
        time_to_interactive:
          type: integer
          description: Time To Interactive (TTI) metricthe time it takes until the user can interact with a page (in milliseconds)
          nullable: true
        dom_complete:
          type: integer
          description: time to load resourcesthe time it takes until the page and all of its subresources are downloaded (in milliseconds)
          nullable: true
        largest_contentful_paint:
          type: number
          description: 'Core Web Vitals metric measuring how fast the largest above-the-fold content element is displayedThe amount of time (in milliseconds) to render the largest content element visible in the viewport, from when the user requests the URL. Learn more.'
          nullable: true
        first_input_delay:
          type: number
          description: Core Web Vitals metric indicating the responsiveness of a pageThe time (in milliseconds) from when a user first interacts with your page to the time when the browser responds to that interaction. Learn more.
          nullable: true
        connection_time:
          type: integer
          description: time to connect to a serverthe time it takes until the connection with a server is established (in milliseconds)
          nullable: true
        time_to_secure_connection:
          type: integer
          description: time to establish a secure connectionthe time it takes until the secure connection with a server is established (in milliseconds)
          nullable: true
        request_sent_time:
          type: integer
          description: time to send a request to a serverthe time it takes until the request to a server is sent (in milliseconds)
          nullable: true
        waiting_time:
          type: integer
          description: time to first byte (TTFB) in milliseconds
          nullable: true
        download_time:
          type: integer
          description: time it takes for a browser to receive a response (in milliseconds)
          nullable: true
        duration_time:
          type: integer
          description: total time it takes until a browser receives a complete response from a server (in milliseconds)
          nullable: true
        fetch_start:
          type: integer
          description: time to start downloading the HTML resourcethe amount of time the browser needs to start downloading a page
          nullable: true
        fetch_end:
          type: integer
          description: time to complete downloading the HTML resourcethe amount of time the browser needs to complete downloading a page
          nullable: true
    OnPageResourceIssueItemInfo:
      type: object
      properties:
        line:
          type: integer
          description: line where the error was found
          nullable: true
        column:
          type: integer
          description: column where the error was found
          nullable: true
        message:
          type: string
          description: text message of the errorthe full list of possible HTML errors can be found here
          nullable: true
        status_code:
          type: integer
          description: 'general status codeyou can find the full list of the response codes hereNote: we strongly recommend designing a necessary system for handling related exceptional or error conditions'
          nullable: true
    OnPageResourceIssueInfo:
      type: object
      properties:
        errors:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/OnPageResourceIssueItemInfo'
            nullable: true
          description: resource errors
          nullable: true
        warnings:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/OnPageResourceIssueItemInfo'
            nullable: true
          description: resource warnings
          nullable: true
      description: resource errors and warnings
    CacheControl:
      type: object
      properties:
        cachable:
          type: boolean
          description: indicates whether the page is cacheable
          nullable: true
        ttl:
          type: integer
          description: time to livethe amount of time the browser caches a resource
          nullable: true
    LastModified:
      type: object
      properties:
        header:
          type: string
          description: 'date and time when the header was last modifiedin the UTC format: "yyyy-mm-dd hh-mm-ss +00:00"example:2019-11-15 12:57:46 +00:00if there is no data, the value will be null'
          nullable: true
        sitemap:
          type: string
          description: 'date and time when the sitemap was last modifiedin the UTC format: "yyyy-mm-dd hh-mm-ss +00:00"example:2019-11-15 12:57:46 +00:00if there is no data, the value will be null'
          nullable: true
        meta_tag:
          type: string
          description: 'date and time when the meta tag was last modifiedin the UTC format: "yyyy-mm-dd hh-mm-ss +00:00"example:2019-11-15 12:57:46 +00:00if there is no data, the value will be null'
          nullable: true
    OnPageHtmlResourceItem:
      type: object
      allOf:
        - type: object
          oneOf:
            - $ref: '#/components/schemas/BaseOnPageResourceItem'
          nullable: true
        - type: object
          properties:
            meta:
              type: object
              oneOf:
                - $ref: '#/components/schemas/PageMetaInfo'
              properties:
                social_media_tags:
                  type: object
                  additionalProperties:
                    type: string
                    nullable: true
                  nullable: true
                broken_html:
                  type: object
                  oneOf:
                    - $ref: '#/components/schemas/OnPageResourceIssueInfo'
                  description: resource errors and warnings
                  nullable: true
              description: page propertiesthe value depends on the resource_type
              nullable: true
            page_timing:
              type: object
              oneOf:
                - $ref: '#/components/schemas/PageTiming'
              description: object of page load metrics
              nullable: true
            onpage_score:
              type: number
              description: shows how page is optimized on a 100-point scalethis field shows how page is optimized considering critical on-page issues and warnings detected;100 is the highest possible score that means the page does not have any critical on-page issues and important warnings;learn more about how the metric is calculated in this help center article
              nullable: true
            total_dom_size:
              type: integer
              description: total DOM size of a page
              format: int64
              nullable: true
            custom_js_response:
              type: object
              description: 'the result of executing a specified JS scriptnote that you should specify a custom_js field when setting a task to receive this data and the field type and its value will totally depend on the script you specified;you can also filter the results by this value specifying filters in the following way:["custom_js_response.url", "like", "pixel"]'
              nullable: true
            custom_js_client_exception:
              type: string
              description: 'error when executing a custom jsif the error occurred when executing the script you specified in the custom_js field, the error message would be displayed here'
              nullable: true
            broken_resources:
              type: boolean
              description: indicates whether a page contains broken resources
              nullable: true
            broken_links:
              type: boolean
              description: indicates whether a page contains broken links
              nullable: true
            duplicate_title:
              type: boolean
              description: indicates whether a page has duplicate title tags
              nullable: true
            duplicate_description:
              type: boolean
              description: indicates whether a page has a duplicate description
              nullable: true
            duplicate_content:
              type: boolean
              description: indicates whether a page has duplicate content
              nullable: true
            click_depth:
              type: integer
              description: number of clicks it takes to get to the pageindicates the number of clicks from the homepage needed before landing at the target page
              nullable: true
            is_resource:
              type: boolean
              description: indicates whether a page is a single resource
              nullable: true
            url_length:
              type: integer
              description: page URL length in characters
              nullable: true
            relative_url_length:
              type: integer
              description: relative URL length in characters
              nullable: true
    FetchTiming:
      type: object
      properties:
        duration_time:
          type: integer
          description: total time it takes until a browser receives a complete response from a server (in milliseconds)
          nullable: true
        fetch_start:
          type: integer
          description: time to start downloading the HTML resourcethe amount of time the browser needs to start downloading a page
          nullable: true
        fetch_end:
          type: integer
          description: time to complete downloading the HTML resourcethe amount of time the browser needs to complete downloading a page
          nullable: true
    OnPageBrokenResourceItem:
      type: object
      allOf:
        - type: object
          oneOf:
            - $ref: '#/components/schemas/BaseOnPageResourceItem'
          nullable: true
        - type: object
          properties:
            fetch_timing:
              type: object
              oneOf:
                - $ref: '#/components/schemas/FetchTiming'
              description: time range within which a result was fetched
              nullable: true
            is_resource:
              type: boolean
              description: indicates whether a page is a single resource
              nullable: true
            meta:
              type: object
              oneOf:
                - $ref: '#/components/schemas/PageMetaInfo'
              description: '<em>resource properties</em><br>the value depends on the <code>resource_type</code><br>note that if you do not indicate a <code>url</code> when setting a task, resource''s <code>meta</code> is returned based on the data from the page where our crawler first saw the resource;<br>to obtain resource''s <code>meta</code> from a particular <code>url</code>, specify that URL when setting a task'
              nullable: true
            accept_type:
              type: string
              description: '<em>indicates the expected type of resource</em><br>for example, if <code>"resource_type": "broken"</code>, <code>accept_type</code> will indicate the type of the broken resource<br>possible values: <br><code>any</code>, <code>none</code>, <code>image</code>, <code>sitemap</code>, <code>robots</code>, <code>script</code>, <code>stylesheet</code>, <code>redirect</code>, <code>html</code>, <code>text</code>, <code>other</code>, <code>font</code>'
              nullable: true
    OnPageRedirectResourceItem:
      type: object
      allOf:
        - type: object
          oneOf:
            - $ref: '#/components/schemas/BaseOnPageResourceItem'
          nullable: true
        - type: object
          properties:
            fetch_timing:
              type: object
              oneOf:
                - $ref: '#/components/schemas/FetchTiming'
              description: time range within which a result was fetched
              nullable: true
            is_resource:
              type: boolean
              description: indicates whether a page is a single resource
              nullable: true
    OnPageScriptResourceItem:
      type: object
      allOf:
        - type: object
          oneOf:
            - $ref: '#/components/schemas/BaseOnPageResourceItem'
          nullable: true
        - type: object
          properties:
            meta:
              type: object
              oneOf:
                - $ref: '#/components/schemas/ResourceMetaInfo'
              nullable: true
            fetch_timing:
              type: object
              oneOf:
                - $ref: '#/components/schemas/FetchTiming'
              description: time range within which a result was fetched
              nullable: true
            accept_type:
              type: string
              description: 'indicates the expected type of resourcefor example, if "resource_type": "broken", accept_type will indicate the type of the broken resourcepossible values:any, none, image, sitemap, robots, script, stylesheet, redirect, html, text, other, font'
              nullable: true
    OnPageImageResourceItem:
      type: object
      allOf:
        - type: object
          oneOf:
            - $ref: '#/components/schemas/BaseOnPageResourceItem'
          nullable: true
        - type: object
          properties:
            meta:
              type: object
              oneOf:
                - $ref: '#/components/schemas/ResourceMetaInfo'
              description: page propertiesthe value depends on the resource_type
              nullable: true
            fetch_timing:
              type: object
              oneOf:
                - $ref: '#/components/schemas/FetchTiming'
              description: time range within which a result was fetched
              nullable: true
            accept_type:
              type: string
              description: 'indicates the expected type of resourcefor example, if "resource_type": "broken", accept_type will indicate the type of the broken resourcepossible values:any, none, image, sitemap, robots, script, stylesheet, redirect, html, text, other, font'
              nullable: true
    OnPageStylesheetResourceItem:
      type: object
      allOf:
        - type: object
          oneOf:
            - $ref: '#/components/schemas/BaseOnPageResourceItem'
          nullable: true
        - type: object
          properties:
            meta:
              type: object
              oneOf:
                - $ref: '#/components/schemas/ResourceMetaInfo'
              description: page propertiesthe value depends on the resource_type
              nullable: true
            fetch_timing:
              type: object
              oneOf:
                - $ref: '#/components/schemas/FetchTiming'
              description: time range within which a result was fetched
              nullable: true
            accept_type:
              type: string
              description: 'indicates the expected type of resourcefor example, if "resource_type": "broken", accept_type will indicate the type of the broken resourcepossible values:any, none, image, sitemap, robots, script, stylesheet, redirect, html, text, other, font'
              nullable: true
    OnPagePagesResultInfo:
      type: object
      properties:
        crawl_progress:
          type: string
          description: 'status of the crawling sessionpossible values: in_progress, finished'
          nullable: true
        crawl_status:
          type: object
          oneOf:
            - $ref: '#/components/schemas/CrawlStatusInfo'
          description: details of the crawling session
          nullable: true
        search_after_token:
          type: string
          nullable: true
        current_offset:
          type: integer
          nullable: true
        total_items_count:
          type: integer
          description: total number of relevant items in the database
          format: int64
          nullable: true
        items_count:
          type: integer
          description: number of items in the results array
          format: int64
          nullable: true
        items:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/BaseOnPageResourceItem'
            nullable: true
          description: items array
          nullable: true
    OnPagePagesTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/OnPagePagesResultInfo'
                nullable: true
              description: array of results
              nullable: true
    OnPagePagesResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/OnPagePagesTaskInfo'
                nullable: true
              description: array of tasks
              nullable: true
    OnPagePagesByResourceRequestInfo:
      type: object
      properties:
        id:
          type: string
          description: <em>ID of the task</em><br><strong>required field</strong><br>you can get this ID in the response of the <a href="/v3/on_page/task_post/">Task POST</a> endpoint<br>example:<br>"07131248-1535-0216-1000-17384017ad04"
        url:
          type: string
          description: <em>resource URL</em><br><strong>required field</strong><br>you can get this URL in the response of the <a href="/v3/on_page/resources/">Resources</a> endpoint<br>example:<br><code>https://ajax.googleapis.com/ajax/libs/jquery/1.12.4/jquery.min.js</code>
        limit:
          type: integer
          description: '<em>the maximum number of returned pages</em><br>optional field<br>default value: <code>100</code><br>maximum value: <code>1000</code>'
          nullable: true
        offset:
          type: integer
          description: '<em>offset in the results array of returned pages</em><br>optional field<br>default value: <code>0</code><br>maximum value: <code>2000000</code><br>if you specify the <code>10</code> value, the first ten pages in the results array will be omitted and the data will be provided for the successive pages'
          nullable: true
        filters:
          type: array
          items:
            type: object
            nullable: true
          description: '<em>array of results filtering parameters</em><br>optional field<br><strong>you can add several filters at once (8 filters maximum)</strong><br>you should set a logical operator <code>and</code>, <code>or</code> between the conditions<br>the following operators are supported:<br><code>regex</code>, <code>not_regex</code>, <code>&lt;</code>, <code>&lt;=</code>, <code>&gt;</code>, <code>&gt;=</code>, <code>=</code>, <code>&lt;&gt;</code>, <code>in</code>, <code>not_in</code>, <code>like</code>, <code>not_like</code><br>you can use the <code>%</code> operator with <code>like</code> and <code>not_like</code> to match any string of zero or more characters<br>example:<br><code>["meta.external_links_count","&lt;=",50]</code><code>["url","like","https://dataforseo.com/apis/dataforseo-labs-api"]</code><p><code>[["checks.high_waiting_time","=",false],<br>"and",["resource_type","=","html"]]</code><p><code>[["page_timing.duration_time","&lt;",100],"and",[["checks.large_page_size","=",false],"or",["checks.high_waiting_time","=",false]]]</code><p>The full list of possible filters is available <a href="/v3/on_page/filters_and_thresholds/?bash" target="_blank" rel="noopener noreferrer">by this link.</a>'
          nullable: true
        order_by:
          type: array
          items:
            type: string
          description: '<em>results sorting rules</em><br>optional field<br>you can use the same values as in the <code>filters</code> array to sort the results<br>possible sorting types:<br><code>asc</code> - results will be sorted in the ascending order<br><code>desc</code> - results will be sorted in the descending order<br>you should use a comma to set up a sorting type<br>example:<br><code>["meta.external_links_count,desc"]</code><br><strong>note that you can set no more than three sorting rules in a single request</strong><br>you should use a comma to separate several sorting rules<br>example:<br><code>["page_timing.dom_complete,asc","size,desc"]</code>'
          nullable: true
        tag:
          type: string
          description: <em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response
          nullable: true
      example:
        - id: 02241700-1535-0216-0000-034137259bc1
          url: https://www.etsy.com/about/jobs.workco2018.js?
    FoundOnWebElement:
      type: object
      properties:
        type:
          type: string
          description: type of element
          nullable: true
        title:
          type: string
          description: title of the row
          nullable: true
        subtitle:
          type: string
          description: subtitle of the element
          nullable: true
        image:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AiModeImagesElementInfo'
          description: image of the element
          nullable: true
    OnPagePagesByResourceResultInfo:
      type: object
      properties:
        crawl_progress:
          type: string
          description: '<em>status of the crawling session</em><br>possible values: <code>in_progress</code>, <code>finished</code>'
          nullable: true
        crawl_status:
          type: object
          oneOf:
            - $ref: '#/components/schemas/CrawlStatusInfo'
          description: <em>details of the crawling session</em>
          nullable: true
        total_items_count:
          type: integer
          description: <em>total number of relevant items in the database</em>
          format: int64
          nullable: true
        items_count:
          type: integer
          description: <em>number of items in the results array</em>
          format: int64
          nullable: true
        items:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/OnPageHtmlResourceItem'
            nullable: true
          description: <em>items array</em>
          nullable: true
    OnPagePagesByResourceTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/OnPagePagesByResourceResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    OnPagePagesByResourceResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/OnPagePagesByResourceTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    OnPageResourcesRequestInfo:
      type: object
      properties:
        id:
          type: string
          description: <em>ID of the task</em><br><strong>required field</strong><br>you can get this ID in the response of the <a href="/v3/on_page/task_post/">Task POST</a> endpoint<br>example:<br>"07131248-1535-0216-1000-17384017ad04"
        url:
          type: string
          description: '<em>page URL</em><br>optional field<br>specify this field if you want to get the resources for a specific page<br>note that to obtain resource''s <code>meta</code> from a particular URL, you should specify the URL in this field;<br>if you do not indicate a <code>url</code> when setting a task, resource''s <code>meta</code> in the results will be returned based on the data from the page where our crawler first saw the resource'
          nullable: true
        limit:
          type: integer
          description: '<em>the maximum number of returned resources</em><br>optional field<br>default value: <code>100</code><br>maximum value: <code>1000</code>'
          nullable: true
        offset:
          type: integer
          description: '<em>offset in the results array of returned resources</em><br>optional field<br>default value: <code>0</code><br>maximum value: <code>2000000</code><br>if you specify the <code>10</code> value, the first ten resources in the results array will be omitted and the data will be provided for the successive resources'
          nullable: true
        filters:
          type: array
          items:
            type: object
            nullable: true
          description: '<em>array of results filtering parameters</em><br>optional field<br><strong>you can add several filters at once (8 filters maximum)</strong><br>you should set a logical operator <code>and</code>, <code>or</code> between the conditions<br>the following operators are supported:<br><code>regex</code>, <code>not_regex</code>, <code>&lt;</code>, <code>&lt;=</code>, <code>&gt;</code>, <code>&gt;=</code>, <code>=</code>, <code>&lt;&gt;</code>, <code>in</code>, <code>not_in</code>, <code>like</code>, <code>not_like</code><br>you can use the <code>%</code> operator with <code>like</code> and <code>not_like</code> to match any string of zero or more characters<br>example:<br><code>["resource_type","=","stylesheet"]</code><p><code>[["resource_type","=","image"],<br>"and",["checks.is_https","=",false]]</code><p><code>[["fetch_timing.duration_time",">",1],"and",[["total_transfer_size","&gt;",100],"or",["checks.high_loading_time","=",true]]]</code><p>The full list of possible filters is available <a href="/v3/on_page/filters_and_thresholds/?bash" rel="noopener noreferrer" target="_blank">by this link.</a>'
          nullable: true
        relevant_pages_filters:
          type: array
          items:
            type: string
          description: '<em>filter the resources by relevant pages</em><br>optional field<br>you can use this field to obtain resources from pages matching to the defined parameters<br>you can apply the same filters here as available for the <a href="/v3/on_page/pages/" rel="noopener noreferrer" target="_blank">pages endpoint</a><br><strong>you can add several filters at once (8 filters maximum)</strong><br>you should set a logical operator <code>and</code>, <code>or</code> between the conditions<br>the following operators are supported:<br><code>regex</code>, <code>not_regex</code>, <code>&lt;</code>, <code>&lt;=</code>, <code>&gt;</code>, <code>&gt;=</code>, <code>=</code>, <code>&lt;&gt;</code>, <code>in</code>, <code>not_in</code>, <code>like</code>, <code>not_like</code><br>you can use the <code>%</code> operator with <code>like</code> and <code>not_like</code> to match any string of zero or more characters<br>example:<br><code>["checks.no_image_title","=",true]</code>'
          nullable: true
        order_by:
          type: array
          items:
            type: string
          description: '<em>results sorting rules</em><br>optional field<br>you can use the same values as in the <code>filters</code> array to sort the results<br>possible sorting types:<br><code>asc</code> - results will be sorted in the ascending order<br><code>desc</code> - results will be sorted in the descending order<br>you should use a comma to set up a sorting type<br>example:<br><code>["size,desc"]</code><br><strong>note that you can set no more than three sorting rules in a single request</strong><br>you should use a comma to separate several sorting rules<br>example:<br><code>["size,desc","fetch_timing.fetch_end,desc"]</code>'
          nullable: true
        search_after_token:
          type: string
          description: '<em>token for subsequent requests</em><br>optional field<br>provided in the identical filed of the response to each request;<br>use this parameter to avoid timeouts while trying to obtain over <code>20,000</code> results in a single request;<br>by specifying the unique <code>search_after_token</code> value from the response array, you will get the subsequent results of the initial task;<br><code>search_after_token</code> values are unique for each subsequent task ;<br><strong>Note:</strong> if the <code>search_after_token</code> is specified in the request, all other parameters should be identical to the previous request'
          nullable: true
        tag:
          type: string
          description: <em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response
          nullable: true
      example:
        - id: 07281559-0695-0216-0000-c269be8b7592
          filters:
            - 
              - resource_type
              - =
              - image
            - and
            - 
              - size
              - '>'
              - 100000
          order_by:
            - 'size,desc'
          limit: 10
    OnPageResourcesResultInfo:
      type: object
      properties:
        crawl_progress:
          type: string
          description: '<em>status of the crawling session</em><br>possible values: <code>in_progress</code>, <code>finished</code>'
          nullable: true
        crawl_status:
          type: object
          oneOf:
            - $ref: '#/components/schemas/CrawlStatusInfo'
          description: <em>details of the crawling session</em>
          nullable: true
        search_after_token:
          type: string
          nullable: true
        current_offset:
          type: integer
          nullable: true
        total_items_count:
          type: integer
          description: <em>total number of relevant items crawled</em>
          format: int64
          nullable: true
        items_count:
          type: integer
          description: <em>number of items in the results array</em>
          format: int64
          nullable: true
        items:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/BaseOnPageResourceItem'
            nullable: true
          description: <em>items array</em>
          nullable: true
    OnPageResourcesTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/OnPageResourcesResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    OnPageResourcesResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/OnPageResourcesTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    OnPageDuplicateTagsRequestInfo:
      type: object
      properties:
        id:
          type: string
          description: <em>ID of the task</em><br><strong>required field</strong><br>you can get this ID in the response of the <a href="https://docs.dataforseo.com/v3/on_page/task_post/">Task POST</a> endpoint<br>example:<br>"07131248-1535-0216-1000-17384017ad04"
        type:
          type: string
          description: type of element
        accumulator:
          type: string
          description: <em>tag value</em><br>optional field<br>specify a title or description here if you want to receive a list of duplicate pages that contains this tag
          nullable: true
        limit:
          type: integer
          description: '<em>the maximum number of returned pages</em><br>optional field<br>default value: <code>100</code><br>maximum value: <code>1000</code>'
          nullable: true
        offset:
          type: integer
          description: '<em>offset in the results array of returned pages</em><br>optional field<br>default value: <code>0</code><br>maximum value: <code>2000000</code><br>if you specify the <code>10</code> value, the first ten pages in the results array will be omitted and the data will be provided for the successive pages'
          nullable: true
        tag:
          type: string
          description: <em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response
          nullable: true
      example:
        - id: 07281559-0695-0216-0000-c269be8b7592
          type: duplicate_description
          limit: 10
    OnPageDuplicateTagsItem:
      type: object
      properties:
        accumulator:
          type: string
          description: <em>contains the value of duplicated tag</em>
          nullable: true
        total_count:
          type: integer
          description: <em>total count of duplicate pages</em>
          format: int64
          nullable: true
        pages:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/OnPageHtmlResourceItem'
            nullable: true
          description: <em>pages with duplicate tags</em>
          nullable: true
    OnPageDuplicateTagsResultInfo:
      type: object
      properties:
        crawl_progress:
          type: string
          description: '<em>status of the crawling session</em><br>possible values: <code>in_progress</code>, <code>finished</code>'
          nullable: true
        crawl_status:
          type: object
          oneOf:
            - $ref: '#/components/schemas/CrawlStatusInfo'
          description: <em>details of the crawling session</em>
          nullable: true
        total_pages_count:
          type: integer
          description: <em>total number of pages with duplicate tags</em><br>displays the total number of pages with duplicate tags of the target website
          format: int64
          nullable: true
        pages_count:
          type: integer
          description: <em>number of pages with duplicate tags in the response</em><br>displays the number of pages with duplicate tags returned in the response
          format: int64
          nullable: true
        items_count:
          type: integer
          description: <em>number of items in the results array</em>
          format: int64
          nullable: true
        items:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/OnPageDuplicateTagsItem'
            nullable: true
          description: <em>items array</em>
          nullable: true
    OnPageDuplicateTagsTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/OnPageDuplicateTagsResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    OnPageDuplicateTagsResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/OnPageDuplicateTagsTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    OnPageDuplicateContentRequestInfo:
      type: object
      properties:
        id:
          type: string
          description: <em>ID of the task</em><br><strong>required field</strong><br>you can get this ID in the response of the <a href="https://docs.dataforseo.com/v3/on_page/task_post/">Task POST</a> endpoint<br>example:<br>"07131248-1535-0216-1000-17384017ad04"
        url:
          type: string
          description: <em>page URL</em><br><strong>required field</strong><br>specify the initial page you want to receive duplicate content for
        similarity:
          type: integer
          description: '<em>content similarity score</em><br>by default, the content is considered duplicate if the value is greater than or equals <code>6</code><br>you can specify any similarity score in the 0-to-10 range'
          nullable: true
        limit:
          type: integer
          description: '<em>the maximum number of returned pages</em><br>optional field<br>default value: <code>100</code><br>maximum value: <code>1000</code>'
          nullable: true
        offset:
          type: integer
          description: '<em>offset in the results array of returned pages</em><br>optional field<br>default value: <code>0</code><br>maximum value: <code>2000000</code><br>if you specify the <code>10</code> value, the first ten pages in the results array will be omitted and the data will be provided for the successive pages'
          nullable: true
        tag:
          type: string
          description: <em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response
          nullable: true
      example:
        - id: 07281559-0695-0216-0000-c269be8b7592
          url: https://www.etsy.com/
    DuplicatePageInfo:
      type: object
      properties:
        similarity:
          type: integer
          nullable: true
        page:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/OnPageHtmlResourceItem'
            nullable: true
          description: <em>information about the page with duplicate content</em>
          nullable: true
    OnPageDuplicateContentItem:
      type: object
      properties:
        url:
          type: string
          description: <em>URL of the specified page</em>
          nullable: true
        total_count:
          type: integer
          description: <em>total count of duplicate pages</em>
          format: int64
          nullable: true
        pages:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/DuplicatePageInfo'
            nullable: true
          description: <em>pages with duplicate content</em>
          nullable: true
    OnPageDuplicateContentResultInfo:
      type: object
      properties:
        crawl_progress:
          type: string
          description: '<em>status of the crawling session</em><br>possible values: <code>in_progress</code>, <code>finished</code>'
          nullable: true
        crawl_status:
          type: object
          oneOf:
            - $ref: '#/components/schemas/CrawlStatusInfo'
          description: <em>details of the crawling session</em>
          nullable: true
        items_count:
          type: integer
          description: <em>number of items in the results array</em>
          format: int64
          nullable: true
        items:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/OnPageDuplicateContentItem'
            nullable: true
          description: <em>items array</em>
          nullable: true
    OnPageDuplicateContentTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/OnPageDuplicateContentResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    OnPageDuplicateContentResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/OnPageDuplicateContentTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    OnPageLinksRequestInfo:
      type: object
      properties:
        id:
          type: string
          description: <em>ID of the task</em><br><strong>required field</strong><br>you can get this ID in the response of the <a href="https://docs.dataforseo.com/v3/on_page/task_post/">Task POST</a> endpoint<br>example:<br>"07131248-1535-0216-1000-17384017ad04"
        page_from:
          type: string
          description: '<em>relative page URL</em><br>optional field<br>if you use this field, the API response will contain only links from the specified page<br>note that in this field you can specify relative URLs only'
          nullable: true
        page_to:
          type: string
          description: '<em>relative page URL</em><br>optional field<br>if you use this field, the API response will contain only internal links pointing to the specified page<br>note that in this field you can specify relative URLs only'
          nullable: true
        limit:
          type: integer
          description: '<em>the maximum number of returned links</em><br>optional field<br>default value: <code>100</code><br>maximum value: <code>1000</code>'
          nullable: true
        offset:
          type: integer
          description: '<em>offset in the results array of returned links</em><br>optional field<br>default value: <code>0</code><br>maximum value: <code>2000000</code><br>if you specify the <code>10</code> value, the first ten links in the results array will be omitted and the data will be provided for the successive links'
          nullable: true
        filters:
          type: array
          items:
            type: object
            nullable: true
          description: '<em>array of results filtering parameters</em><br>optional field<br><strong>you can add several filters at once (8 filters maximum)</strong><br>you should set a logical operator <code>and</code>, <code>or</code> between the conditions<br>the following operators are supported:<br><code>regex</code>, <code>not_regex</code>, <code>=</code>, <code>&lt;&gt;</code>, <code>in</code>, <code>not_in</code>, <code>like</code>, <code>not_like</code><br>you can use the <code>%</code> operator with <code>like</code> and <code>not_like</code> to match any string of zero or more characters<br>example:<br><code>["direction","=","external"]</code><p><code>[["domain_to","&lt;&gt;","example.com"],<br>"and",<br>["link_from","not_like","%example.com/blog%"]]</code><p><code>[["direction","=","external"],<br>"and",<br>[["link_from","like","%example.com/blog%"],"or",["link_from","like","%example.com/help%"]]]</code><p>The full list of possible filters is available <a href="/v3/on_page/filters_and_thresholds/?bash" rel="noopener noreferrer" target="_blank">by this link.</a>'
          nullable: true
        search_after_token:
          type: string
          description: '<em>token for subsequent requests</em><br>optional field<br>provided in the identical filed of the response to each request;<br>use this parameter to avoid timeouts while trying to obtain over <code>20,000</code> results in a single request;<br>by specifying the unique <code>search_after_token</code> value from the response array, you will get the subsequent results of the initial task;<br><code>search_after_token</code> values are unique for each subsequent task ;<br><strong>Note:</strong> if the <code>search_after_token</code> is specified in the request, all other parameters should be identical to the previous request'
          nullable: true
        tag:
          type: string
          description: <em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response
          nullable: true
      example:
        - id: 07281559-0695-0216-0000-c269be8b7592
          page_from: /apis/google-trends-api
          filters:
            - 
              - dofollow
              - =
              - true
            - and
            - 
              - direction
              - =
              - external
          limit: 10
    OnPageAnchorLinkItem:
      type: object
      allOf:
        - type: object
          oneOf:
            - $ref: '#/components/schemas/BaseOnPageLinkItem'
          nullable: true
        - type: object
          properties:
            link_attribute:
              type: array
              items:
                type: string
                nullable: true
              description: '<em>link attribute added to external link</em><br>indicates link attributes added to the <code>link_to</code> on the <code>page_from</code><br>example:<br><code>["ugc","noopener"]</code>'
              nullable: true
            text:
              type: string
              description: <em>anchor text</em>
              nullable: true
    OnPageImageLinkItem:
      type: object
      allOf:
        - type: object
          oneOf:
            - $ref: '#/components/schemas/BaseOnPageLinkItem'
          nullable: true
        - type: object
          properties:
            link_attribute:
              type: array
              items:
                type: string
                nullable: true
              description: '<em>link attribute added to external link</em><br>indicates link attributes added to the <code>link_to</code> on the <code>page_from</code><br>example:<br><code>["ugc","noopener"]</code>'
              nullable: true
            text:
              type: string
              description: <em>anchor text</em>
              nullable: true
            image_alt:
              type: string
              description: <em>alternative text for the image</em>
              nullable: true
            image_src:
              type: string
              description: <em>url of the image</em>
              nullable: true
    OnPageCanonicalLinkItem:
      type: object
      allOf:
        - type: object
          oneOf:
            - $ref: '#/components/schemas/BaseOnPageLinkItem'
          nullable: true
        - type: object
    OnPageAlternateLinkItem:
      type: object
      allOf:
        - type: object
          oneOf:
            - $ref: '#/components/schemas/BaseOnPageLinkItem'
          nullable: true
        - type: object
          properties:
            is_valid_hreflang:
              type: boolean
              description: <em>hreflang validity status</em><br>indicates whether the hreflang attribute is correctly implemented
              nullable: true
            hreflang:
              type: string
              description: '<em>hreflang attribute value</em><br>language and optional country code specified in the hreflang attribute<br>example: <code>"en-US"</code>, <code>"fr"</code>'
              nullable: true
    OnPageLinkLinkItem:
      type: object
      allOf:
        - type: object
          oneOf:
            - $ref: '#/components/schemas/BaseOnPageLinkItem'
          nullable: true
        - type: object
    OnPageRedirectLinkItem:
      type: object
      allOf:
        - type: object
          oneOf:
            - $ref: '#/components/schemas/BaseOnPageLinkItem'
          nullable: true
        - type: object
    OnPageMetaLinkItem:
      type: object
      allOf:
        - type: object
          oneOf:
            - $ref: '#/components/schemas/BaseOnPageLinkItem'
          nullable: true
        - type: object
    OnPageLinksResultInfo:
      type: object
      properties:
        crawl_progress:
          type: string
          description: '<em>status of the crawling session</em><br>possible values: <code>in_progress</code>, <code>finished</code>'
          nullable: true
        crawl_status:
          type: object
          oneOf:
            - $ref: '#/components/schemas/CrawlStatusInfo'
          description: <em>details of the crawling session</em>
          nullable: true
        search_after_token:
          type: string
          nullable: true
        current_offset:
          type: integer
          nullable: true
        total_items_count:
          type: integer
          description: <em>total number of relevant items in the database</em>
          format: int64
          nullable: true
        items_count:
          type: integer
          description: <em>number of items in the results array</em>
          format: int64
          nullable: true
        items:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/BaseOnPageLinkItem'
            nullable: true
          description: <em>items array</em>
          nullable: true
    OnPageLinksTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/OnPageLinksResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    OnPageLinksResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/OnPageLinksTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    OnPageRedirectChainsRequestInfo:
      type: object
      properties:
        id:
          type: string
          description: <em>ID of the task</em><br><strong>required field</strong><br>you can get this ID in the response of the <a href="/v3/on_page/task_post/">Task POST</a> endpoint<br>example:<br>"07131248-1535-0216-1000-17384017ad04"
        url:
          type: string
          description: '<em>page URL</em><br>optional field<br>absolute URL of the target page<br>if you use this field, the API response will return only redirect chains which contain the specified URL'
          nullable: true
        limit:
          type: integer
          description: '<em>the maximum number of returned redirect chains</em><br>optional field<br>default value: <code>100</code><br>maximum value: <code>1000</code>'
          nullable: true
        offset:
          type: integer
          description: '<em>offset in the results array of returned redirect chains</em><br>optional field<br>default value: <code>0</code><br>maximum value: <code>2000000</code><br>if you specify the <code>10</code> value, the first ten redirect chains in the results array will be omitted and the data will be provided for the successive redirect chains'
          nullable: true
        filters:
          type: array
          items:
            type: object
            nullable: true
          description: '<em>array of results filtering parameters</em><br>optional field<br><strong>you can use only one filtering parameter with this endpoint</strong><p>the following filtering parameter is supported:<br><code>is_redirect_loop</code><br>the following operators are supported:<br><code>regex</code>, <code>not_regex</code>, <code>=</code>, <code>&lt;&gt;</code><p>examples:<br><code>["is_redirect_loop","=","true"]</code><p><code>["is_redirect_loop","&lt;&gt;","false"]</code>'
          nullable: true
        tag:
          type: string
          description: <em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response
          nullable: true
      example:
        - id: 03051327-4536-0216-1000-3b458a2cfcca
          url: https://test_rdr.dataforseo.com/a/
    OnPageRedirectChainsItem:
      type: object
      properties:
        is_redirect_loop:
          type: boolean
          description: '<em>indicates if redirects in <code>chain</code> start and end at the same URL</em><br>if <code>true</code>, the last URL from the chain redirects back to the original URL'
          nullable: true
        chain:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/OnPageRedirectLinkItem'
            nullable: true
          description: <em>contains links that form a chain</em>
          nullable: true
    OnPageRedirectChainsResultInfo:
      type: object
      properties:
        crawl_progress:
          type: string
          description: '<em>status of the crawling session</em><br>possible values: <code>in_progress</code>, <code>finished</code>'
          nullable: true
        crawl_status:
          type: object
          oneOf:
            - $ref: '#/components/schemas/CrawlStatusInfo'
          description: <em>details of the crawling session</em>
          nullable: true
        total_items_count:
          type: integer
          description: <em>total number of relevant items in the database</em>
          format: int64
          nullable: true
        items_count:
          type: integer
          description: <em>number of items in the results array</em>
          format: int64
          nullable: true
        items:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/OnPageRedirectChainsItem'
            nullable: true
          description: <em>items array</em>
          nullable: true
    OnPageRedirectChainsTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/OnPageRedirectChainsResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    OnPageRedirectChainsResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/OnPageRedirectChainsTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    OnPageNonIndexableRequestInfo:
      type: object
      properties:
        id:
          type: string
          description: <em>ID of the task</em><br><strong>required field</strong><br>you can get this ID in the response of the <a href="/v3/on_page/task_post/">Task POST</a> endpoint<br>example:<br>"07131248-1535-0216-1000-17384017ad04"
        limit:
          type: integer
          description: '<em>the maximum number of returned pages</em><br>optional field<br>default value: <code>100</code><br>maximum value: <code>1000</code>'
          nullable: true
        offset:
          type: integer
          description: '<em>offset in the results array of returned pages</em><br>optional field<br>default value: <code>0</code><br>maximum value: <code>2000000</code><br>if you specify the <code>10</code> value, the first ten pages in the results array will be omitted and the data will be provided for the successive pages'
          nullable: true
        filters:
          type: array
          items:
            type: object
            nullable: true
          description: '<em>array of results filtering parameters</em><br>optional field<br><strong>you can add several filters at once (8 filters maximum)</strong><br>you should set a logical operator <code>and</code>, <code>or</code> between the conditions<br>the following operators are supported:<br><code>regex</code>, <code>not_regex</code>, <code>&lt;</code>, <code>&lt;=</code>, <code>&gt;</code>, <code>&gt;=</code>, <code>=</code>, <code>&lt;&gt;</code>, <code>in</code>, <code>not_in</code>, <code>like</code>, <code>not_like</code><br>you can use the <code>%</code> operator with <code>like</code> and <code>not_like</code> to match any string of zero or more characters<br>example:<br><code>[["reason","&lt;&gt;","robots_txt"],<br>"and",<br>["url","not_like","%/wp-admin/%"]]</code><p><code>[["url","not_like","%/wp-admin/%"],<br>"and",<br>[["reason","&lt;&gt;","meta_tag"],"or",["reason","&lt;&gt;","http_header"]]]</code><p>The full list of possible filters is available <a href="/v3/on_page/filters_and_thresholds/?bash" target="_blank" rel="noopener noreferrer">by this link.</a>'
          nullable: true
      example:
        - id: 07281559-0695-0216-0000-c269be8b7592
          filters:
            - 
              - reason
              - =
              - robots_txt
            - and
            - 
              - url
              - like
              - '%go%'
          limit: 10
    OnPageNonIndexableItem:
      type: object
      properties:
        reason:
          type: string
          description: '<em>the reason why the page is non-indexable</em><br>can take the following values: <code>robots_txt</code>, <code>meta_tag</code>, <code>http_header</code>, <code>attribute</code>, <code>too_many_redirects</code>'
          nullable: true
        url:
          type: string
          description: <em>url of the non-indexable page</em>
          nullable: true
    OnPageNonIndexableResultInfo:
      type: object
      properties:
        crawl_progress:
          type: string
          description: '<em>status of the crawling session</em><br>possible values: <code>in_progress</code>, <code>finished</code>'
          nullable: true
        crawl_status:
          type: object
          oneOf:
            - $ref: '#/components/schemas/CrawlStatusInfo'
          description: <em>details of the crawling session</em>
          nullable: true
        total_items_count:
          type: integer
          description: <em>total number of relevant items in the database</em>
          format: int64
          nullable: true
        items_count:
          type: integer
          description: <em>number of items in the results array</em>
          format: int64
          nullable: true
        items:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/OnPageNonIndexableItem'
            nullable: true
          description: <em>items array</em>
          nullable: true
    OnPageNonIndexableTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/OnPageNonIndexableResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    OnPageNonIndexableResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/OnPageNonIndexableTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    OnPageWaterfallRequestInfo:
      type: object
      properties:
        id:
          type: string
          description: <em>ID of the task</em><br><strong>required field</strong><br>you can get this ID in the response of the <a href="/v3/on_page/task_post/">Task POST</a> endpoint<br>example:<br>"07131248-1535-0216-1000-17384017ad04"
        url:
          type: string
          description: <em>page URL</em><br><strong>required field</strong><br>specify the pages you want to receive timing for
        tag:
          type: string
          description: <em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response
          nullable: true
      example:
        - id: 08101204-0696-0216-0000-644a7b21a48a
          url: https://dataforseo.com/tag/broken-links
    OnPageResourceLocationInfo:
      type: object
      properties:
        line:
          type: integer
          description: <em>line number</em><br>the number of the line on which the resource is located
          nullable: true
        offset_left:
          type: integer
          description: '<em>position in line</em><br>the number of line characters before the resource;<br>sometimes referred to as <em>column</em><br><strong>Note:</strong> counts from 1, i.e. if the resource doesn''t have any characters to the left, the value will be 1'
          nullable: true
        offset_top:
          type: integer
          description: <em>position in the document</em><br>the total number of characters between the resource and the top of HTML
          nullable: true
    WaterfallResourceInfo:
      type: object
      properties:
        resource_type:
          type: string
          nullable: true
        url:
          type: string
          description: <em>resource URL</em>
          nullable: true
        initiator:
          type: string
          description: <em>resource initiator</em>
          nullable: true
        duration_time:
          type: integer
          description: <em>total time it takes until a browser receives a complete response from a server (in milliseconds)</em>
          nullable: true
        fetch_start:
          type: integer
          description: <em>time to start downloading the HTML resource</em><br>the amount of time the browser needs to start downloading a page
          nullable: true
        fetch_end:
          type: integer
          description: <em>time to complete downloading the HTML resource</em><br>the amount of time the browser needs to complete downloading a page
          nullable: true
        location:
          type: object
          oneOf:
            - $ref: '#/components/schemas/OnPageResourceLocationInfo'
          description: <em>location of the resource in the document</em><br>parameters defining the location of the specific resource within the document's HTML
          nullable: true
        is_render_blocking:
          type: boolean
          description: <em>indicates whether the resource blocks rendering</em>
          nullable: true
    OnPageWaterfallItem:
      type: object
      properties:
        page_url:
          type: string
          description: <em>URL of the page</em>
          nullable: true
        time_to_interactive:
          type: integer
          description: <em><a href="https://web.dev/interactive/">Time To Interactive (TTI)</a> metric</em><br>the time it takes until the user can interact with a page (in milliseconds)
          nullable: true
        dom_complete:
          type: integer
          description: <em>time to load resources</em><br>the time it takes until the page and all of its subresources are downloaded (in milliseconds)
          nullable: true
        connection_time:
          type: integer
          description: <em>time to connect to a server</em><br>the time it takes until the connection with a server is established (in milliseconds)
          nullable: true
        time_to_secure_connection:
          type: integer
          description: <em>time to establish a secure connection</em><br>the time it takes until the secure connection with a server is established (in milliseconds)
          nullable: true
        request_sent_time:
          type: integer
          description: <em>time to send a request to a server</em><br>the time it takes until the request to a server is sent (in milliseconds)
          nullable: true
        waiting_time:
          type: integer
          description: <em>time to first byte <a href="https://en.wikipedia.org/wiki/Time_to_first_byte">(TTFB)</a> in milliseconds</em>
          nullable: true
        download_time:
          type: integer
          description: <em>time it takes for a browser to receive a response (in milliseconds)</em>
          nullable: true
        duration_time:
          type: integer
          description: <em>total time it takes until a browser receives a complete response from a server (in milliseconds)</em>
          nullable: true
        fetch_start:
          type: integer
          description: <em>time to start downloading the HTML resource</em><br>the amount of time the browser needs to start downloading a page
          nullable: true
        fetch_end:
          type: integer
          description: <em>time to complete downloading the HTML resource</em><br>the amount of time the browser needs to complete downloading a page
          nullable: true
        resources:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/WaterfallResourceInfo'
            nullable: true
          description: <em>resource-specific timing</em><br>contains separate arrays with timing for each resource found on the page
          nullable: true
    OnPageWaterfallResultInfo:
      type: object
      properties:
        crawl_progress:
          type: string
          description: '<em>status of the crawling session</em><br>possible values: <code>in_progress</code>, <code>finished</code>'
          nullable: true
        crawl_status:
          type: object
          oneOf:
            - $ref: '#/components/schemas/CrawlStatusInfo'
          description: <em>details of the crawling session</em>
          nullable: true
        items_count:
          type: integer
          description: <em>number of items in the results array</em>
          format: int64
          nullable: true
        items:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/OnPageWaterfallItem'
            nullable: true
          description: <em>items array</em>
          nullable: true
    OnPageWaterfallTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/OnPageWaterfallResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    OnPageWaterfallResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/OnPageWaterfallTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    OnPageKeywordDensityRequestInfo:
      type: object
      properties:
        id:
          type: string
          description: <em>ID of the task</em><br><strong>required field</strong><br>you can get this ID in the response of the <a href="/v3/on_page/task_post/">Task POST</a> endpoint<br>example:<br>"07131248-1535-0216-1000-17384017ad04"
        keyword_length:
          type: integer
          description: '<em>number of words for a keyword</em><br><strong>required field</strong><br>possible values:<br><code>1</code>, <code>2</code>, <code>3</code>, <code>4</code>, <code>5</code>'
        url:
          type: string
          description: '<em>page URL</em><br>optional field<br><strong>if you do not specify a page here, the results will be provided for the whole website</strong><br>if you use this field, the API response will contain only keywords from the specified page<br>a page should be specified with absolute URL (including <code>http://</code> or <code>https://</code>)'
          nullable: true
        limit:
          type: integer
          description: '<em>the maximum number of returned keywords</em><br>optional field<br>default value: <code>100</code><br>maximum value: <code>1000</code>'
          nullable: true
        filters:
          type: array
          items:
            type: object
            nullable: true
          description: '<em>array of results filtering parameters</em><br>optional field<br><strong>you can add several filters at once (8 filters maximum)</strong><br>you should set a logical operator <code>and</code>, <code>or</code> between the conditions<br>the following operators are supported:<br><code>regex</code>, <code>not_regex</code>, <code>=</code>, <code>&lt;&gt;</code>, <code>in</code>, <code>not_in</code>, <code>like</code>, <code>not_like</code><br>you can use the <code>%</code> operator with <code>like</code> and <code>not_like</code> to match any string of zero or more characters<br>example:<br><code>["keyword","=","%seo%"]</code><p><code>[["keyword","=","%seo%"],<br>"and",<br>["frequency","&lt;","6"]]</code><p><code>[["keyword","not_like","%seo%"],<br>"and",<br>[["frequency","&gt;","6"],"or",["density","&gt;","0.02"]]]</code><p>The full list of possible filters is available <a href="/v3/on_page/filters_and_thresholds/?bash" target="_blank" rel="noopener noreferrer">by this link.</a>'
          nullable: true
        order_by:
          type: array
          items:
            type: string
          description: '<em>results sorting rules</em><br>optional field<br>you can use the same values as in the <code>filters</code> array to sort the results<br>possible sorting types:<br><code>asc</code> - results will be sorted in the ascending order<br><code>desc</code> - results will be sorted in the descending order<br>you should use a comma to set up a sorting type<br>example:<br><code>["frequency,desc"]</code><br><strong>note that you can set no more than three sorting rules in a single request</strong><br>you should use a comma to separate several sorting rules<br>example:<br><code>["keyword,asc","frequency,desc"]</code>'
          nullable: true
        tag:
          type: string
          description: <em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response
          nullable: true
      example:
        - id: 09101923-1535-0216-0000-2389a8854b70
          url: https://dataforseo.com/
          keyword_length: 2
          filters:
            - frequency
            - '>'
            - 5
    OnPageKeywordDensityItem:
      type: object
      properties:
        keyword:
          type: string
          description: <em>returned keyword</em>
          nullable: true
        frequency:
          type: integer
          description: <em>keyword frequency</em><br>number of times the keyword appears on the website (or webpage if you specified a <code>url</code>)
          nullable: true
        density:
          type: number
          description: <em>keyword density</em><br>calculated as a ratio of <code>frequency</code> to the total count of keywords with the set <code>keyword_length</code> on the web page or website
          nullable: true
    OnPageKeywordDensityResultInfo:
      type: object
      properties:
        crawl_progress:
          type: string
          description: '<em>status of the crawling session</em><br>possible values: <code>in_progress</code>, <code>finished</code>'
          nullable: true
        crawl_status:
          type: object
          oneOf:
            - $ref: '#/components/schemas/CrawlStatusInfo'
          description: <em>details of the crawling session</em>
          nullable: true
        total_items_count:
          type: integer
          description: <em>total number of relevant items</em><br>total number of keywords on the specified website or web page matching the set <code>keyword_length</code> and <code>filters</code>
          format: int64
          nullable: true
        items_count:
          type: integer
          description: <em>number of items in the results array</em>
          format: int64
          nullable: true
        items:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/OnPageKeywordDensityItem'
            nullable: true
          description: <em>items array</em>
          nullable: true
    OnPageKeywordDensityTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/OnPageKeywordDensityResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    OnPageKeywordDensityResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/OnPageKeywordDensityTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    OnPageMicrodataRequestInfo:
      type: object
      properties:
        id:
          type: string
          description: <em>ID of the task</em><br><strong>required field</strong><br>you can get this ID in the response of the <a href="/v3/on_page/task_post/">Task POST</a> endpoint<br>example:<br><code>"07131248-1535-0216-1000-17384017ad04"</code>
        url:
          type: string
          description: <em>resource URL</em><br><strong>required field</strong><br>you can get this URL in the response of the <a href="/v3/on_page/pages/">Pages</a> endpoint<br>example:<br><code>https://dataforseo.com/apis</code>
        tag:
          type: string
          description: <em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response
          nullable: true
      example:
        - id: 02241700-1535-0216-0000-034137259bc1
          url: https://dataforseo.com/apis
    TestSummary:
      type: object
      properties:
        fatal:
          type: integer
          description: <em>number of fatal microdata errors</em>
          nullable: true
        error:
          type: integer
          description: <em>number of serious microdata errors</em>
          nullable: true
        warning:
          type: integer
          description: <em>number of microdata warnings</em>
          nullable: true
        info:
          type: integer
          description: <em>number of microdata information flags</em>
          nullable: true
    MicrodataFieldsInfo:
      type: object
      properties:
        name:
          type: string
          description: <em>field name</em><br>name of the data field
          nullable: true
        types:
          type: array
          items:
            type: string
            nullable: true
          description: list of microdata types
          nullable: true
        value:
          type: string
          description: "microdata value\nmicrodata value specified on a target web page"
          nullable: true
        test_results:
          type: object
          oneOf:
            - $ref: '#/components/schemas/MessageInfo'
          description: <em>microdata validation test results</em><br>sub-type microdata test results that contain detected errors and related messages
          nullable: true
        fields:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/MicrodataFieldsInfo'
            nullable: true
          description: <em>microdata fields</em><br>an array of objects containing data fields related to the certain microdata type
          nullable: true
    MicrodataInspectionInfo:
      type: object
      properties:
        types:
          type: array
          items:
            type: string
            nullable: true
          description: '<em>parent microdata types</em><br>for a full list of available types, please visit <a href="https://schema.org/docs/full.html" rel="noopener noreferrer" target="_blank">schema.org</a>'
          nullable: true
        fields:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/MicrodataFieldsInfo'
            nullable: true
          description: <em>microdata fields</em><br>an array of objects containing data fields related to the certain microdata type
          nullable: true
    OnPageMicrodataInfoItem:
      type: object
      properties:
        type:
          type: string
          description: type of element
          nullable: true
        inspection_info:
          type: object
          oneOf:
            - $ref: '#/components/schemas/MicrodataInspectionInfo'
          description: <em>information related to microdata validation</em>
          nullable: true
    OnPageMicrodataResultInfo:
      type: object
      properties:
        crawl_progress:
          type: string
          description: '<em>status of the crawling session</em><br>possible values: <code>in_progress</code>, <code>finished</code>'
          nullable: true
        crawl_status:
          type: object
          oneOf:
            - $ref: '#/components/schemas/CrawlStatusInfo'
          description: <em>details of the crawling session</em>
          nullable: true
        test_summary:
          type: object
          oneOf:
            - $ref: '#/components/schemas/TestSummary'
          description: <em>microdata validation test results</em>
          nullable: true
        items_count:
          type: integer
          description: <em>number of items in the results array</em>
          format: int64
          nullable: true
        items:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/OnPageMicrodataInfoItem'
            nullable: true
          description: <em>items array</em>
          nullable: true
    OnPageMicrodataTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/OnPageMicrodataResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    OnPageMicrodataResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/OnPageMicrodataTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    OnPageUncrawlableResourcesRequestInfo:
      type: object
      properties:
        id:
          type: string
          description: <em>ID of the task</em><br><strong>required field</strong><br>you can get this ID in the response of the <a href="/v3/on_page/task_post/">Task POST</a> endpoint<br>example:<br>"07131248-1535-0216-1000-17384017ad04"
        limit:
          type: integer
          description: '<em>the maximum number of returned uncrawlable resources</em><br>optional field<br>default value: <code>100</code><br>maximum value: <code>1000</code>'
          nullable: true
        offset:
          type: integer
          description: '<em>offset in the results array of returned uncrawlable resources</em><br>optional field<br>default value: <code>0</code><br> maximum value: <code>2000000</code><br>if you specify the <code>10</code> value, the first ten invalid resources in the results array will be omitted and the data will be provided for the successive invalid resources'
          nullable: true
        order_by:
          type: array
          items:
            type: string
          description: '<em>results sorting rules</em><br>optional field<br>you can use the same values as in the <code>filters</code> array to sort the results<br>possible sorting types:<br><code>asc</code> - results will be sorted in the ascending order<br><code>desc</code> - results will be sorted in the descending order<br>you should use a comma to set up a sorting type<br>example:<br><code>["meta.content_type,desc"]</code><br><strong>note that you can set no more than three sorting rules in a single request</strong><br>you should use a comma to separate several sorting rules<br>example:<br><code>["meta.content_type,asc","fetch_time,desc"]</code>'
          nullable: true
        filters:
          type: array
          items:
            type: object
            nullable: true
          description: '<em>array of results filtering parameters</em><br>optional field<br><strong>you can add several filters at once (8 filters maximum)</strong><br>you should set a logical operator <code>and</code>, <code>or</code> between the conditions<br>the following operators are supported:<br><code>regex</code>, <code>not_regex</code>, <code>&lt;</code>, <code>&lt;=</code>, <code>&gt;</code>, <code>&gt;=</code>, <code>=</code>, <code>&lt;&gt;</code>, <code>in</code>, <code>not_in</code>, <code>like</code>, <code>not_like</code><br>you can use the <code>%</code> operator with <code>like</code> and <code>not_like</code> to match any string of zero or more characters<br>example:<br><code> [["meta.content_type","=","image/jpeg"],<br>"and",<br>["url","not_like","%/help-center/%"]]</code><p>The full list of possible filters is available <a href="/v3/on_page/filters_and_thresholds/?bash" target="_blank" rel="noopener noreferrer">by this link.</a>'
          nullable: true
      example:
        - id: 07281559-0695-0216-0000-c269be8b7592
          filters:
            - 
              - meta.content_type
              - =
              - image/jpeg
            - and
            - 
              - url
              - like
              - '%go%'
          limit: 10
    UncrawlableResourcesMeta:
      type: object
      properties:
        content_type:
          type: string
          description: <em>actual content type of the resource</em>
          nullable: true
        expected_content_types:
          type: array
          items:
            type: string
            nullable: true
          description: <em>expected content types for the resource</em><br>list of content types that were expected by the crawler based on how the resource is referenced on the page
          nullable: true
    OnPageUncrawlableResourcesItem:
      type: object
      properties:
        url:
          type: string
          description: <em>URL of the uncrawlable resource</em>
          nullable: true
        reason:
          type: string
          description: '<em>reason the resource is uncrawlable</em><br>can take the following values: <code>content_type_inconsistency</code>'
          nullable: true
        status_code:
          type: integer
          description: <i>general status code</i><br>you can find the full list of the response codes <a href="/v3/appendix/errors">here</a><br><strong>Note:</strong> we strongly recommend designing a necessary system for handling related exceptional or error conditions
          nullable: true
        fetch_time:
          type: string
          description: '<em>date and time when the resource was fetched</em><br>in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”<br>example:<br><code>2026-03-09 18:20:32 +00:00</code>'
          nullable: true
        meta:
          type: object
          oneOf:
            - $ref: '#/components/schemas/UncrawlableResourcesMeta'
          description: <em>metadata of the uncrawlable resource</em>
          nullable: true
    OnPageUncrawlableResourcesResultInfo:
      type: object
      properties:
        crawl_progress:
          type: string
          description: '<em>status of the crawling session</em><br>possible values: <code>in_progress</code>, <code>finished</code>'
          nullable: true
        crawl_status:
          type: object
          oneOf:
            - $ref: '#/components/schemas/CrawlStatusInfo'
          description: <em>details of the crawling session</em>
          nullable: true
        current_offset:
          type: integer
          nullable: true
        total_items_count:
          type: integer
          description: <em>total number of uncrawlable resources found</em><br> total number of uncrawlable resources found during the crawl of the target domain
          format: int64
          nullable: true
        items_count:
          type: integer
          description: <em>number of uncrawlable resources in the <code>items</code> array</em>
          format: int64
          nullable: true
        items:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/OnPageUncrawlableResourcesItem'
            nullable: true
          description: <em>array of uncrawlable resources</em>
          nullable: true
    OnPageUncrawlableResourcesTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/OnPageUncrawlableResourcesResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    OnPageUncrawlableResourcesResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/OnPageUncrawlableResourcesTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    OnPageRawHtmlRequestInfo:
      type: object
      properties:
        id:
          type: string
          description: <em>ID of the task</em><br><strong>required field</strong><br>you can get this ID in the response of the <a href="/v3/on_page/task_post/">Task POST</a> endpoint<br>example:<br>"07131248-1535-0216-1000-17384017ad04"
        url:
          type: string
          description: <em>page url</em><br><strong>required field</strong><br>the absolute URL of a page to request HTML<br><strong>Note:</strong> this field is optional if the task was set using the <a href="/v3/on_page/instant_pages/">Instant Pages endpoint</a>
      example:
        - id: 07281559-0695-0216-0000-c269be8b7592
          url: https://dataforseo.com/apis
    OnPageRawHtmlItem:
      type: object
      properties:
        html:
          type: string
          description: <i>HTML_</i><i>page</i>n
          nullable: true
    OnPageRawHtmlResultInfo:
      type: object
      properties:
        crawl_progress:
          type: string
          description: '<em>status of the crawling session</em><br>possible values: <code>in_progress</code>, <code>finished</code>'
          nullable: true
        crawl_status:
          type: object
          oneOf:
            - $ref: '#/components/schemas/CrawlStatusInfo'
          description: <em>details of the crawling session</em>
          nullable: true
        items_count:
          type: integer
          description: <em>number of items in the results array</em>
          format: int64
          nullable: true
        items:
          type: object
          oneOf:
            - $ref: '#/components/schemas/OnPageRawHtmlItem'
          description: <em>items object</em>
          nullable: true
    OnPageRawHtmlTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/OnPageRawHtmlResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    OnPageRawHtmlResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/OnPageRawHtmlTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    OnPagePageScreenshotRequestInfo:
      type: object
      properties:
        url:
          type: string
          description: '<em>page url</em><br><strong>required field</strong><br>absolute URL of the page to snap<br><strong>note:</strong> if the URL you indicate here returns a 404 status code or the indicated value is not a valid URL, you will obtain <code>"error_message":"Screenshot is empty"</code> in the response array'
        accept_language:
          type: string
          description: '<em>language header for accessing the website</em><br>optional field<br>all locale formats are supported (xx, xx-XX, xxx-XX, etc.)<br><strong>note:</strong> if you do not specify this parameter, some websites may deny access; in this case, you will obtain <code>"error_message":"Screenshot is empty"</code> in the response array'
          nullable: true
        custom_user_agent:
          type: string
          description: '<em>custom user agent</em><br>optional field<br>custom user agent for crawling a website<br>example: <code>Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_5) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/83.0.4103.116 Safari/537.36<br></code><br>default value: <code>Mozilla/5.0 (compatible; RSiteAuditor)</code>'
          nullable: true
        browser_preset:
          type: string
          description: '<em>preset for browser screen parameters</em><br>optional field<br>if you use this field, you don''t need to indicate <code>browser_screen_width</code>, <code>browser_screen_height</code>, <code>browser_screen_scale_factor</code><p>possible values:<br><code>desktop</code>, <code>mobile</code>, <code>tablet</code><p><code>desktop</code> preset will apply the following values:<p><code>browser_screen_width: 1920</code><br><code>browser_screen_height: 1080</code><br><code>browser_screen_scale_factor: 1</code><p><code>mobile</code> preset will apply the following values:<p><code>browser_screen_width: 390</code><br><code>browser_screen_height: 844</code><br><code>browser_screen_scale_factor: 3</code><p><code>tablet</code> preset will apply the following values:<p><code>browser_screen_width: 1024</code><br><code>browser_screen_height: 1366</code><br><code>browser_screen_scale_factor: 2</code><p><strong>Note:</strong> in this endpoint, the <code>enable_browser_rendering</code>, <code>enable_javascript</code>, <code>load_resources</code>, and <code>enable_xhr</code> parameters are always enabled.'
          nullable: true
        browser_screen_width:
          type: integer
          description: '<em>browser screen width</em><br>optional field<br>you can set a custom browser screen width to perform audit for a particular device;<br>if you use this field, you don''t need to indicate <code>browser_preset</code> as it will be ignored;<p>minimum value, in pixels: <code>240</code> <br>maximum value, in pixels: <code>9999</code>'
          format: int64
          nullable: true
        browser_screen_height:
          type: integer
          description: '<em>browser screen height</em><br>optional field<br>you can set a custom browser screen height to perform audit for a particular device;<br>if you use this field, you don''t need to indicate <code>browser_preset</code> as it will be ignored;<p>minimum value, in pixels: <code>240</code> <br>maximum value, in pixels: <code>9999</code>'
          nullable: true
        browser_screen_scale_factor:
          type: number
          description: '<em>browser screen scale factor</em><br>optional field<br>you can set a custom browser screen resolution ratio to perform audit for a particular device;<br>if you use this field, you don''t need to indicate <code>browser_preset</code> as it will be ignored;<p>minimum value: <code>0.5</code> <br>maximum value: <code>3</code>'
          nullable: true
        full_page_screenshot:
          type: boolean
          description: '<em>take a screenshot of the full page</em><br>optional field<br>set to <code>false</code> if you want to capture only the part of the page displayed before scrolling<br>default value: <code>true</code>'
          nullable: true
        disable_cookie_popup:
          type: boolean
          description: '<em>disable the cookie popup </em><br>optional field<br>set to <code>true</code> if you want to disable the popup requesting cookie consent from the user;<br>default value: <br><code>false</code>'
          nullable: true
        switch_pool:
          type: boolean
          description: '<em>switch proxy pool</em><br>optional field<br>if <code>true</code>, additional proxy pools will be used to obtain the requested data;<br>the parameter can be used if a multitude of tasks is set simultaneously, resulting in occasional <code>rate-limit</code> and/or <code>site_unreachable</code> errors'
          nullable: true
        ip_pool_for_scan:
          type: string
          description: '<em>proxy pool</em><br>optional field<br>you can choose a location of the proxy pool that will be used to obtain the requested data;<br>the parameter can be used if page content is inaccessible in one of the locations, resulting in occasional <code>site_unreachable</code> errors<br>possible values: <code>us</code>, <code>de</code>'
          nullable: true
      example:
        - url: https://dataforseo.com/apis
    OnPagePageScreenshotResultInfo:
      type: object
      properties:
        crawl_progress:
          type: string
          description: '<em>status of the crawling session</em><br>possible values: <code>in_progress</code>, <code>finished</code>'
          nullable: true
        error_message:
          type: string
          description: '<em>error message</em><br>if the <code>url</code> you indicated returns a 404 status code or is not a valid URL, you will obtain <code>"error_message":"Screenshot is empty"</code><br>if no error is encountered, the value will be <code>null</code>'
          nullable: true
        items_count:
          type: integer
          description: <em>number of items in the results array</em>
          format: int64
          nullable: true
        items:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/ScreenshotItem'
            nullable: true
          description: <em>items array</em>
          nullable: true
    OnPagePageScreenshotTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/OnPagePageScreenshotResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    OnPagePageScreenshotResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/OnPagePageScreenshotTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    OnPageContentParsingRequestInfo:
      type: object
      properties:
        url:
          type: string
          description: <em>URL of the content to parse</em><br><strong>required field</strong><br>URL of the page to parse<br>example:<br>`https://dataforseo.com/blog/a-versatile-alternative-to-google-trends-exploring-the-power-of-dataforseo-trends-api`
        id:
          type: string
          description: <em>ID of the task</em><br><strong>required field</strong><br>you can get this ID in the response of the <a href="/v3/on_page/task_post/">Task POST</a> endpoint<br><strong>note:</strong> the <code>enable_content_parsing</code> parameter in the POST request must be set to <code>true</code><br>example:<br><code>"07131248-1535-0216-1000-17384017ad04"</code>
        markdown_view:
          type: boolean
          description: '<em>return page content as markdown</em><br>optional field<br>if set to <code>true</code>, the markdown-formatted content of the page will be returned in the <code>page_as_markdown</code> field of the response;<br>default value: <code>false</code>'
          nullable: true
      example:
        - url: https://dataforseo.com/blog/a-versatile-alternative-to-google-trends-exploring-the-power-of-dataforseo-trends-api
          id: 11161551-1535-0216-0000-500b3f307f92
    PodcastsElement:
      type: object
      properties:
        type:
          type: string
          description: type of element
          nullable: true
        title:
          type: string
          description: title of the row
          nullable: true
        url:
          type: string
          description: URL of element
          nullable: true
        description:
          type: string
          description: description of the results element in SERP
          nullable: true
        timestamp:
          type: string
          description: "date and time when the result was published\nin the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”\nexample:\n2019-11-15 12:57:46 +00:00"
          nullable: true
        time_to_play:
          type: string
          description: the total time it will take to play an episode
          nullable: true
    PageSectionContentInfo:
      type: object
      properties:
        primary_content:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/SectionContentItemInfo'
            nullable: true
          description: <em>primary content on the page</em><br>            you can find more information about content priority calculation in this <a href="https://dataforseo.com/help-center/difference-between-primary-and-secondary-content" rel="noopener noreferrer" target="_blank">help center article</a><br>
          nullable: true
        secondary_content:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/SectionContentItemInfo'
            nullable: true
          description: <em>secondary content on the page</em><br>            you can find more information about content priority calculation in this <a href="https://dataforseo.com/help-center/difference-between-primary-and-secondary-content" rel="noopener noreferrer" target="_blank">help center article</a><br>
          nullable: true
        table_content:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/TableContentInfo'
            nullable: true
          description: <em>content of the table on the page</em><br>
          nullable: true
    TopicInfo:
      type: object
      properties:
        h_title:
          type: string
          description: <em>meta title</em><br>
          nullable: true
        main_title:
          type: string
          description: <em>  main title of the block</em><br>
          nullable: true
        author:
          type: string
          description: <em>content author name</em><br>
          nullable: true
        language:
          type: string
          description: <em>content language</em><br>
          nullable: true
        level:
          type: integer
          description: <em>HTML level</em><br>
          nullable: true
        primary_content:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/SectionContentItemInfo'
            nullable: true
          description: <em>primary content on the page</em><br>            you can find more information about content priority calculation in this <a href="https://dataforseo.com/help-center/difference-between-primary-and-secondary-content" rel="noopener noreferrer" target="_blank">help center article</a><br>
          nullable: true
        secondary_content:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/SectionContentItemInfo'
            nullable: true
          description: <em>secondary content on the page</em><br>            you can find more information about content priority calculation in this <a href="https://dataforseo.com/help-center/difference-between-primary-and-secondary-content" rel="noopener noreferrer" target="_blank">help center article</a><br>
          nullable: true
        table_content:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/TableContentInfo'
            nullable: true
          description: <em>content of the table on the page</em><br>
          nullable: true
    Contacts:
      type: object
      properties:
        telephones:
          type: array
          items:
            type: string
            nullable: true
          description: <em>array of telephone numbers</em><br>
          nullable: true
        emails:
          type: array
          items:
            type: string
            nullable: true
          description: <em>array of emails</em><br>
          nullable: true
    PageContentInfo:
      type: object
      properties:
        header:
          type: object
          oneOf:
            - $ref: '#/components/schemas/PageSectionContentInfo'
          description: <em>parsed content of the header</em><br>
          nullable: true
        footer:
          type: object
          oneOf:
            - $ref: '#/components/schemas/PageSectionContentInfo'
          description: <em>content of the footer of the table</em><br>
          nullable: true
        main_topic:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/TopicInfo'
            nullable: true
          description: <em>main topic on the page</em><br>            you can find more information about topic priority calculation in this <a href="https://dataforseo.com/help-center/difference-between-primary-and-secondary-content#topics" rel="noopener noreferrer" target="_blank">help center article</a><br>
          nullable: true
        secondary_topic:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/TopicInfo'
            nullable: true
          description: <em>secondary topic on the page</em><br>            you can find more information about topic priority calculation in this <a href="https://dataforseo.com/help-center/difference-between-primary-and-secondary-content#topics" rel="noopener noreferrer" target="_blank">help center article</a><br>
          nullable: true
        ratings:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/ContententRatingInfo'
            nullable: true
          description: <em>contains objects with rating information for the products displayed on the page</em><br>
          nullable: true
        offers:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/ContentOfferInfo'
            nullable: true
          description: <em>array of products displayed on the page</em><br>            contains objects with information on products displayed on the page
          nullable: true
        comments:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/ContentCommentInfo'
            nullable: true
          description: <em>array of comments displayed on the page</em><br>            contains objects with information on comments related to displayed products
          nullable: true
        contacts:
          type: object
          oneOf:
            - $ref: '#/components/schemas/Contacts'
          description: <em>contact information</em><br>            contains contact information displayed on the page
          nullable: true
    ContentParsingElement:
      type: object
      properties:
        type:
          type: string
          description: type of element
          nullable: true
        fetch_time:
          type: string
          description: <em>date and time when the content was fethced</em><br>            example:<br>            <code>"2022-11-01 10:02:52 +00:00"</code>
          nullable: true
        status_code:
          type: integer
          description: <i>general status code</i><br>            you can find the full list of the response codes <a href="/v3/appendix/errors">here</a><br>            <strong>Note:</strong> we strongly recommend designing a necessary system for handling related exceptional or error conditions
          nullable: true
        page_content:
          type: object
          oneOf:
            - $ref: '#/components/schemas/PageContentInfo'
          description: <em>parsed content of the page</em><br>
          nullable: true
        page_as_markdown:
          type: string
          description: <em>page content in the markdown format</em><br>            page content in the <a href="https://daringfireball.net/projects/markdown/" target="_blank">text-to-HTML markdown format</a><br>            specify <code>markdown_view</code> as <code>true</code> in the request to return the value
          nullable: true
    OnPageContentParsingResultInfo:
      type: object
      properties:
        crawl_progress:
          type: string
          description: '<em>status of the crawling session</em><br>            possible values: <code>in_progress</code>, <code>finished</code>'
          nullable: true
        crawl_status:
          type: object
          oneOf:
            - $ref: '#/components/schemas/CrawlStatusInfo'
          description: <em>details of the crawling session</em>
          nullable: true
        items_count:
          type: integer
          description: <em>number of items in the results array</em><br>
          format: int64
          nullable: true
        items:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/ContentParsingElement'
            nullable: true
          description: <em>items array</em><br>
          nullable: true
    OnPageContentParsingTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/OnPageContentParsingResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    OnPageContentParsingResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/OnPageContentParsingTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    OnPageContentParsingLiveRequestInfo:
      type: object
      properties:
        url:
          type: string
          description: <em>URL of the content to parse</em><br><strong>required field</strong><br>URL of the page to parse<br>example:<br>`https://www.fujielectric.com/`
        custom_user_agent:
          type: string
          description: '<em>custom user agent</em><br>optional field<br>custom user agent for crawling a website<br>example: <code>Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_5) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/83.0.4103.116 Safari/537.36<br></code><br>default value: <code>Mozilla/5.0 (compatible; RSiteAuditor)</code>'
          nullable: true
        browser_preset:
          type: string
          description: '<em>preset for browser screen parameters</em><br>optional field<br>if you use this field, you don''t need to indicate <code>browser_screen_width</code>, <code>browser_screen_height</code>, <code>browser_screen_scale_factor</code><p>            possible values:<br><code>desktop</code>, <code>mobile</code>, <code>tablet</code><p>            <code>desktop</code> preset will apply the following values:<p>            <code>browser_screen_width: 1920</code><br><code>browser_screen_height: 1080</code><br><code>browser_screen_scale_factor: 1</code><p>            <code>mobile</code> preset will apply the following values:<p>            <code>browser_screen_width: 390</code><br><code>browser_screen_height: 844</code><br><code>browser_screen_scale_factor: 3</code><p>            <code>tablet</code> preset will apply the following values:<p>            <code>browser_screen_width: 1024</code><br><code>browser_screen_height: 1366</code><br><code>browser_screen_scale_factor: 2</code><p>            <strong>Note:</strong> to use this parameter, set <code>enable_javascript</code> or <code>enable_browser_rendering</code> to <code>true</code>'
          nullable: true
        browser_screen_width:
          type: integer
          description: '<em>browser screen width</em><br>optional field<br>you can set a custom browser screen width to perform audit for a particular device;<br>if you use this field, you don''t need to indicate <code>browser_preset</code> as it will be ignored;<p>            <strong>Note:</strong> to use this parameter, set <code>enable_javascript</code> or <code>enable_browser_rendering</code> to <code>true</code><p>            minimum value, in pixels: <code>240</code><br>maximum value, in pixels: <code>9999</code>'
          format: int64
          nullable: true
        browser_screen_height:
          type: integer
          description: '<em>browser screen height</em><br>optional field<br>you can set a custom browser screen height to perform audit for a particular device;<br>if you use this field, you don''t need to indicate <code>browser_preset</code> as it will be ignored;<p>            <strong>Note:</strong> to use this parameter, set <code>enable_javascript</code> or <code>enable_browser_rendering</code> to <code>true</code><p>            minimum value, in pixels: <code>240</code><br>maximum value, in pixels: <code>9999</code>'
          nullable: true
        browser_screen_scale_factor:
          type: number
          description: '<em>browser screen scale factor</em><br>optional field<br>you can set a custom browser screen resolution ratio to perform audit for a particular device;<br>if you use this field, you don''t need to indicate <code>browser_preset</code> as it will be ignored;<p>            <strong>Note:</strong> to use this parameter, set <code>enable_javascript</code> or <code>enable_browser_rendering</code> to <code>true</code><p>            minimum value: <code>0.5</code><br>maximum value: <code>3</code>'
          nullable: true
        store_raw_html:
          type: boolean
          description: '<em>store HTML of a crawled page</em><br>optional field<br>set to <code>true</code> if you want to get the HTML of the page using the <a href="/v3/on_page/raw_html/" target="_blank" rel="noopener noreferrer">OnPage Raw HTML endpoint</a><br>default value: <code>false</code>'
          nullable: true
        disable_cookie_popup:
          type: boolean
          description: <em>disable the cookie popup </em><br>optional field<br>set to <code>true</code> if you want to disable the popup requesting cookie consent from the user;<br>default value:<br><code>false</code>
          nullable: true
        accept_language:
          type: string
          description: '<em>language header for accessing the website</em><br>optional field<br>all locale formats are supported (xx, xx-XX, xxx-XX, etc.)<br><strong>Note:</strong> if you do not specify this parameter, some websites may deny access; in this case, pages will be returned with the <code>"type":"broken</code> in the response array'
          nullable: true
        enable_javascript:
          type: boolean
          description: '<em>load javascript on a page</em><br>optional field<br>set to <code>true</code> if you want to load the scripts available on a page<br>default value: <code>false</code><br><strong>Note:</strong> if you use this parameter, additional charges will apply; learn more about the cost of tasks with this parameter <a href="https://dataforseo.com/help-center/cost-of-onpage-api-parameters" rel="noopener noreferrer" target="_blank">in our help article</a>; the cost can be calculated on the <a href="https://dataforseo.com/pricing/on-page/onpage-api" target="_blank" rel="noopener noreferrer">Pricing Page</a>'
          nullable: true
        enable_browser_rendering:
          type: boolean
          description: '<em>emulate browser rendering to measure Core Web Vitals</em><br>optional field<br>by using this parameter you will be able to emulate a browser when loading a web page;<br><code>enable_browser_rendering</code> loads styles, images, fonts, animations, videos, and other resources on a page;<br>default value: <code>false</code><br>set to <code>true</code> to obtain Core Web Vitals (FID, CLS, LCP) metrics in the response;<br><strong>if you use this field, <code>enable_javascript</code>, and <code>load_resources</code> parameters must be set to <code>true</code></strong><br><strong>Note:</strong> if you use this parameter, additional charges will apply; learn more about the cost of tasks with this parameter <a href="https://dataforseo.com/help-center/cost-of-onpage-api-parameters" rel="noopener noreferrer" target="_blank">in our help article</a>; the cost can be calculated on the <a href="https://dataforseo.com/pricing/on-page/onpage-api" rel="noopener noreferrer" target="_blank">Pricing Page</a>'
          nullable: true
        enable_xhr:
          type: boolean
          description: '<em>enable XMLHttpRequest on a page</em><br>optional field<br>set to <code>true</code> if you want our crawler to request data from a web server using the XMLHttpRequest object<br>default value:<br><code>false</code><p>            if you use this field, <code>enable_javascript</code> must be set to <code>true</code>;'
          nullable: true
        switch_pool:
          type: boolean
          description: '<em>switch proxy pool</em><br>optional field<br>if <code>true</code>, additional proxy pools will be used to obtain the requested data;<br>the parameter can be used if a multitude of tasks is set simultaneously, resulting in occasional <code>rate-limit</code> and/or <code>site_unreachable</code> errors'
          nullable: true
        ip_pool_for_scan:
          type: string
          description: '<em>proxy pool</em><br>optional field<br>you can choose a location of the proxy pool that will be used to obtain the requested data;<br>the parameter can be used if page content is inaccessible in one of the locations, resulting in occasional <code>site_unreachable</code> errors<br>possible values: <code>us</code>, <code>de</code>'
          nullable: true
        markdown_view:
          type: boolean
          description: '<em>return page content as markdown</em><br>optional field<br>if set to <code>true</code>, the markdown-formatted content of the page will be returned in the <code>page_as_markdown</code> field of the response;<br>default value: <code>false</code>'
          nullable: true
      example:
        - url: https://dataforseo.com/blog/a-versatile-alternative-to-google-trends-exploring-the-power-of-dataforseo-trends-api
    OnPageContentParsingLiveResultInfo:
      type: object
      properties:
        crawl_progress:
          type: string
          description: '<em>status of the crawling session</em><br>possible values: <code>in_progress</code>, <code>finished</code>'
          nullable: true
        crawl_status:
          type: object
          oneOf:
            - $ref: '#/components/schemas/CrawlStatusInfo'
          description: <em>details of the crawling session</em>
          nullable: true
        items_count:
          type: integer
          description: <em>number of items in the results array</em>
          format: int64
          nullable: true
        items:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/ContentParsingElement'
            nullable: true
          description: <em>items array</em>
          nullable: true
    OnPageContentParsingLiveTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/OnPageContentParsingLiveResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    OnPageContentParsingLiveResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/OnPageContentParsingLiveTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    OnPageInstantPagesRequestInfo:
      type: object
      properties:
        url:
          type: string
          description: 'target page urlrequired fieldabsolute URL of the target page;Note #1: results will be returned for the specified URL only;Note #2: to prevent denial-of-service events, tasks that contain a duplicate crawl host will be returned with a 40501 error;to prevent this error from occurring, avoid setting tasks with the same domain if at least one of your previous tasks with this domain (including a page URL on the domain) is still in a crawling queue'
        custom_user_agent:
          type: string
          description: 'custom user agentoptional fieldcustom user agent for crawling a websiteexample: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_5) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/83.0.4103.116 Safari/537.36default value: Mozilla/5.0 (compatible; RSiteAuditor)'
          nullable: true
        browser_preset:
          type: string
          description: 'preset for browser screen parametersoptional fieldif you use this field, you don''t need to indicate browser_screen_width, browser_screen_height, browser_screen_scale_factorpossible values:desktop, mobile, tabletdesktop preset will apply the following values:browser_screen_width: 1920browser_screen_height: 1080browser_screen_scale_factor: 1mobile preset will apply the following values:browser_screen_width: 390browser_screen_height: 844browser_screen_scale_factor: 3tablet preset will apply the following values:browser_screen_width: 1024browser_screen_height: 1366browser_screen_scale_factor: 2Note: to use this parameter, set enable_javascript or enable_browser_rendering to true'
          nullable: true
        browser_screen_width:
          type: integer
          description: 'browser screen widthoptional fieldyou can set a custom browser screen width to perform audit for a particular device;if you use this field, you don''t need to indicate browser_preset as it will be ignored;Note: to use this parameter, set enable_javascript or enable_browser_rendering to trueminimum value, in pixels: 240maximum value, in pixels: 9999'
          format: int64
          nullable: true
        browser_screen_height:
          type: integer
          description: 'browser screen heightoptional fieldyou can set a custom browser screen height to perform audit for a particular device;if you use this field, you don''t need to indicate browser_preset as it will be ignored;Note: to use this parameter, set enable_javascript or enable_browser_rendering to trueminimum value, in pixels: 240maximum value, in pixels: 9999'
          nullable: true
        browser_screen_scale_factor:
          type: number
          description: 'browser screen scale factoroptional fieldyou can set a custom browser screen resolution ratio to perform audit for a particular device;if you use this field, you don''t need to indicate browser_preset as it will be ignored;Note: to use this parameter, set enable_javascript or enable_browser_rendering to trueminimum value: 0.5maximum value: 3'
          nullable: true
        store_raw_html:
          type: boolean
          description: 'store HTML of a crawled pageoptional fieldset to true if you want get the HTML of the page using the OnPage Raw HTML endpointdefault value: false'
          nullable: true
        accept_language:
          type: string
          description: 'language header for accessing the websiteoptional fieldall locale formats are supported (xx, xx-XX, xxx-XX, etc.)Note: if you do not specify this parameter, some websites may deny access; in this case, pages will be returned with the "type":"broken in the response array'
          nullable: true
        load_resources:
          type: boolean
          description: 'load resourcesoptional fieldset to true if you want to load image, stylesheets, scripts, and broken resourcesdefault value: falseNote: if you use this parameter, additional charges will apply; learn more about the cost of tasks with this parameter in our help article; the cost can be calculated on the Pricing Page'
          nullable: true
        enable_browser_rendering:
          type: boolean
          description: 'emulate browser rendering to measure Core Web Vitalsoptional fieldby using this parameter you will be able to emulate a browser when loading a web page;enable_browser_rendering loads styles, images, fonts, animations, videos, and other resources on a page;default value: falseset to true to obtain Core Web Vitals (FID, CLS, LCP) metrics in the response;if you use this field, parameters enable_javascript, and load_resources are enabled automatically;Note: if you use this parameter, additional charges will apply; learn more about the cost of tasks with this parameter in our help article; the cost can be calculated on the Pricing Page'
          nullable: true
        disable_cookie_popup:
          type: boolean
          description: disable the cookie popup optional fieldset to true if you want to disable the popup requesting cookie consent from the user;default value:false
          nullable: true
        return_despite_timeout:
          type: boolean
          description: 'return data on pages despite the timeout erroroptional fieldif true, the data will be provided on pages that failed to load within 120 seconds and responded with a timeout error;default value: false'
          nullable: true
        enable_javascript:
          type: boolean
          description: 'load javascript on a pageoptional fieldset to true if you want to load the scripts available on a pagedefault value: falseNote: if you use this parameter, additional charges will apply; learn more about the cost of tasks with this parameter in our help article; the cost can be calculated on the Pricing Page'
          nullable: true
        enable_xhr:
          type: boolean
          description: 'enable XMLHttpRequest on a pageoptional fieldset to true if you want our crawler to request data from a web server using the XMLHttpRequest objectdefault value:falseif you use this field, enable_javascript must be set to true;'
          nullable: true
        custom_js:
          type: string
          description: 'custom javascriptoptional fieldNote that the execution time for the script you enter here should be 700 ms maximum;for example, you can use the following JS snippet to check if the website contains Google Tag Manager as a scr attribute:let meta = { haveGoogleAnalytics: false, haveTagManager: false };rnfor (var i = 0; i < document.scripts.length; i++) {rn let src = document.scripts[i].getAttribute("src");rn if (src != undefined) {rn if (src.indexOf("analytics.js") >= 0)rn      meta.haveGoogleAnalytics = true;rntif (src.indexOf("gtm.js") >= 0)rn      meta.haveTagManager = true;rn  }rn}rnmeta;the returned value depends on what you specified in this field. For instance, if you specify the following script:meta = {}; meta.url = document.URL; meta.test = ''test''; meta;as a response you will receive the following data:"custom_js_response": {"url": "https://dataforseo.com/","test": "test"}'
          nullable: true
        validate_micromarkup:
          type: boolean
          description: 'enable microdata validationoptional fieldif set to true, you can use the OnPage API Microdata endpoint with the id of the task;default value: false'
          nullable: true
        check_spell:
          type: boolean
          description: 'check spellingoptional fieldset to true to check spelling on a website using Hunspell librarydefault value: false'
          nullable: true
        checks_threshold:
          type: object
          additionalProperties:
            type: integer
            format: int64
            nullable: true
          description: 'custom threshold values for checksoptional fieldyou can specify custom threshold values for the parameters included in the checks array of OnPage API responses;Note: only integer threshold values can be modified;'
          nullable: true
        switch_pool:
          type: boolean
          description: 'switch proxy pooloptional fieldif true, additional proxy pools will be used to obtain the requested data;the parameter can be used if a multitude of tasks is set simultaneously, resulting in occasional rate-limit and/or site_unreachable errors'
          nullable: true
        ip_pool_for_scan:
          type: string
          description: 'proxy pooloptional fieldyou can choose a location of the proxy pool that will be used to obtain the requested data;the parameter can be used if page content is inaccessible in one of the locations, resulting in occasional site_unreachable errorspossible values: us, de'
          nullable: true
      example:
        - url: https://dataforseo.com/blog
          enable_javascript: true
          custom_js: 'meta = {}; meta.url = document.URL; meta;'
    OnPageInstantPagesResultInfo:
      type: object
      properties:
        crawl_progress:
          type: string
          description: 'status of the crawling sessionpossible values: in_progress, finished'
          nullable: true
        crawl_status:
          type: object
          description: details of the crawling sessionin this case the value will be null
          nullable: true
        crawl_gateway_address:
          type: string
          description: crawler ip addressdisplays the IP address used by the crawler to initiate the current crawling sessionyou can find the full list of IPs used by our crawler in the Overview section
          nullable: true
        items_count:
          type: integer
          description: number of items in the results array
          format: int64
          nullable: true
        items:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/OnPageHtmlResourceItem'
            nullable: true
          description: items array
          nullable: true
    OnPageInstantPagesTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/OnPageInstantPagesResultInfo'
                nullable: true
              description: array of results
              nullable: true
    OnPageInstantPagesResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/OnPageInstantPagesTaskInfo'
                nullable: true
              description: array of tasks
              nullable: true
    OnPageLighthouseLanguagesResultInfo:
      type: object
      properties:
        language_name:
          type: string
          description: <em>language name</em>
          nullable: true
        language_code:
          type: string
          description: <em>language code according to <a href="https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes" target="_blank" rel="noopener noreferrer">ISO 639-1</a></em>
          nullable: true
    OnPageLighthouseLanguagesTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/OnPageLighthouseLanguagesResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    OnPageLighthouseLanguagesResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/OnPageLighthouseLanguagesTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    OnPageLighthouseAuditsResultInfo:
      type: object
      properties:
        audits:
          type: array
          items:
            type: string
            nullable: true
          description: '<em>the list of available lighthouse audits</em><br>an array containing the titles of available audits;<br><strong>Note:</strong> the titles can change depending on if the audit passed or failed and may contain markdown code;<br><strong>Note #2:</strong> if you''re using the audit that contains a slash (<code>/</code>) in its name, search by the last word after the slash'
          nullable: true
    OnPageLighthouseAuditsTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/OnPageLighthouseAuditsResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    OnPageLighthouseAuditsResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/OnPageLighthouseAuditsTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    AvailibleVersions:
      type: object
      properties:
        version:
          type: string
          description: <em>lighthouse version</em>
          nullable: true
        default:
          type: boolean
          description: '<em>the version is used by default</em><br>if <code>false</code>, the version is not used by default and should be specified in the corresponding field of the POST request if necessary'
          nullable: true
    OnPageLighthouseVersionsResultInfo:
      type: object
      properties:
        availible_versions:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/AvailibleVersions'
            nullable: true
          nullable: true
    OnPageLighthouseVersionsTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/OnPageLighthouseVersionsResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    OnPageLighthouseVersionsResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/OnPageLighthouseVersionsTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    OnPageLighthouseTaskPostRequestInfo:
      type: object
      properties:
        url:
          type: string
          description: <em>target URL</em><br><strong>required field</strong><br>target page should be specified with its absolute URL (including http:// or https://)<br>example:<br><code>https://dataforseo.com/</code>
        for_mobile:
          type: boolean
          description: '<em>applies mobile emulation</em><br>optional field<br>if set to <code>true</code>, Lighthouse will use mobile device and screen emulation to test the page against mobile environment<br>if set to <code>false</code>, the results will be provided for desktop<br>default value: <code>false</code>'
          nullable: true
        categories:
          type: array
          items:
            type: string
          description: '<em>categories of Lighthouse audits</em><br>optional field<br>each category is a collection of audits and audit groups that applies weighting and scoring to the section (<a href="https://github.com/GoogleChrome/lighthouse/blob/master/docs/architecture.md#auditreport-terminology" target="_blank" rel="noopener noreferrer">see official definition</a>)<strong>if you ignore this field, we will return data for all categories unless you specify <code>audits</code></strong><br>use this field to get data for specific categories you indicate here<p>possible values:<br><code>seo</code>, <code>performance</code>, <code>best_practices</code>, <code>accessibility</code>'
          nullable: true
        audits:
          type: array
          items:
            type: string
          description: '<em>Lighthouse audits</em><br>optional field<br>audits are individual tests Lighthouse runs for each specific feature/optimization/metric to produce a numeric score (<a href="https://github.com/GoogleChrome/lighthouse/blob/master/docs/architecture.md#components--terminology" target="_blank" rel="noopener noreferrer">see official definition</a>)<strong>if you ignore this field, we will return data for all audits</strong><br>use this field to get data for specific audits you indicate here<p><strong>note</strong> that some audits do not belong to a specific category and are stand-alone page quality measurements<p>in general, there can be several use cases:<p>1. if you ignore <code>categories</code>, you can use this field to get data for the specified audits only<br>for example, if you ignore <code>"categories"</code> and specify <code>"audits": ["metrics/cumulative-layout-shift","metrics/largest-contentful-paint","metrics/total-blocking-time"]</code>, you will get data only for these audits<p>2. if you specify a category, you can use this field to additionally receive audits that do not belong to the category(-ies) you specified<br>for example, if you specify <code>"categories": ["seo"]</code> and <code>"audits": ["metrics/cumulative-layout-shift","metrics/largest-contentful-paint","metrics/total-blocking-time"]</code>, you will get only these audits under "performance" and all audits under "seo"<p>you can get <a href="/v3/on_page/lighthouse/audits/">the full list of possible audits here</a>'
          nullable: true
        version:
          type: string
          description: <em>lighthouse version</em><br>optional field<br>you can obtain the results specific to a certain Lighthouse version by specifying its number<br>the list of available versions is available through the <a href="/v3/on_page/lighthouse/versions/" target="_blank" rel="noopener noreferrer">Lighthouse Versions endpoint</a>
          nullable: true
        language_name:
          type: string
          description: <em>lighthouse language name</em><br>optional field<br>you can receive the list of available languages of the search engine with their <code>language_name</code> by making a separate request to <code>https://api.dataforseo.com/v3/on_page/lighthouse/languages</code><br>default value:<br><code class="long-string">English</code>
          nullable: true
        language_code:
          type: string
          description: <em>lighthouse language code</em><br>optional field<br>you can receive the list of available languages of the search engine with their <code>language_code</code> by making a separate request to <code>https://api.dataforseo.com/v3/on_page/lighthouse/languages</code><br>default value:<br><code class="long-string">en</code>
          nullable: true
        custom_user_agent:
          type: string
          description: <em>custom user agent</em><br>optional field<br>specify the custom user agent used by the browser when running the Lighthouse audit;<br>can be specified with up to 254 characters;
          nullable: true
        browser_screen_width:
          type: integer
          description: '<em>browser screen width</em><br>optional field<br>set the screen width of the browser used for the Lighthouse audit to emulate a specific device;<br>can be specified within the following range: <code>240–9999</code>;'
          format: int64
          nullable: true
        browser_screen_height:
          type: integer
          description: '<em>browser screen height</em><br>optional field<br>set the screen height of the browser used for the Lighthouse audit to emulate a specific device;<br>can be specified within the following range: <code>240–9999</code>;'
          nullable: true
        browser_screen_scale_factor:
          type: number
          description: '<em>browser screen scale factor</em><br>optional field<br>set the device pixel ratio of the browser used for the Lighthouse audit;<br>can be specified within the following range: <code>0.5–3</code>;'
          nullable: true
        browser_network_throttling_method:
          type: string
          description: <em>browser network throttling method</em><br>optional field<br>defines the method used to apply throttling during the Lighthouse audit;<br>possible vaules:<br><code>simulate</code> - calculates estimated performance metrics without applying explicit throttling;<br><code>devtools</code> -  applies the throttling settings specified in <code>browser_network_throttling</code> and <code>browser_cpu_throttling_multiplier</code>;<br><code>provided</code> - uses the network conditions of the crawling environment;
          nullable: true
        browser_cpu_throttling_multiplier:
          type: number
          description: '<em>browser CPU throttling multiplier</em><br><strong>required if <code>browser_network_throttling_method</code> is set to <code>devtools</code>;</strong><br>set the CPU throttling multiplier to simulate device performance conditions during the Lighthouse audit;<br>can be specified within the following range: <code>1–4</code>;<br><strong>Note:</strong> this parameter is applied only when <code>browser_network_throttling_method</code> is set to <code>devtools</code>;'
          nullable: true
        browser_network_throttling:
          type: string
          description: '<em>browser network throttling</em><br><strong>required if <code>browser_network_throttling_method</code> is set to <code>devtools</code>;</strong><br>set the network throttling profile to simulate connection speed conditions during the Lighthouse audit;<br>possible values: <code>no_throttling</code>, <code>fast_4g</code>, <code>slow_4g</code>, <code>regular_3g</code>, <code>pc</code>;<br><strong>Note:</strong> this parameter is applied only when <code>browser_network_throttling_method</code> is set to <code>devtools</code>;'
          nullable: true
        tag:
          type: string
          description: <em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response
          nullable: true
        pingback_url:
          type: string
          description: '<em>notification URL of a completed task</em><br>optional field<br>when a task is completed we will notify you by GET request sent to the URL you have specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/pingscript?id=$id</code><br><code>http://your-server.com/pingscript?id=$id&amp;tag=$tag</code><br><strong>Note:</strong> special characters in <code>pingback_url</code> will be urlencoded;<br>i.a., the <code>#</code> character will be encoded into <code>%23</code>learn more on our <a href="https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api" target="_blank" rel="noopener noreferrer">Help Center</a>'
          nullable: true
      example:
        - url: https://dataforseo.com
          for_mobile: true
          tag: some_string_123
          pingback_url: https://your-server.com/pingscript?id=$id&tag=$tag
    OnPageLighthouseTaskPostTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                additionalProperties:
                  type: object
                  nullable: true
                nullable: true
              nullable: true
    OnPageLighthouseTaskPostResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/OnPageLighthouseTaskPostTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    OnPageLighthouseTasksReadyResultInfo:
      type: object
      properties:
        id:
          type: string
          description: <em>task identifier of the completed task</em><br><strong>unique task identifier in our system in the <a href="https://en.wikipedia.org/wiki/Universally_unique_identifier">UUID</a> format</strong>
          nullable: true
        tag:
          type: string
          description: <em>user-defined task identifier</em>
          nullable: true
        endpoint_json:
          type: string
          description: <em>URL for collecting the results of the OnPage Lighthouse JSON task</em>
          nullable: true
    OnPageLighthouseTasksReadyTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/OnPageLighthouseTasksReadyResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    OnPageLighthouseTasksReadyResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/OnPageLighthouseTasksReadyTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    OnPageLighthouseTaskGetJsonTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                additionalProperties:
                  type: object
                  nullable: true
                nullable: true
              description: <em>results of Lighthouse audit</em><br>this array will include data according to the parameters specified in the POST request;<p>description of the fields in the <code>result</code> array is available in the <a href="https://github.com/GoogleChrome/lighthouse/blob/master/readme.md">official documentation</a>
              nullable: true
    OnPageLighthouseTaskGetJsonResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/OnPageLighthouseTaskGetJsonTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    OnPageLighthouseLiveJsonRequestInfo:
      type: object
      properties:
        url:
          type: string
          description: <em>target URL</em><br><strong>required field</strong><br>target page should be specified with its absolute URL (including http:// or https://)<br>example:<br><code>https://dataforseo.com/</code>
        for_mobile:
          type: boolean
          description: '<em>applies mobile emulation</em><br>optional field<br>if set to <code>true</code>, Lighthouse will use mobile device and screen emulation to test the page against mobile environment<br>if set to <code>false</code>, the results will be provided for desktop<br>default value: <code>false</code>'
          nullable: true
        categories:
          type: array
          items:
            type: string
          description: '<em>categories of Lighthouse audits</em><br>optional field<br>each category is a collection of audits and audit groups that applies weighting and scoring to the section (<a href="https://github.com/GoogleChrome/lighthouse/blob/master/docs/architecture.md#auditreport-terminology" rel="noopener noreferrer" target="_blank">see official definition</a>)<p><strong>if you ignore this field, we will return data for all categories unless you specify <code>audits</code></strong><br>use this field to get data for specific categories you indicate here<p>possible values:<br><code>seo</code>, <code>performance</code>, <code>best_practices</code>, <code>accessibility</code>'
          nullable: true
        audits:
          type: array
          items:
            type: string
          description: '<em>Lighthouse audits</em><br>optional field<br>audits are individual tests Lighthouse runs for each specific feature/optimization/metric to produce a numeric score (<a href="https://github.com/GoogleChrome/lighthouse/blob/master/docs/architecture.md#components--terminology" rel="noopener noreferrer" target="_blank">see official definition</a>);  <p><strong>if you ignore this field, we will return data for all audits</strong>;<br>use this field to get data for specific audits you indicate here;<p><strong>Note:</strong> that some audits do not belong to a specific category and are stand-alone page quality measurements;<p>in general, there can be several use cases:<p>1. if you ignore <code>categories</code>, you can use this field to get data for the specified audits only<br>for example, if you ignore <code>"categories"</code> and specify <code>"audits": ["metrics/cumulative-layout-shift","metrics/largest-contentful-paint","metrics/total-blocking-time"]</code>, you will get data only for these audits<p>2. if you specify a category, you can use this field to additionally receive audits that do not belong to the category(-ies) you specified<br>for example, if you specify <code>"categories": ["seo"]</code> and <code>"audits": ["metrics/cumulative-layout-shift","metrics/largest-contentful-paint","metrics/total-blocking-time"]</code>, you will get only these audits under "performance" and all audits under "seo"<p>you can get <a href="/v3/on_page/lighthouse/audits/">the full list of possible audits here</a>'
          nullable: true
        version:
          type: string
          description: <em>lighthouse version</em><br>optional field<br>you can obtain the results specific to a certain Lighthouse version by specifying its number<br>the list of available versions is available through the <a href="/v3/on_page/lighthouse/versions/" rel="noopener noreferrer" target="_blank">Lighthouse Versions endpoint</a>
          nullable: true
        language_name:
          type: string
          description: <em>lighthouse language name</em><br>optional field<br>you can receive the list of available languages of the search engine with their <code>language_name</code> by making a separate request to <code>https://api.dataforseo.com/v3/on_page/lighthouse/languages</code><br>default value:<br><code class="long-string">English</code>
          nullable: true
        language_code:
          type: string
          description: <em>lighthouse language code</em><br>optional field<br>you can receive the list of available languages of the search engine with their <code>language_code</code> by making a separate request to <code>https://api.dataforseo.com/v3/on_page/lighthouse/languages</code><br>default value:<br><code class="long-string">en</code>
          nullable: true
        custom_user_agent:
          type: string
          description: <em>custom user agent</em><br>optional field<br>specify the custom user agent used by the browser when running the Lighthouse audit;<br>can be specified with up to 254 characters;
          nullable: true
        browser_screen_width:
          type: integer
          description: '<em>browser screen width</em><br>optional field<br>set the screen width of the browser used for the Lighthouse audit to emulate a specific device;<br>can be specified within the following range: <code>240–9999</code>;'
          format: int64
          nullable: true
        browser_screen_height:
          type: integer
          description: '<em>browser screen height</em><br>optional field<br>set the screen height of the browser used for the Lighthouse audit to emulate a specific device;<br>can be specified within the following range: <code>240–9999</code>;'
          nullable: true
        browser_screen_scale_factor:
          type: number
          description: '<em>browser screen scale factor</em><br>optional field<br>set the device pixel ratio of the browser used for the Lighthouse audit;<br>can be specified within the following range: <code>0.5–3</code>;'
          nullable: true
        browser_network_throttling_method:
          type: string
          description: <em>browser network throttling method</em><br>optional field<br>defines the method used to apply throttling during the Lighthouse audit;<br>possible vaules:<br><code>simulate</code> - calculates estimated performance metrics without applying explicit throttling;<br><code>devtools</code> -  applies the throttling settings specified in <code>browser_network_throttling</code> and <code>browser_cpu_throttling_multiplier</code>;<br><code>provided</code> - uses the network conditions of the crawling environment;
          nullable: true
        browser_cpu_throttling_multiplier:
          type: number
          description: '<em>browser CPU throttling multiplier</em><br><strong>required if <code>browser_network_throttling_method</code> is set to <code>devtools</code>;</strong><br>set the CPU throttling multiplier to simulate device performance conditions during the Lighthouse audit;<br>can be specified within the following range: <code>1–4</code>;<br><strong>Note:</strong> this parameter is applied only when <code>browser_network_throttling_method</code> is set to <code>devtools</code>;'
          nullable: true
        browser_network_throttling:
          type: string
          description: '<em>browser network throttling</em><br><strong>required if <code>browser_network_throttling_method</code> is set to <code>devtools</code>;</strong><br>set the network throttling profile to simulate connection speed conditions during the Lighthouse audit;<br>possible values: <code>no_throttling</code>, <code>fast_4g</code>, <code>slow_4g</code>, <code>regular_3g</code>, <code>pc</code>;<br><strong>Note:</strong> this parameter is applied only when <code>browser_network_throttling_method</code> is set to <code>devtools</code>;'
          nullable: true
        tag:
          type: string
          description: <em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response
          nullable: true
      example:
        - url: https://dataforseo.com
          for_mobile: true
          tag: some_string_123
    OnPageLighthouseLiveJsonTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                additionalProperties:
                  type: object
                  nullable: true
                nullable: true
              description: <em>results of Lighthouse audit</em><br>this array will include data according to the parameters you specified when setting a task;<p>all fields and their descriptions are available in the official documentation <a href="https://github.com/GoogleChrome/lighthouse/blob/master/readme.md">by this link.</a>
              nullable: true
    OnPageLighthouseLiveJsonResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/OnPageLighthouseLiveJsonTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    ContentAnalysisIdListRequestInfo:
      type: object
      properties:
        datetime_from:
          type: string
          description: '<em>start time for filtering results</em><br><strong>required field</strong><br>if <code>include_metadata</code> is set to <code>true</code>, maximum value: a month from current datetime;<br>if <code>include_metadata</code> is set to <code>false</code>, maximum value: six months from current datetime;<br>must be specified in the UTC format: "yyyy-mm-dd hh-mm-ss +00:00"<br>example:<br><code>2023-01-15 12:57:46 +00:00</code>'
        datetime_to:
          type: string
          description: '<em>finish time for filtering results</em><br><strong>required field</strong><br>maximum value: current datetime;<br>must be specified in the UTC format: "yyyy-mm-dd hh-mm-ss +00:00"<br>example:<br><code>2023-01-31 13:57:46 +00:00</code>'
        limit:
          type: integer
          description: '<em>the maximum number of returned task IDs</em><br>optional field<br>default value: <code>1000</code><br>maximum value: <code>1000</code>'
          nullable: true
        offset:
          type: integer
          description: '<em>offset in the results array of returned task IDs</em><br>optional field<br>default value: <code>0</code><br>if you specify the <code>10</code> value, the first ten tasks in the results array will be omitted'
          nullable: true
        sort:
          type: string
          description: '<em>sorting by task execution time</em><br>optional field<br>possible values: <code>"asc"</code>, <code>"desc"</code><br>default value: <code>"asc"</code>'
          nullable: true
        include_metadata:
          type: boolean
          description: '<em>include task metadata in the respond</em><br>optional field<br>default value: <code>false</code>'
          nullable: true
      example:
        - datetime_from: '2026-09-10 11:12:35'
          datetime_to: '2026-09-20 11:12:35'
          limit: 10
          include_metadata: true
    ContentAnalysisIdListResultInfo:
      type: object
      properties:
        id:
          type: string
          description: <em>task identifier</em><br><strong>unique task identifier in our system in the <a href="https://en.wikipedia.org/wiki/Universally_unique_identifier">UUID</a> format</strong>
          nullable: true
        url:
          type: string
          description: <em>URL of the task</em><br>URL you used for making an API call
          nullable: true
        datetime_posted:
          type: string
          description: '<em>date and time when the task was made</em><br>in the UTC format: "yyyy-mm-dd hh-mm-ss +00:00"<br>example:<br><code>2023-01-15 12:57:46 +00:00</code>'
          nullable: true
        datetime_done:
          type: string
          description: '<em>date and time when the task was completed</em><br>in the UTC format: "yyyy-mm-dd hh-mm-ss +00:00"<br>example:<br><code>2023-01-15 12:57:46 +00:00</code>'
          nullable: true
        status:
          type: string
          description: <em>informational message of the task</em><br>you can find the full list of general informational messages <a href="/v3/appendix-errors/">here</a>
          nullable: true
        cost:
          type: number
          description: '<em>total tasks cost, USD</em>'
          nullable: true
        metadata:
          type: object
          additionalProperties:
            type: object
            nullable: true
          description: <em>contains parameters you specified in the POST request</em>
          nullable: true
    ContentAnalysisIdListTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/ContentAnalysisIdListResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    ContentAnalysisIdListResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/ContentAnalysisIdListTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    ContentAnalysisAvailableFiltersResultInfo:
      type: object
      properties:
        search:
          type: object
          additionalProperties:
            type: string
            nullable: true
          nullable: true
    ContentAnalysisAvailableFiltersTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/ContentAnalysisAvailableFiltersResultInfo'
                nullable: true
              nullable: true
    ContentAnalysisAvailableFiltersResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/ContentAnalysisAvailableFiltersTaskInfo'
                nullable: true
              nullable: true
    ContentAnalysisLocationsResultInfo:
      type: object
      properties:
        location_name:
          type: string
          description: <em>full name of the location</em>
          nullable: true
        country_iso_code:
          type: string
          description: <em>ISO country code of the location</em>
          nullable: true
    ContentAnalysisLocationsTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/ContentAnalysisLocationsResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    ContentAnalysisLocationsResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/ContentAnalysisLocationsTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    ContentAnalysisLanguagesResultInfo:
      type: object
      properties:
        location_code:
          type: integer
          nullable: true
        location_name:
          type: string
          nullable: true
        location_code_parent:
          type: integer
          nullable: true
        country_iso_code:
          type: string
          nullable: true
        location_type:
          type: string
          nullable: true
    ContentAnalysisLanguagesTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/ContentAnalysisLanguagesResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    ContentAnalysisLanguagesResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/ContentAnalysisLanguagesTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    ContentAnalysisCategoriesResultInfo:
      type: object
      properties:
        category_code:
          type: integer
          description: <em>category code</em>
          nullable: true
        category_name:
          type: string
          description: <em>full name of the category</em>
          nullable: true
        category_code_parent:
          type: integer
          description: '<em>the code of the superordinate category</em><br>example:<br><code>"category_code": 10178,<br>"category_name": "Apparel Accessories",<br>"category_code_parent": 10021</code> <br>where <code>category_code_parent</code> <br>corresponds to: <br><code>"category_code": 10178,<br>"category_name": "Apparel Accessories"</code>'
          nullable: true
    ContentAnalysisCategoriesTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/ContentAnalysisCategoriesResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    ContentAnalysisCategoriesResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/ContentAnalysisCategoriesTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    ContentAnalysisSearchLiveRequestInfo:
      type: object
      properties:
        keyword:
          type: string
          description: '<em>target keyword</em><br><strong>required field</strong><br>UTF-8 encoding<br>the keywords will be converted to a lowercase format;<br><strong>Note</strong>: to match an exact phrase instead of a stand-alone keyword, use double quotes and backslashes; <br>example: <br>`"keyword": "\"tesla palo alto\""`<p>learn more about rules and limitations of <code>keyword</code> and <code>keywords</code> fields in DataForSEO APIs in this <a href="https://dataforseo.com/help-center/rules-and-limitations-of-keyword-and-keywords-fields-in-dataforseo-apis" rel="noopener noreferrer" target="_blank">Help Center article</a>'
        keyword_fields:
          type: object
          additionalProperties:
            type: string
            nullable: true
          description: '<em>target keyword fields and target keywords</em><br>optional field<br>use this parameter to filter the dataset by keywords that certain fields should contain;<br>fields you can specify: <code>title</code>, <code>main_title</code>, <code>previous_title</code>, <code>snippet</code><br>you can indicate several fields;<br><strong>Note</strong>: to match an exact phrase instead of a stand-alone keyword, use double quotes and backslashes; <br>example:<br>`"keyword_fields": {<br>"snippet": "\"logitech mouse\"",<br>"main_title": "sale"<br>}"`'
          nullable: true
        page_type:
          type: array
          items:
            type: string
          description: '<em>target page types</em><br>optional field<br>use this parameter to filter the dataset by page types<br>possible values: <br><code>"ecommerce"</code>, <code>"news"</code>, <code>"blogs"</code>, <code>"message-boards"</code>, <code>"organization"</code>'
          nullable: true
        search_mode:
          type: string
          description: '<em>results grouping type</em><br>optional field<br>possible grouping types:<br><code>as_is</code> - returns all citations for the target <code>keyword</code><br><code>one_per_domain</code> - returns one citation of the <code>keyword</code> per domain<br>default value: <code>as_is</code>'
          nullable: true
        limit:
          type: integer
          description: '<em>the maximum number of returned citations</em><br>optional field<br>default value: <code>100</code><br>maximum value: <code>1000</code>'
          nullable: true
        filters:
          type: array
          items:
            type: object
            nullable: true
          description: '<em>array of results filtering parameters</em><br>optional field<br><strong>you can add several filters at once (8 filters maximum)</strong><br>you should set a logical operator <code>and</code>, <code>or</code> between the conditions<br>the following operators are supported:<br><code>regex</code>, <code>not_regex</code>, <code>&lt;</code>, <code>&lt;=</code>, <code>&gt;</code>, <code>&gt;=</code>, <code>=</code>, <code>&lt;&gt;</code>, <code>in</code>, <code>not_in</code>, <code>like</code>,<code>not_like</code>, <code>match</code>, <code>not_match</code><br>you can use the <code>%</code> operator with <code>like</code> and <code>not_like</code> to match any string of zero or more characters<br>example:<br><code>["country","=", "US"]</code><p><code>[["domain_rank","&gt;",800],"and",["content_info.connotation_types.negative","&gt;",0.9]]</code><p><code>[["domain_rank","&gt;",800],<br>"and",<br>[["page_types","has","ecommerce"],<br>"or",<p>["content_info.text_category","has",10994]]]</code><br>for more information about filters, please refer to <a href="/v3/content_analysis/filters" target="_blank" rel="noopener noreferrer">Content Analysis API - Filters</a>'
          nullable: true
        order_by:
          type: array
          items:
            type: string
          description: '<em>results sorting rules</em><br>optional field<br>you can use the same values as in the <code>filters</code> array to sort the results<br>possible sorting types:<br><code>asc</code> - results will be sorted in the ascending order<br><code>desc</code> - results will be sorted in the descending order<br>you should use a comma to set up a sorting type<br>example:<br><code>["content_info.sentiment_connotations.anger,desc"]</code><br>default rule:<br><code>["content_info.sentiment_connotations.anger,desc"]</code><br><strong>note that you can set no more than three sorting rules in a single request</strong><br>you should use a comma to separate several sorting rules<br>example:<br><code>["content_info.sentiment_connotations.anger,desc","keyword_data.keyword_info.cpc,desc"]</code>'
          nullable: true
        offset:
          type: integer
          description: '<em>offset in the results array of returned citations</em><br>optional field<br>default value: <code>0</code><br>if you specify the <code>10</code> value, the first ten citations in the results array will be omitted and the data will be provided for the successive citations<br><strong>Note:</strong> we recommend using this parameter only when retrieving up to 10,000 results<br>for retrieving over 10,000 results, use the <code>offset_token</code> instead.'
          nullable: true
        offset_token:
          type: string
          description: '<em>offset token for subsequent requests</em><br>optional field<br>provided in the identical field of the response to each request;<br>use this parameter to avoid timeouts while trying to obtain over 10,000 results in a single request;<br>by specifying the unique <code>offset_token</code> value from the response array, you will get the subsequent results of the initial task;<br><code>offset_token</code> values are unique for each subsequent task <br><strong>Note:</strong> if the <code>offset_token</code> is specified in the request, all other parameters except <code>limit</code> will not be taken into account when processing a task<br>learn more about this parameter on our <a href="https://dataforseo.com/help-center/what-is-the-difference-between-the-offset-and-offset_token-parameters#offset_token" target="_blank">Help Center</a>'
          nullable: true
        rank_scale:
          type: string
          description: '<em>defines the scale used for calculating and displaying the <code>domain_rank</code>, and <code>url_rank</code> values</em><br>optional field<p>you can use this parameter to choose whether rank values are presented on a 0–100 or 0–1000 scale<p>possible values:<br><code>one_hundred</code> — rank values are displayed on a 0–100 scale<br><code>one_thousand</code> — rank values are displayed on a 0–1000 scale<p>default value: <code>one_thousand</code><p>learn more about how this parameter works in <a href="https://dataforseo.com/help-center/using-the-rank_scale-parameter-in-content-analysis-api">this Help Center article</a>'
          nullable: true
        tag:
          type: string
          description: <em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response
          nullable: true
      example:
        - keyword_fields:
            snippet: logitech
          keyword: logitech
          page_type:
            - ecommerce
            - news
            - blogs
            - message-boards
            - organization
          search_mode: as_is
          filters:
            - main_domain
            - =
            - reviewfinder.ca
          order_by:
            - 'content_info.sentiment_connotations.anger,desc'
          limit: 10
    AnalysisContentInfo:
      type: object
      properties:
        content_type:
          type: string
          description: '<em>type of content</em><br>example:<br><code>page_content</code>, <code>comment</code>'
          nullable: true
        title:
          type: string
          description: <em>title of the result</em>
          nullable: true
        main_title:
          type: string
          description: <em>page title</em>
          nullable: true
        previous_title:
          type: string
          description: <em>title of the previous content block</em>
          nullable: true
        level:
          type: integer
          description: <em><code>title</code> heading level</em><br>indicates h-tag level from <code>1</code> (top) to <code>6</code> (bottom)
          nullable: true
        author:
          type: string
          description: <em>author of the content</em>
          nullable: true
        snippet:
          type: string
          description: <em>content snippet</em>
          nullable: true
        snippet_length:
          type: integer
          description: <em>character length of the snippet</em>
          nullable: true
        social_metrics:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/SocialMetricsInfo'
            nullable: true
          description: <em>social media engagement metrics</em><br>data on social media interactions associated with the content based on website embeds developed and supported by social media platforms
          nullable: true
        highlighted_text:
          type: string
          description: <em>highlighted text from the <code>snippet</code></em>
          nullable: true
        language:
          type: string
          description: '<em>main language of the domain</em><br>to obtain a full list of available languages, refer to the <a href="/v3/content_analysis/languages/" rel="noopener noreferrer" target="_blank">Languages</a> endpoint'
          nullable: true
        sentiment_connotations:
          type: object
          additionalProperties:
            type: integer
            format: int64
            nullable: true
          description: '<em>sentiment connotations</em><br>contains sentiments (emotional reactions) related to the given citation and probability index per each sentiment<br>possible sentiment connotations: <code>anger</code>, <code>happiness</code>, <code>love</code>, <code>sadness</code>, <code>share</code>, <code>fun</code>'
          nullable: true
        connotation_types:
          type: object
          additionalProperties:
            type: integer
            format: int64
            nullable: true
          description: '<em>connotation types</em><br>contains types of sentiments (sentiment polarity) related to the given citation and probability index per each sentiment type<br>possible sentiment connotation types: <code>positive</code>, <code>negative</code>, <code>neutral</code>'
          nullable: true
        text_category:
          type: array
          items:
            type: integer
          description: '<em>text category</em><br>to obtain a full list of available categories, refer to the <a href="/v3/content_analysis/categories/" rel="noopener noreferrer" target="_blank">Categories</a> endpoint'
          nullable: true
        date_published:
          type: string
          description: '<em>date and time when the content was published</em><br>in the UTC format: "yyyy-mm-dd hh-mm-ss +00:00"<br>example:<br><code>2017-01-24 13:20:59 +00:00</code>'
          nullable: true
        content_quality_score:
          type: integer
          description: '<em>content quality score</em><br>this value is calculated based on the number of words, sentences and characters the content contains'
          nullable: true
        semantic_location:
          type: string
          description: '<em>semantic location</em><br>indicates semantic element in HTML where the target keyword citation is located<br>example:<br><code>article</code>, <code>header</code>'
          nullable: true
        rating:
          type: object
          oneOf:
            - $ref: '#/components/schemas/ContententRatingInfo'
          description: <em>content rating</em><br>rating related to <code>content_info</code>
          nullable: true
        group_date:
          type: string
          description: '<em>citation group date and time</em><br>indicates content publication date or date and time when our crawler visited the page for the first time;<br>this field can be used to group citations by date and display citation trends;<br>date and time are provided in the UTC format: "yyyy-mm-dd hh-mm-ss +00:00"<br>example:<br><code>2017-01-24 13:20:59 +00:00</code>'
          nullable: true
    ContentAnalysisSearchLiveItem:
      type: object
      properties:
        type:
          type: string
          description: type of element
          nullable: true
        url:
          type: string
          description: <em>URL where the citation was found</em>
          nullable: true
        domain:
          type: string
          description: <em>domain name</em>
          nullable: true
        main_domain:
          type: string
          description: <em>main domain</em>
          nullable: true
        url_rank:
          type: integer
          description: <em>rank of the <code>url</code></em><br>this value is based on backlink data for the given URL from DataForSEO Backlink Index;<br><code>url_rank</code> is calculated based on the method for node ranking in a linked database – a principle used in the original Google PageRank algorithm<br>learn more about the metric and how it is calculated in <a href="https://dataforseo.com/help-center/what_is_rank_in_backlinks_api" rel="noopener noreferrer" target="_blank">this help center article</a>
          nullable: true
        spam_score:
          type: integer
          description: <em>backlink spam score of the <code>url</code></em><br>this value is based on backlink data for the given URL from DataForSEO Backlink Index;<br>learn more about how the metric is calculated on <a href="https://dataforseo.com/help-center/what-is-spam-score-and-how-is-it-calculated" rel="noopener noreferrer" target="_blank">this help center page</a>
          nullable: true
        domain_rank:
          type: integer
          description: <em>rank of the <code>domain</code></em><br>this value is based on backlink data for the given domain from DataForSEO Backlink Index;<br><code>domain_rank</code> is calculated based on the method for node ranking in a linked database – a principle used in the original Google PageRank algorithm<br>learn more about the metric and how it is calculated in <a href="https://dataforseo.com/help-center/what_is_rank_in_backlinks_api" rel="noopener noreferrer" target="_blank">this help center article</a>
          nullable: true
        fetch_time:
          type: string
          description: '<em>date and time when our crawler visited the page</em><br>in the UTC format: "yyyy-mm-dd hh-mm-ss +00:00"<br>example:<br><code>2017-01-24 13:20:59 +00:00</code>'
          nullable: true
        country:
          type: string
          description: '<em>country code of the domain registration</em><br>to obtain a full list of available countries, refer to the <a href="/v3/content_analysis/locations/" rel="noopener noreferrer" target="_blank">Locations</a> endpoint'
          nullable: true
        language:
          type: string
          description: '<em>main language of the domain</em><br>to obtain a full list of available languages, refer to the <a href="/v3/content_analysis/languages/" rel="noopener noreferrer" target="_blank">Languages</a> endpoint'
          nullable: true
        score:
          type: number
          description: '<em>citation prominence score</em><br>this value is based on <code>url_rank</code>, <code>domain_rank</code>, <code>keyword</code> presence in <code>title</code>, <code>main_title</code>, <code>url</code>, <code>snippet</code><br>the higher the <code>score</code>, the more value the related citation has'
          nullable: true
        page_category:
          type: array
          items:
            type: integer
          description: '<em>contains all relevant page categories</em><br>product and service categories relevant for the page<br>to obtain a full list of available categories, refer to the <a href="/v3/content_analysis/categories/" rel="noopener noreferrer" target="_blank">Categories</a> endpoint'
          nullable: true
        page_types:
          type: array
          items:
            type: string
          description: <em>page types</em>
          nullable: true
        ratings:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/ContententRatingInfo'
            nullable: true
          description: <em>ratings found on the page</em><br>all ratings found on the page based on microdata
          nullable: true
        social_metrics:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/SocialMetricsInfo'
            nullable: true
          description: <em>social media engagement metrics</em><br>data on social media interactions associated with the content based on website embeds developed and supported by social media platforms
          nullable: true
        content_info:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AnalysisContentInfo'
          description: <em>contains data on citations from the given <code>url</code></em>
          nullable: true
    ContentAnalysisSearchLiveResultInfo:
      type: object
      properties:
        offset_token:
          type: string
          description: <em>offset token for subsequent requests</em><br>you can use the string provided in this field to get the subsequent results of the initial task;<br><strong>note:</strong> <code>offset_token</code> values are unique for each subsequent task
          nullable: true
        total_count:
          type: integer
          description: <em>total amount of results in our database relevant to your request</em>
          format: int64
          nullable: true
        items_count:
          type: integer
          description: <em>the number of results returned in the <code>items</code> array</em>
          format: int64
          nullable: true
        items:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/ContentAnalysisSearchLiveItem'
            nullable: true
          description: <em>contains citations and related data</em>
          nullable: true
    ContentAnalysisSearchLiveTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/ContentAnalysisSearchLiveResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    ContentAnalysisSearchLiveResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/ContentAnalysisSearchLiveTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    ContentAnalysisSummaryLiveRequestInfo:
      type: object
      properties:
        keyword:
          type: string
          description: '<em>target keyword</em><br><strong>required field</strong><br>UTF-8 encoding<br>the keywords will be converted to a lowercase format;<br><strong>Note</strong>: to match an exact phrase instead of a stand-alone keyword, use double quotes and backslashes; <br>example: <br><code>"keyword": "\"tesla palo alto\""</code><p>learn more about rules and limitations of <code>keyword</code> and <code>keywords</code> fields in DataForSEO APIs in this <a href="https://dataforseo.com/help-center/rules-and-limitations-of-keyword-and-keywords-fields-in-dataforseo-apis" rel="noopener noreferrer" target="_blank">Help Center article</a>'
        keyword_fields:
          type: object
          additionalProperties:
            type: string
            nullable: true
          description: '<em>target keyword fields and target keywords</em><br>optional field<br>use this parameter to filter the dataset by keywords that certain fields should contain;<br>fields you can specify: <code>title</code>, <code>main_title</code>, <code>previous_title</code>, <code>snippet</code><br>you can indicate several fields;<br><strong>Note</strong>: to match an exact phrase instead of a stand-alone keyword, use double quotes and backslashes; <br>example:<br><code>"keyword_fields": {<br>"snippet": "\"logitech mouse\"",<br>"main_title": "sale"<br>}</code>'
          nullable: true
        page_type:
          type: array
          items:
            type: string
          description: '<em>target page types</em><br>optional field<br>use this parameter to filter the dataset by page types<br>possible values: <br><code>"ecommerce"</code>, <code>"news"</code>, <code>"blogs"</code>, <code>"message-boards"</code>, <code>"organization"</code>'
          nullable: true
        internal_list_limit:
          type: integer
          description: '<em>maximum number of elements within internal arrays</em><br>optional field<br>you can use this field to limit the number of elements within the following arrays:<br><code>top_domains</code><br><code>text_categories</code><br><code>page_categories</code><br><code>countries</code><br><code>languages</code><br>default value: <code>1</code><br>maximum value: <code>20</code>'
          nullable: true
        positive_connotation_threshold:
          type: number
          description: '<em>positive connotation threshold</em><br>optional field<br>specified as the probability index threshold for positive sentiment related to the citation content<br>if you specify this field, <code>connotation_types</code> object in the response will only contain data on citations with <code>positive</code> sentiment probability more than or equal to the specified value<br>possible values: from <code>0</code> to <code>1</code><br>default value: <code>0.4</code>'
          nullable: true
        sentiments_connotation_threshold:
          type: number
          description: '<em>sentiment connotation threshold</em><br>optional field<br>specified as the probability index threshold for sentiment connotations related to the citation content<br>if you specify this field, <code>sentiment_connotations</code> object in the response will only contain data on citations where the <br>probability per each sentiment is more than or equal to the specified value<br>possible values: from <code>0</code> to <code>1</code><br>default value: <code>0.4</code>'
          nullable: true
        initial_dataset_filters:
          type: array
          items:
            type: object
            nullable: true
          description: '<em>initial dataset filtering parameters</em><br>optional field<br>initial filtering parameters that apply to fields in the <a href="/v3/content_analysis/search/live/?bash" target="_blank">Search endpoint</a><br><strong>you can add several filters at once (8 filters maximum)</strong><br>you should set a logical operator <code>and</code>, <code>or</code> between the conditions<br>the following operators are supported:<br><code>regex</code>, <code>not_regex</code>, <code>&lt;</code>, <code>&lt;=</code>, <code>&gt;</code>, <code>&gt;=</code>, <code>=</code>, <code>&lt;&gt;</code>, <code>in</code>, <code>not_in</code>, <code>like</code>,<code>not_like</code>, <code>has</code>, <code>has_not</code><br>you can use the <code>%</code> operator with <code>like</code> and <code>not_like</code> to match any string of zero or more characters<br>example:<br><code>["domain","&lt;&gt;", "logitech.com"]</code><p><code>[["domain","&lt;&gt;","logitech.com"],"and",["content_info.connotation_types.negative","&gt;",1000]]</code><p><code>[["domain","&lt;&gt","logitech.com"]],<br>"and",<br>[["content_info.connotation_types.negative","&gt;",1000],<br>"or",<p>["content_info.text_category","has",10994]]]</code><br>for more information about filters, please refer to <a href="/v3/content_analysis/filters" target="_blank" rel="noopener noreferrer">Content Analysis API - Filters</a><br>learn more about the initial dataset filters in <a href="https://dataforseo.com/help-center/what-are-the-initial-dataset-filters-and-how-do-they-work" rel="noopener noreferrer" target="_blank">this help center article.</a>'
          nullable: true
        rank_scale:
          type: string
          description: '<em>defines the scale used for calculating and displaying the <code>rank</code> values</em><br>optional field<p>you can use this parameter to choose whether rank values are presented on a 0–100 or 0–1000 scale<p>possible values:<br><code>one_hundred</code> — rank values are displayed on a 0–100 scale<br><code>one_thousand</code> — rank values are displayed on a 0–1000 scale<p>default value: <code>one_thousand</code><p>learn more about how this parameter works in <a href="https://dataforseo.com/help-center/using-the-rank_scale-parameter-in-content-analysis-api">this Help Center article</a>'
          nullable: true
        tag:
          type: string
          description: <em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response
          nullable: true
      example:
        - keyword: logitech
          page_type:
            - ecommerce
            - news
            - blogs
            - message-boards
            - organization
          internal_list_limit: 8
          positive_connotation_threshold: 0.5
    ContentAnalysisSummaryInfo:
      type: object
      properties:
        type:
          type: string
          description: type of element
          nullable: true
        total_count:
          type: integer
          description: <em>total amount of results in our database relevant to your request</em>
          format: int64
          nullable: true
        rank:
          type: integer
          description: <em>rank of all URLs citing the <code>keyword</code></em><br>normalized sum of ranks of all URLs citing the target <code>keyword</code>
          nullable: true
        top_domains:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/TopDomainInfo'
            nullable: true
          description: <em>top domains citing the target keyword</em><br>contains objects with top domains citing the target keword and citation count per each domain
          nullable: true
        sentiment_connotations:
          type: object
          additionalProperties:
            type: integer
            format: int64
            nullable: true
          description: '<em>sentiment connotations</em><br>contains sentiments (emotional reactions) related to the target keyword citation and the number of citations per each sentiment<br>possible sentiment connotations: <code>anger</code>, <code>happiness</code>, <code>love</code>, <code>sadness</code>, <code>share</code>, <code>fun</code>'
          nullable: true
        connotation_types:
          type: object
          additionalProperties:
            type: integer
            format: int64
            nullable: true
          description: '<em>connotation types</em><br>contains types of sentiments (sentiment polarity) related to the keyword citation and citation count per each sentiment type<br>possible sentiment connotation types: <code>positive</code>, <code>negative</code>, <code>neutral</code>'
          nullable: true
        text_categories:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/ContentAnalysisCategoriesInfo'
            nullable: true
          description: '<em>text categories</em><br>contains objects with text categories and citation count in each text category<br>to obtain a full list of available categories, refer to the <a href="/v3/content_analysis/categories/" rel="noopener noreferrer" target="_blank">Categories</a> endpoint'
          nullable: true
        page_categories:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/ContentAnalysisCategoriesInfo'
            nullable: true
          description: '<em>page categories</em><br>contains objects with page categories and citation count in each page category<br>to obtain a full list of available categories, refer to the <a href="/v3/content_analysis/categories/" rel="noopener noreferrer" target="_blank">Categories</a> endpoint'
          nullable: true
        page_types:
          type: object
          additionalProperties:
            type: integer
            format: int64
            nullable: true
          description: <em>page types</em><br>contains page types and citation count per each page type
          nullable: true
        countries:
          type: object
          additionalProperties:
            type: integer
            format: int64
            nullable: true
          description: '<em>countries</em><br>contains countries and citation count in each country<br>to obtain a full list of available countries, refer to the <a href="/v3/content_analysis/locations/" rel="noopener noreferrer" target="_blank">Locations</a> endpoint'
          nullable: true
        languages:
          type: object
          additionalProperties:
            type: integer
            format: int64
            nullable: true
          description: '<em>languages</em><br>contains languages and citation count in each language<br>to obtain a full list of available languages, refer to the <a href="/v3/content_analysis/languages/" rel="noopener noreferrer" target="_blank">Languages</a> endpoint'
          nullable: true
    ContentAnalysisSummaryLiveTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/ContentAnalysisSummaryInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    ContentAnalysisSummaryLiveResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/ContentAnalysisSummaryLiveTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    ContentAnalysisSentimentAnalysisLiveRequestInfo:
      type: object
      properties:
        keyword:
          type: string
          description: "target keyword\nrequired field\nUTF-8 encoding\nthe keywords will be converted to a lowercase format;\nNote: to match an exact phrase instead of a stand-alone keyword, use double quotes and backslashes;\nexample:\n\"keyword\": \"\\\"tesla palo alto\\\"\"\nlearn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article"
        keyword_fields:
          type: object
          additionalProperties:
            type: string
            nullable: true
          description: "target keyword fields and target keywords\noptional field\nuse this parameter to filter the dataset by keywords that certain fields should contain;\nfields you can specify: title, main_title, previous_title, snippet\nyou can indicate several fields;\nNote: to match an exact phrase instead of a stand-alone keyword, use double quotes and backslashes;\nexample:\n\"keyword_fields\": {\n    \"snippet\": \"\\\"logitech mouse\\\"\",\n    \"main_title\": \"sale\"\n}"
          nullable: true
        page_type:
          type: array
          items:
            type: string
          description: "target page types\noptional field\nuse this parameter to filter the dataset by page types\npossible values:\n\"ecommerce\", \"news\", \"blogs\", \"message-boards\", \"organization\""
          nullable: true
        internal_list_limit:
          type: integer
          description: "maximum number of elements within internal arrays\noptional field\nyou can use this field to limit the number of elements within the following arrays:\ntop_domains\ntext_categories\npage_categories\ncountries\nlanguages\ndefault value: 1\nmaximum value: 20"
          nullable: true
        positive_connotation_threshold:
          type: number
          description: "positive connotation threshold\noptional field\nspecified as the probability index threshold for positive sentiment related to the citation content\nif 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 value\npossible values: from 0 to 1\ndefault value: 0.4"
          nullable: true
        sentiments_connotation_threshold:
          type: number
          description: "sentiment connotation threshold\noptional field\nspecified as the probability index threshold for sentiment connotations related to the citation content\nif 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 value\npossible values: from 0 to 1\ndefault value: 0.4"
          nullable: true
        initial_dataset_filters:
          type: array
          items:
            type: object
            nullable: true
          description: "initial dataset filtering parameters\noptional field\ninitial filtering parameters that apply to fields in the Search endpoint\nyou can add several filters at once (8 filters maximum)\nyou should set a logical operator and, or between the conditions\nthe following operators are supported:\nregex, not_regex, <, <=, >, >=, =, <>, in, not_in, like,not_like, has, has_not, match, not_match\nyou can use the % operator with like and not_like to match any string of zero or more characters\nexample:\n[\"domain\",\"<>\", \"logitech.com\"]\n[[\"domain\",\"<>\",\"logitech.com\"],\"and\",[\"content_info.connotation_types.negative\",\">\",1000]]\n[[\"domain\",\"<>\",\"logitech.com\"]],\n\"and\",\n[[\"content_info.connotation_types.negative\",\">\",1000],\n\"or\",\n[\"content_info.text_category\",\"has\",10994]]]\nfor more information about filters, please refer to Content Analysis API – Filters\nlearn more about the initial dataset filters in this help center article."
          nullable: true
        rank_scale:
          type: string
          description: "defines the scale used for calculating and displaying the rank values\noptional field\nyou can use this parameter to choose whether rank values are presented on a 0–100 or 0–1000 scale\npossible values:\none_hundred — rank values are displayed on a 0–100 scale\none_thousand — rank values are displayed on a 0–1000 scale\ndefault value: one_thousand\nlearn more about how this parameter works in this Help Center article"
          nullable: true
        tag:
          type: string
          description: "user-defined task identifier\noptional field\nthe character limit is 255\nyou can use this parameter to identify the task and match it with the result\nyou will find the specified tag value in the data object of the response"
          nullable: true
      example:
        - keyword: logitech
          internal_list_limit: 1
    PositiveConnotationDistribution:
      type: object
      properties:
        positive:
          type: object
          oneOf:
            - $ref: '#/components/schemas/ContentAnalysisSummaryInfo'
          nullable: true
        negative:
          type: object
          oneOf:
            - $ref: '#/components/schemas/ContentAnalysisSummaryInfo'
          nullable: true
        neutral:
          type: object
          oneOf:
            - $ref: '#/components/schemas/ContentAnalysisSummaryInfo'
          nullable: true
    SentimentConnotationDistribution:
      type: object
      properties:
        anger:
          type: object
          oneOf:
            - $ref: '#/components/schemas/ContentAnalysisSummaryInfo'
          nullable: true
        happiness:
          type: object
          oneOf:
            - $ref: '#/components/schemas/ContentAnalysisSummaryInfo'
          nullable: true
        love:
          type: object
          oneOf:
            - $ref: '#/components/schemas/ContentAnalysisSummaryInfo'
          nullable: true
        sadness:
          type: object
          oneOf:
            - $ref: '#/components/schemas/ContentAnalysisSummaryInfo'
          nullable: true
        share:
          type: object
          oneOf:
            - $ref: '#/components/schemas/ContentAnalysisSummaryInfo'
          nullable: true
        fun:
          type: object
          oneOf:
            - $ref: '#/components/schemas/ContentAnalysisSummaryInfo'
          nullable: true
    ContentAnalysisSentimentAnalysisLiveResultInfo:
      type: object
      properties:
        type:
          type: string
          description: type of element
          nullable: true
        positive_connotation_distribution:
          type: object
          oneOf:
            - $ref: '#/components/schemas/PositiveConnotationDistribution'
          description: "citation distribution by sentiment connotation types\ncontains objects with citation counts and relevant data distributed by types of sentiments (sentiment polarity);\npossible sentiment connotation types: positive, negative, neutral"
          nullable: true
        sentiment_connotation_distribution:
          type: object
          oneOf:
            - $ref: '#/components/schemas/SentimentConnotationDistribution'
          description: "citation distribution by sentiment connotations\ncontains objects with citation counts and relevant data distributed by sentiments (emotional reactions);\npossible sentiment connotation types: anger, happiness, love, sadness, share, fun"
          nullable: true
    ContentAnalysisSentimentAnalysisLiveTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/ContentAnalysisSentimentAnalysisLiveResultInfo'
                nullable: true
              description: array of results
              nullable: true
    ContentAnalysisSentimentAnalysisLiveResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/ContentAnalysisSentimentAnalysisLiveTaskInfo'
                nullable: true
              description: array of tasks
              nullable: true
    ContentAnalysisRatingDistributionLiveRequestInfo:
      type: object
      properties:
        keyword:
          type: string
          description: '<em>target keyword</em><br><strong>required field</strong><br>UTF-8 encoding<br>the keywords will be converted to a lowercase format;<br><strong>Note</strong>: to match an exact phrase instead of a stand-alone keyword, use double quotes and backslashes; <br>example: <br><code>"keyword": "\"tesla palo alto\""</code><p>learn more about rules and limitations of <code>keyword</code> and <code>keywords</code> fields in DataForSEO APIs in this <a href="https://dataforseo.com/help-center/rules-and-limitations-of-keyword-and-keywords-fields-in-dataforseo-apis" rel="noopener noreferrer" target="_blank">Help Center article</a>'
        keyword_fields:
          type: object
          additionalProperties:
            type: string
            nullable: true
          description: '<em>target keyword fields and target keywords</em><br>optional field<br>use this parameter to filter the dataset by keywords that certain fields should contain;<br>fields you can specify: <code>title</code>, <code>main_title</code>, <code>previous_title</code>, <code>snippet</code><br>you can indicate several fields;<br><strong>Note</strong>: to match an exact phrase instead of a stand-alone keyword, use double quotes and backslashes; <br>example:<br>`"keyword_fields": {<br>"snippet": "\"logitech mouse\"",<br>"main_title": "sale"<br>}`'
          nullable: true
        page_type:
          type: array
          items:
            type: string
          description: '<em>target page types</em><br>optional field<br>use this parameter to filter the dataset by page types<br>possible values: <br><code>"ecommerce"</code>, <code>"news"</code>, <code>"blogs"</code>, <code>"message-boards"</code>, <code>"organization"</code>'
          nullable: true
        internal_list_limit:
          type: integer
          description: '<em>maximum number of elements within internal arrays</em><br>optional field<br>you can use this field to limit the number of elements within the following arrays:<br><code>top_domains</code><br><code>text_categories</code><br><code>page_categories</code><br><code>countries</code><br><code>languages</code><br>default value: <code>1</code><br>maximum value: <code>20</code>'
          nullable: true
        search_mode:
          type: string
          description: '<em>results grouping type</em><br>optional field<br>possible grouping types:<br><code>as_is</code> - returns all citations for the target <code>keyword</code><br><code>one_per_domain</code> - returns one citation of the <code>keyword</code> per domain<br>default value: <code>as_is</code>'
          nullable: true
        positive_connotation_threshold:
          type: number
          description: '<em>positive connotation threshold</em><br>optional field<br>specified as the probability index threshold for positive sentiment related to the citation content<br>if you specify this field, <code>connotation_types</code> object in the response will only contain data on citations with <code>positive</code> sentiment probability more than or equal to the specified value<br>possible values: from <code>0</code> to <code>1</code><br>default value: <code>0.4</code>'
          nullable: true
        sentiments_connotation_threshold:
          type: number
          description: '<em>sentiment connotation threshold</em><br>optional field<br>specified as the probability index threshold for sentiment connotations related to the citation content<br>if you specify this field, <code>sentiment_connotations</code> object in the response will only contain data on citations where the probability per each sentiment is more than or equal to the specified value<br>possible values: from <code>0</code> to <code>1</code><br>default value: <code>0.4</code>'
          nullable: true
        initial_dataset_filters:
          type: array
          items:
            type: object
            nullable: true
          description: '<em>initial dataset filtering parameters</em><br>optional field<br>initial filtering parameters that apply to fields in the <a href="/v3/content_analysis/search/live/?bash" target="_blank">Search endpoint</a><br><strong>you can add several filters at once (8 filters maximum)</strong><br>you should set a logical operator <code>and</code>, <code>or</code> between the conditions<br>the following operators are supported:<br><code>regex</code>, <code>not_regex</code>, <code>&lt;</code>, <code>&lt;=</code>, <code>&gt;</code>, <code>&gt;=</code>, <code>=</code>, <code>&lt;&gt;</code>, <code>in</code>, <code>not_in</code>, <code>like</code>,<code>not_like</code>, <code>has</code>, <code>has_not</code>, <code>match</code>, <code>not_match</code><br>you can use the <code>%</code> operator with <code>like</code> and <code>not_like</code> to match any string of zero or more characters<br>example:<br><code>["domain","&lt;&gt;", "logitech.com"]</code><p><code>[["domain","&lt;&gt;","logitech.com"],"and",["content_info.connotation_types.negative","&gt;",1000]]</code><p><code>[["domain","&lt;&gt","logitech.com"]],<br>"and",<br>[["content_info.connotation_types.negative","&gt;",1000],<br>"or",<p>["content_info.text_category","has",10994]]]</code><br>for more information about filters, please refer to <a href="/v3/content_analysis/filters" target="_blank" rel="noopener noreferrer">Content Analysis API - Filters</a><br>learn more about the initial dataset filters in <a href="https://dataforseo.com/help-center/what-are-the-initial-dataset-filters-and-how-do-they-work" rel="noopener noreferrer" target="_blank">this help center article.</a>'
          nullable: true
        rank_scale:
          type: string
          description: '<em>defines the scale used for calculating and displaying the <code>rank</code> values</em><br>optional field<p>you can use this parameter to choose whether rank values are presented on a 0–100 or 0–1000 scale<p>possible values:<br><code>one_hundred</code> — rank values are displayed on a 0–100 scale<br><code>one_thousand</code> — rank values are displayed on a 0–1000 scale<p>default value: <code>one_thousand</code><p>learn more about how this parameter works in <a href="https://dataforseo.com/help-center/using-the-rank_scale-parameter-in-content-analysis-api">this Help Center article</a>'
          nullable: true
        tag:
          type: string
          description: <em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response
          nullable: true
      example:
        - keyword: logitech
          search_mode: as_is
          internal_list_limit: 10
    ContentAnalysisRatingDistributionLiveResultInfo:
      type: object
      properties:
        type:
          type: string
          description: type of element
          nullable: true
        min:
          type: number
          description: <em>min rating on a distribution scale</strong></em>
          nullable: true
        max:
          type: number
          description: <em>max rating on a distribution scale</strong></em>
          nullable: true
        metrics:
          type: object
          oneOf:
            - $ref: '#/components/schemas/ContentAnalysisSummaryInfo'
          description: <em>contains rating distribution metrics</strong></em>
          nullable: true
    ContentAnalysisRatingDistributionLiveTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/ContentAnalysisRatingDistributionLiveResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    ContentAnalysisRatingDistributionLiveResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/ContentAnalysisRatingDistributionLiveTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    ContentAnalysisPhraseTrendsLiveRequestInfo:
      type: object
      properties:
        keyword:
          type: string
          description: '<em>target keyword</em><br><strong>required field</strong><br>UTF-8 encoding<br>the keywords will be converted to a lowercase format;<br><strong>Note</strong>: to match an exact phrase instead of a stand-alone keyword, use double quotes and backslashes; <br>example: <br><code>"keyword": "\"tesla palo alto\""</code><p>learn more about rules and limitations of <code>keyword</code> and <code>keywords</code> fields in DataForSEO APIs in this <a href="https://dataforseo.com/help-center/rules-and-limitations-of-keyword-and-keywords-fields-in-dataforseo-apis" rel="noopener noreferrer" target="_blank">Help Center article</a>'
        keyword_fields:
          type: object
          additionalProperties:
            type: string
            nullable: true
          description: '<em>target keyword fields and target keywords</em><br>optional field<br>use this parameter to filter the dataset by keywords that certain fields should contain;<br>fields you can specify: <code>title</code>, <code>main_title</code>, <code>previous_title</code>, <code>snippet</code><br>you can indicate several fields;<br><strong>Note</strong>: to match an exact phrase instead of a stand-alone keyword, use double quotes and backslashes; <br>example:<br>`"keyword_fields": {<br>"snippet": "\"logitech mouse\"",<br>"main_title": "sale"<br>}`'
          nullable: true
        page_type:
          type: array
          items:
            type: string
          description: '<em>target page types</em><br>optional field<br>use this parameter to filter the dataset by page types<br>possible values: <br><code>"ecommerce"</code>, <code>"news"</code>, <code>"blogs"</code>, <code>"message-boards"</code>, <code>"organization"</code>'
          nullable: true
        search_mode:
          type: string
          description: '<em>results grouping type</em><br>optional field<br>possible grouping types:<br><code>as_is</code> - returns data on all citations for the target <code>keyword</code><br><code>one_per_domain</code> - returns data on one citation of the <code>keyword</code> per domain<br>default value: <code>as_is</code>'
          nullable: true
        internal_list_limit:
          type: integer
          description: '<em>maximum number of elements within internal arrays</em><br>optional field<br>you can use this field to limit the number of elements within the following arrays:<br><code>top_domains</code><br><code>text_categories</code><br><code>page_categories</code><br><code>countries</code><br><code>languages</code><br>default value: <code>1</code><br>maximum value: <code>20</code>'
          nullable: true
        date_from:
          type: string
          description: '<em>starting date of the time range</em><br><strong>required field</strong><br>date format: <code>"yyyy-mm-dd"</code><br>example:<br><code>"2019-01-15"</code>'
        date_to:
          type: string
          description: '<em>ending date of the time range</em><br>optional field<br>if you don''t specify this field, today''s date will be used by default<br>date format: <code>"yyyy-mm-dd"</code><br>example:<br><code>"2019-01-15"</code>'
          nullable: true
        date_group:
          type: string
          description: '<em>time range which will be used to group the results</em><br>optional field<br>default value: <code>month</code><br>possible values: <code>day</code>, <code>week</code>, <code>month</code>'
          nullable: true
        initial_dataset_filters:
          type: array
          items:
            type: object
            nullable: true
          description: '<em>initial dataset filtering parameters</em><br>optional field<br>initial filtering parameters that apply to fields in the <a href="/v3/content_analysis/search/live/?bash" target="_blank">Search endpoint</a>;<br><strong>you can add several filters at once (8 filters maximum);</strong><br>you should set a logical operator <code>and</code>, <code>or</code> between the conditions;<br>the following operators are supported:<br><code>regex</code>, <code>not_regex</code>, <code>&lt;</code>, <code>&lt;=</code>, <code>&gt;</code>, <code>&gt;=</code>, <code>=</code>, <code>&lt;&gt;</code>, <code>in</code>, <code>not_in</code>, <code>like</code>,<code>not_like</code>, <code>has</code>, <code>has_not</code>, <code>match</code>, <code>not_match</code><br>you can use the <code>%</code> operator with <code>like</code> and <code>not_like</code> to match any string of zero or more characters;<br>example:<br><code>["domain","&lt;&gt;", "logitech.com"]</code><p><code>[["domain","&lt;&gt;","logitech.com"],"and",["content_info.connotation_types.negative","&gt;",1000]]</code><p><code>[["domain","&lt;&gt","logitech.com"]],<br>"and",<br>[["content_info.connotation_types.negative","&gt;",1000],<br>"or",<p>["content_info.text_category","has",10994]]]</code><br>for more information about filters, please refer to <a href="/v3/content_analysis/filters" target="_blank" rel="noopener noreferrer">Content Analysis API - Filters</a><br>learn more about the initial dataset filters in <a href="https://dataforseo.com/help-center/what-are-the-initial-dataset-filters-and-how-do-they-work" rel="noopener noreferrer" target="_blank">this help center article.</a>'
          nullable: true
        rank_scale:
          type: string
          description: '<em>defines the scale used for calculating and displaying the <code>rank</code> values</em><br>optional field<p>you can use this parameter to choose whether rank values are presented on a 0–100 or 0–1000 scale<p>possible values:<br><code>one_hundred</code> — rank values are displayed on a 0–100 scale<br><code>one_thousand</code> — rank values are displayed on a 0–1000 scale<p>default value: <code>one_thousand</code><p>learn more about how this parameter works in <a href="https://dataforseo.com/help-center/using-the-rank_scale-parameter-in-content-analysis-api">this Help Center article</a>'
          nullable: true
        tag:
          type: string
          description: <em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response
          nullable: true
      example:
        - keyword: logitech
          search_mode: as_is
          date_from: '2022-09-01'
          date_group: month
    ContentAnalysisPhraseTrendsLiveResultInfo:
      type: object
      properties:
        type:
          type: string
          description: type of element
          nullable: true
        date:
          type: string
          description: <em>date for which the data is provided</em>
          nullable: true
        total_count:
          type: integer
          description: <em>total number of results in our database relevant to your request</em>
          format: int64
          nullable: true
        rank:
          type: integer
          description: <em>rank of all URLs citing the <code>keyword</code></em><br>normalized sum of ranks of all URLs citing the target <code>keyword</code> for the given date
          nullable: true
        top_domains:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/TopDomainInfo'
            nullable: true
          description: <em>top domains citing the target keyword</em><br>contains objects with top domains citing the target keyword and citation count per each domain
          nullable: true
        sentiment_connotations:
          type: object
          additionalProperties:
            type: integer
            format: int64
            nullable: true
          description: '<em>sentiment connotations</em><br>contains sentiments (emotional reactions) related to the target keyword citation and the number of citations per each sentiment<br>possible connotations: <code>"anger"</code>, <code>"happiness"</code>, <code>"love"</code>, <code>"sadness"</code>, <code>"share"</code>, <code>"fun"</code>'
          nullable: true
        connotation_types:
          type: object
          additionalProperties:
            type: integer
            format: int64
            nullable: true
          description: '<em>connotation types</em><br>contains types of sentiments (sentiment polarity) related to the keyword citation and citation count per each sentiment type<br>possible connotation types: <code>"positive"</code>, <code>"negative"</code>, <code>"neutral"</code>'
          nullable: true
        text_categories:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/ContentAnalysisCategoriesInfo'
            nullable: true
          description: '<em>text categories</em><br>contains objects with text categories and citation count in each text category<br>to obtain a full list of available categories, refer to the <a href="/v3/content_analysis/categories/" rel="noopener noreferrer" target="_blank">Categories</a> endpoint'
          nullable: true
        page_categories:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/ContentAnalysisCategoriesInfo'
            nullable: true
          description: '<em>page categories</em><br>contains objects with page categories and citation count in each page category<br>to obtain a full list of available categories, refer to the <a href="/v3/content_analysis/categories/" rel="noopener noreferrer" target="_blank">Categories</a> endpoint'
          nullable: true
        page_types:
          type: object
          additionalProperties:
            type: integer
            format: int64
            nullable: true
          description: <em>page types</em><br>contains page types and citation count per each page type
          nullable: true
        countries:
          type: object
          additionalProperties:
            type: integer
            format: int64
            nullable: true
          description: '<em>countries</em><br>contains countries and citation count in each country<br>to obtain a full list of available countries, refer to the <a href="/v3/content_analysis/locations/" rel="noopener noreferrer" target="_blank">Locations</a> endpoint'
          nullable: true
        languages:
          type: object
          additionalProperties:
            type: integer
            format: int64
            nullable: true
          description: '<em>languages</em><br>contains languages and citation count in each language<br>to obtain a full list of available languages, refer to the <a href="/v3/content_analysis/languages/" rel="noopener noreferrer" target="_blank">Languages</a> endpoint'
          nullable: true
    ContentAnalysisPhraseTrendsLiveTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/ContentAnalysisPhraseTrendsLiveResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    ContentAnalysisPhraseTrendsLiveResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/ContentAnalysisPhraseTrendsLiveTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    ContentAnalysisCategoryTrendsLiveRequestInfo:
      type: object
      properties:
        category_code:
          type: integer
          description: '<em>target category code</em><br><strong>required field</strong><br>to obtain a full list of available categories, refer to the <a href="/v3/content_analysis/categories/" rel="noopener noreferrer" target="_blank">Categories</a> endpoint'
          nullable: true
        page_type:
          type: array
          items:
            type: string
          description: '<em>target page types</em><br>optional field<br>use this parameter to filter the dataset by page types<br>possible values: <br><code>"ecommerce"</code>, <code>"news"</code>, <code>"blogs"</code>, <code>"message-boards"</code>, <code>"organization"</code>'
          nullable: true
        search_mode:
          type: string
          description: '<em>results grouping type</em><br>optional field<br>possible grouping types:<br><code>as_is</code> - returns data on all citations for the target <code>category_code</code><br><code>one_per_domain</code> - returns data on one citation of the <code>category_code</code> per domain<br>default value: <code>as_is</code>'
          nullable: true
        internal_list_limit:
          type: integer
          description: '<em>maximum number of elements within internal arrays</em><br>optional field<br>you can use this field to limit the number of elements within the following arrays:<br><code>top_domains</code><br><code>text_categories</code><br><code>page_categories</code><br><code>countries</code><br><code>languages</code><br>default value: <code>1</code><br>maximum value: <code>20</code>'
          nullable: true
        date_from:
          type: string
          description: '<em>starting date of the time range</em><br><strong>required field</strong><br>minimum value: <code>2022-10-31</code><br>date format: <code>"yyyy-mm-dd"</code><br>example:<br><code>"2019-01-15"</code>'
        date_to:
          type: string
          description: '<em>ending date of the time range</em><br>optional field<br>if you don''t specify this field, today''s date will be used by default<br>date format: <code>"yyyy-mm-dd"</code><br>example:<br><code>"2019-01-15"</code>'
          nullable: true
        date_group:
          type: string
          description: '<em>time range which will be used to group the results</em><br>optional field<br>default value: <code>month</code><br>possible values: <code>day</code>, <code>week</code>, <code>month</code>'
          nullable: true
        initial_dataset_filters:
          type: array
          items:
            type: object
            nullable: true
          description: '<em>initial dataset filtering parameters</em><br>optional field<br>initial filtering parameters that apply to fields in the <a href="/v3/content_analysis/search/live/?bash" target="_blank">Search endpoint</a>;<br><strong>you can add several filters at once (8 filters maximum)</strong><br>you should set a logical operator <code>and</code>, <code>or</code> between the conditions<br>the following operators are supported:<br><code>regex</code>, <code>not_regex</code>, <code>&lt;</code>, <code>&lt;=</code>, <code>&gt;</code>, <code>&gt;=</code>, <code>=</code>, <code>&lt;&gt;</code>, <code>in</code>, <code>not_in</code>, <code>like</code>,<code>not_like</code>, <code>has</code>, <code>has_not</code>, <code>match</code>, <code>not_match</code><br>you can use the <code>%</code> operator with <code>like</code> and <code>not_like</code> to match any string of zero or more characters<br>example:<br><code>["domain","&lt;&gt;", "logitech.com"]</code><p><code>[["domain","&lt;&gt;","logitech.com"],"and",["content_info.connotation_types.negative","&gt;",1000]]</code><p><code>[["domain","&lt;&gt","logitech.com"]],<br>"and",<br>[["content_info.connotation_types.negative","&gt;",1000],<br>"or",<p>["content_info.text_category","has",10994]]]</code><br>for more information about filters, please refer to <a href="/v3/content_analysis/filters" target="_blank" rel="noopener noreferrer">Content Analysis API - Filters</a><br>learn more about the initial dataset filters in <a href="https://dataforseo.com/help-center/what-are-the-initial-dataset-filters-and-how-do-they-work" rel="noopener noreferrer" target="_blank">this help center article.</a>'
          nullable: true
        rank_scale:
          type: string
          description: '<em>defines the scale used for calculating and displaying the <code>rank</code> values</em><br>optional field<p>you can use this parameter to choose whether rank values are presented on a 0–100 or 0–1000 scale<p>possible values:<br><code>one_hundred</code> — rank values are displayed on a 0–100 scale<br><code>one_thousand</code> — rank values are displayed on a 0–1000 scale<p>default value: <code>one_thousand</code><p>learn more about how this parameter works in <a href="https://dataforseo.com/help-center/using-the-rank_scale-parameter-in-content-analysis-api">this Help Center article</a>'
          nullable: true
        tag:
          type: string
          description: <em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response
          nullable: true
      example:
        - category_code: 10994
          search_mode: as_is
          date_from: '2022-09-01'
          date_group: month
    ContentAnalysisCategoryTrendsLiveResultInfo:
      type: object
      properties:
        type:
          type: string
          description: type of element
          nullable: true
        date:
          type: string
          description: <em>date for which the data is provided</em>
          nullable: true
        total_count:
          type: integer
          description: <em>total number of results in our database relevant to your request</em>
          format: int64
          nullable: true
        rank:
          type: integer
          description: <em>rank of all URLs citing the <code>keyword</code></em><br>normalized sum of ranks of all URLs citing the target <code>keyword</code> for the given date
          nullable: true
        top_domains:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/TopDomainInfo'
            nullable: true
          description: <em>top domains citing the target keyword</em><br>contains objects with top domains citing the target category and citation count per each domain
          nullable: true
        sentiment_connotations:
          type: object
          additionalProperties:
            type: integer
            format: int64
            nullable: true
          description: '<em>sentiment connotations</em><br>contains sentiments (emotional reactions) related to the target category citation and the number of citations per each sentiment<br>possible connotations: <code>"anger"</code>, <code>"fear"</code>, <code>"happiness"</code>, <code>"love"</code>, <code>"sadness"</code>, <code>"share"</code>, <code>"neutral"</code>, <code>"fun"</code>'
          nullable: true
        connotation_types:
          type: object
          additionalProperties:
            type: integer
            format: int64
            nullable: true
          description: '<em>connotation types</em><br>contains types of sentiments (sentiment polarity) related to the category citation and citation count per each sentiment type<br>possible connotation types: <code>"positive"</code>, <code>"negative"</code>, <code>"neutral"</code>'
          nullable: true
        text_categories:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/ContentAnalysisCategoriesInfo'
            nullable: true
          description: '<em>text categories</em><br>contains objects with text categories and citation count in each text category<br>to obtain a full list of available categories, refer to the <a href="/v3/content_analysis/categories/" rel="noopener noreferrer" target="_blank">Categories</a> endpoint'
          nullable: true
        page_categories:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/ContentAnalysisCategoriesInfo'
            nullable: true
          description: '<em>page categories</em><br>contains objects with page categories and citation count in each page category<br>to obtain a full list of available categories, refer to the <a href="/v3/content_analysis/categories/" rel="noopener noreferrer" target="_blank">Categories</a> endpoint'
          nullable: true
        page_types:
          type: object
          additionalProperties:
            type: integer
            format: int64
            nullable: true
          description: <em>page types</em><br>contains page types and citation count per each page type
          nullable: true
        countries:
          type: object
          additionalProperties:
            type: integer
            format: int64
            nullable: true
          description: '<em>countries</em><br>contains countries and citation count in each country<br>to obtain a full list of available countries, refer to the <a href="/v3/content_analysis/locations/" rel="noopener noreferrer" target="_blank">Locations</a> endpoint'
          nullable: true
        languages:
          type: object
          additionalProperties:
            type: integer
            format: int64
            nullable: true
          description: '<em>languages</em><br>contains languages and citation count in each language<br>to obtain a full list of available languages, refer to the <a href="/v3/content_analysis/languages/" rel="noopener noreferrer" target="_blank">Languages</a> endpoint'
          nullable: true
    ContentAnalysisCategoryTrendsLiveTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/ContentAnalysisCategoryTrendsLiveResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    ContentAnalysisCategoryTrendsLiveResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/ContentAnalysisCategoryTrendsLiveTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    MerchantIdListRequestInfo:
      type: object
      properties:
        datetime_from:
          type: string
          description: '<em>start time for filtering results</em><br><strong>required field</strong><br>if <code>include_metadata</code> is set to <code>true</code>, maximum value: a month from current datetime;<br>if <code>include_metadata</code> is set to <code>false</code>, maximum value: six months from current datetime;<br>must be specified in the UTC format: "yyyy-mm-dd hh-mm-ss +00:00"<br>example:<br><code>2023-01-15 12:57:46 +00:00</code>'
        datetime_to:
          type: string
          description: '<em>finish time for filtering results</em><br><strong>required field</strong><br>maximum value: current datetime;<br>must be specified in the UTC format: "yyyy-mm-dd hh-mm-ss +00:00"<br>example:<br><code>2023-01-31 13:57:46 +00:00</code>'
        limit:
          type: integer
          description: '<em>the maximum number of returned task IDs</em><br>optional field<br>default value: <code>1000</code><br>maximum value: <code>1000</code>'
          nullable: true
        offset:
          type: integer
          description: '<em>offset in the results array of returned task IDs</em><br>optional field<br>default value: <code>0</code><br>if you specify the <code>10</code> value, the first ten tasks in the results array will be omitted'
          nullable: true
        sort:
          type: string
          description: '<em>sorting by task execution time</em><br>optional field<br>possible values: <code>"asc"</code>, <code>"desc"</code><br>default value: <code>"asc"</code>'
          nullable: true
        include_metadata:
          type: boolean
          description: '<em>include task metadata in the respond</em><br>optional field<br>default value: <code>false</code>'
          nullable: true
      example:
        - datetime_from: '2026-09-10 11:12:35'
          datetime_to: '2026-09-20 11:12:35'
          limit: 10
          include_metadata: true
    MerchantIdListResultInfo:
      type: object
      properties:
        id:
          type: string
          description: <em>task identifier</em><br><strong>unique task identifier in our system in the <a href="https://en.wikipedia.org/wiki/Universally_unique_identifier">UUID</a> format</strong>
          nullable: true
        url:
          type: string
          description: <em>URL of the task</em><br>URL you used for making an API call
          nullable: true
        datetime_posted:
          type: string
          description: '<em>date and time when the task was made</em><br>in the UTC format: "yyyy-mm-dd hh-mm-ss +00:00"<br>example:<br><code>2023-01-15 12:57:46 +00:00</code>'
          nullable: true
        datetime_done:
          type: string
          description: '<em>date and time when the task was completed</em><br>in the UTC format: "yyyy-mm-dd hh-mm-ss +00:00"<br>example:<br><code>2023-01-15 12:57:46 +00:00</code>'
          nullable: true
        status:
          type: string
          description: <em>informational message of the task</em><br>you can find the full list of general informational messages <a href="/v3/appendix-errors/">here</a>
          nullable: true
        cost:
          type: number
          description: '<em>total tasks cost, USD</em>'
          nullable: true
        metadata:
          type: object
          additionalProperties:
            type: object
            nullable: true
          description: <em>contains parameters you specified in the POST request</em>
          nullable: true
    MerchantIdListTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/MerchantIdListResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    MerchantIdListResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/MerchantIdListTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    MerchantErrorsRequestInfo:
      type: object
      properties:
        limit:
          type: integer
          description: '<em>the maximum number of returned tasks that responded with an error</em><br>optional field<br>default value: <code>1000</code><br>maximum value: <code>1000</code>'
          nullable: true
        offset:
          type: integer
          description: '<em>offset in the results array of returned tasks</em><br>optional field<br>default value: <code>0</code><br>if you specify the <code>10</code> value, the first ten tasks in the results array will be omitted and the data will be provided for the successive tasks'
          nullable: true
        filtered_function:
          type: string
          description: '<em>return tasks with a certain function</em><br>use this field to obtain a list of tasks that returned an error filtered by a certain function<br>you can filter the results by the values you receive in the <code>function</code> fields of the API response<br>i.e., once you receive unfiltered results, you can call this API again to filter them by <code>function</code> <br>example: <code>sellers/ad_url</code>, <code>postback_url</code>, <code>pingback_url</code>'
          nullable: true
        datetime_from:
          type: string
          description: '<em>start time for filtering results</em><br>optional field<br>allows filtering results by the <code>datetime</code> parameter within the range of the last 7 days;<br>must be specified in the UTC format: "yyyy-mm-dd hh-mm-ss +00:00"<br>example:<br><code>2021-11-15 12:57:46 +00:00</code>'
          nullable: true
        datetime_to:
          type: string
          description: '<em>finish time for filtering results</em><br>optional field<br>allows filtering results by the <code>datetime</code> parameter within the range of the last 7 days;<br>must be specified in the UTC format: "yyyy-mm-dd hh-mm-ss +00:00"<br>example:<br><code>2021-11-15 13:57:46 +00:00</code>'
          nullable: true
      example:
        - limit: 10
          offset: 0
          filtered_function: pingback_url
    MerchantErrorsResultInfo:
      type: object
      properties:
        id:
          type: string
          description: <em>task identifier</em><br><strong>unique task identifier in our system in the <a href="https://en.wikipedia.org/wiki/Universally_unique_identifier">UUID</a> format</strong>
          nullable: true
        datetime:
          type: string
          description: '<em>date and time when an error occurred</em><br>in the UTC format: "yyyy-mm-dd hh-mm-ss +00:00"<br>example:<br><code>2019-11-15 12:57:46 +00:00</code>'
          nullable: true
        function:
          type: string
          description: <em>corresponding API function</em>
          nullable: true
        error_code:
          type: integer
          description: <em>error code</em>
          nullable: true
        error_message:
          type: string
          description: <em>error message or error URL</em><br>error message <a href="https://docs.dataforseo.com/v3/appendix/errors/" rel="noopener noreferrer" target="_blank">(see full list)</a> or URL that caused an error
          nullable: true
        http_url:
          type: string
          description: <em>URL that caused an error</em><br>URL you used for making an API call or pingback/postback URL
          nullable: true
        http_method:
          type: string
          description: <em>HTTP method</em>
          nullable: true
        http_code:
          type: integer
          description: <em>HTTP status code</em>
          nullable: true
        http_time:
          type: number
          description: '<em>time taken by HTTP request</em><br>for tasks set with a pingback/postback, this field will show the time it took your server to respond'
          nullable: true
        http_response:
          type: string
          description: <em>HTTP response</em><br>server response
          nullable: true
    MerchantErrorsTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/MerchantErrorsResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    MerchantErrorsResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/MerchantErrorsTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    MerchantGoogleLanguagesResultInfo:
      type: object
      properties:
        language_name:
          type: string
          description: <em>language name</em>
          nullable: true
        language_code:
          type: string
          description: <em>language code according to <a href="https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes" target="_blank" rel="noopener noreferrer">ISO 639-1</a></em>
          nullable: true
    MerchantGoogleLanguagesTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/MerchantGoogleLanguagesResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    MerchantGoogleLanguagesResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/MerchantGoogleLanguagesTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    MerchantGoogleLocationsResultInfo:
      type: object
      properties:
        location_code:
          type: integer
          description: <em>location code</em>
          nullable: true
        location_name:
          type: string
          description: <em>full name of the location</em>
          nullable: true
        location_name_parent:
          type: string
          description: '<em>the name of the superordinate location</em><br>example:<br>`"location_name": "Arkansas,United States"`,<br>`"location_name_parent": "United States"`'
          nullable: true
        country_iso_code:
          type: string
          description: <em>ISO country code of the location</em>
          nullable: true
        location_type:
          type: string
          description: <em>location type</em>
          nullable: true
    MerchantGoogleLocationsTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/MerchantGoogleLocationsResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    MerchantGoogleLocationsResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/MerchantGoogleLocationsTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    MerchantGoogleLocationsCountryResultInfo:
      type: object
      properties:
        location_code:
          type: integer
          description: <em>location code</em>
          nullable: true
        location_name:
          type: string
          description: <em>full name of the location</em>
          nullable: true
        location_name_parent:
          type: string
          description: '<em>the name of the superordinate location</em><br>example:<br>`"location_name": "Arkansas,United States"`,<br>`"location_name_parent": "United States"`'
          nullable: true
        country_iso_code:
          type: string
          description: <em>ISO country code of the location</em>
          nullable: true
        location_type:
          type: string
          description: <em>location type</em>
          nullable: true
    MerchantGoogleLocationsCountryTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/MerchantGoogleLocationsCountryResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    MerchantGoogleLocationsCountryResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/MerchantGoogleLocationsCountryTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    MerchantGoogleProductsTaskPostRequestInfo:
      type: object
      properties:
        keyword:
          type: string
          description: '<em>keyword</em><br><strong>required field</strong><br>you can specify <strong>up to 700 characters</strong> in the <code>keyword</code> filed<br><strong>all %## will be decoded (plus character ‘+’ will be decoded to a space character)</strong><br>if you need to use the “%” character for your <code>keyword</code>, please specify it as “%25”;<p>learn more about rules and limitations of <code>keyword</code> and <code>keywords</code> fields in DataForSEO APIs in this <a href="https://dataforseo.com/help-center/rules-and-limitations-of-keyword-and-keywords-fields-in-dataforseo-apis" rel="noopener noreferrer" target="_blank">Help Center article</a>'
        url:
          type: string
          description: '<em>direct URL of the search query</em><br>optional field<br>you can specify a direct URL and we will sort it out to the necessary fields. Note that this method is the most difficult for our API to process and also requires you to specify the exact language and location in the URL. In most cases, we wouldn’t recommend using this method.<br>example:<br><code class="long-string">https://www.google.com/search?q=fish&hl=en&gl=US&gws_rd=cr&uule=w+CAIQIFISCQs2MuSEtepUEUK33kOSuTsc</code>'
          nullable: true
        priority:
          type: integer
          description: <em>task priority</em><br>optional field<br>can take the following values:<br>1 – normal execution priority (set by default)<br>2 – high execution priorityYou will be additionally charged for the tasks with high execution priority.<br>The cost can be calculated on the <a title="Pricing" href="https://dataforseo.com/pricing/merchant/google-shopping-api" target="_blank" rel="noopener noreferrer">Pricing</a> page.
          nullable: true
        location_name:
          type: string
          description: '<em>full name of the location</em><br><strong>required field if you don''t specify</strong> <code>location_code</code> or <code>location_coordinate</code><br><strong>if you use this field, you don''t need to specify <code>location_code</code> or <code>location_coordinate</code></strong><br>you can receive the list of available Google Shopping locations with their <code>location_name</code> by making a separate request to the <code>https://api.dataforseo.com/v3/merchant/google/locations</code><br>example:<br><code class="long-string">London,England,United Kingdom</code>'
        location_code:
          type: integer
          description: '<em>location code</em><br><strong>required field if you don''t specify</strong> <code>location_name</code>_or <code>location_coordinate</code><br><strong>if you use this field, you don''t need to specify <code>location_name</code> or <code>location_coordinate</code></strong><br>you can receive the list of available Google Shopping locations with their <code>location_code</code> by making a separate request to the <code>https://api.dataforseo.com/v3/merchant/google/locations</code><br>example:<br><code class="long-string">2840</code>'
        location_coordinate:
          type: string
          description: '<em>GPS coordinates of a location</em><br><strong>required field if you don''t specify</strong> <code>location_name</code>_or <code>location_code</code><br><strong>if you use this field, you don''t need to specify <code>location_name</code> or <code>location_code</code></strong><br><code>location_coordinate</code> parameter should be specified in the <em>"latitude,longitude,radius"</em> format<br>the maximum number of decimal digits for <em>"latitude"</em> and <em>"longitude"</em>: 7<br>the minimum value for <em>"radius"</em>: 199.9<br>example:<br><code class="long-string">53.476225,-2.243572,200</code>'
        language_name:
          type: string
          description: '<em>full name of the language</em><br><strong>required field if you don''t specify</strong> <code>language_code</code><br><strong>if you use this field, you don''t need to specify <code>language_code</code></strong><br>you can receive the list of available Google Shopping languages with their <code>language_name</code> by making a separate request to the <code>https://api.dataforseo.com/v3/merchant/google/languages</code><br>example:<br><code class="long-string">English</code>'
        language_code:
          type: string
          description: '<em>language code</em><br><strong>required field if you don''t specify</strong> <code>language_name</code><br><strong>if you use this field, you don''t need to specify <code>language_name</code></strong><br>you can receive the list of available Google Shopping languages with their <code>language_code</code>_by making a separate request to the <code>https://api.dataforseo.com/v3/merchant/google/languages</code><em><br></em>example:<em><br></em><code class="long-string">en</code>'
        se_domain:
          type: string
          description: '<em>search engine domain</em><br>optional field<br>we choose the relevant search engine domain automatically according to the location and language you specify<br>however, you can set a custom search engine domain in this field<br>example:<br><code><em>google.co.uk</em></code>, <code><em>google.com.au</em></code>, <code><em>google.de</em></code>, etc.'
          nullable: true
        depth:
          type: integer
          description: '<em>parsing depth</em><br>optional field<br>number of results to be retrieved from Google Shopping SERP<br>default value: <code>40</code><br>max value: <code>120</code><br><strong>Your account will be billed per each SERP containing up to 40 results;</strong> <br>Setting depth above 40 may result in additional charges <a href="https://dataforseo.com/help-center/how-many-results-scraped" rel="noopener noreferrer" target="_blank">if the search engine returns more than 40 results</a>;<br>The cost can be calculated on the <a title="Pricing" href="https://dataforseo.com/pricing/merchant/google-shopping-api" target="_blank" rel="noopener noreferrer">Pricing</a> page.'
          nullable: true
        max_crawl_pages:
          type: integer
          description: '<em>page crawl limit</em><br>optional field<br>number of search results pages to crawl<br>max value: <code>7</code><br><strong>Note:</strong> the <code>max_crawl_pages</code> and <code>depth</code> parameters complement each other;<br>learn more at <a href="https://dataforseo.com/help-center/what-is-max-crawl-pages-and-how-does-it-work" rel="noopener noreferrer" target="_blank">our help center</a>'
          nullable: true
        search_param:
          type: string
          description: '<em>additional parameters of the search query</em><br>optional field<br>you can use the following search URL parameters for customizing the search;<br>example:<br><code>&amp;tbs=ppr_min:45</code> – search for products that cost <em>more than 45 USD</em>;<br><code>&amp;tbs=ppr_max:50</code> – search for products that cost <em>less than 50 USD</em>;<br><code>&amp;tbs=p_ord:p</code> – sort by <em>ascending price</em>;<br><code>&amp;tbs=p_ord:pd</code> – sort by <em>descending price</em>;<br><code>&amp;tbs=p_ord:rv</code> – sort by <em>review score</em>;<br><code>&amp;tbs=ppr_max:50,p_ord:rv</code> – sort by <em>review score</em> with the <em>maximum price of 50 USD.</em>;<br><code>&udm=28</code> – use new Google Shopping markup with 40 SERP results returned by default (the cost for one SERP is deducted accordingly); the maximum <code>depth</code> is 200; this parameter must be specified without <code>tbm=shop</code> in the <code>url</code>;<br><code>&shoprs=$value</code> – specify advanced filtering and sorting in the new Shopping markup; replace <code>$value</code> with a string in protobuf Base64 format; <a href="https://dataforseo.com/help-center/using-the-shoprs-parameter-in-google-shopping-merchant-api" target="_blank">learn more on our help center.</a><br>  <br><strong>Note</strong> that <code>search_param</code> values will be ignored if any of the following parameters are used: <code>price_min</code>, <code>price_max</code>, <code>sort_by</code>'
          nullable: true
        price_min:
          type: integer
          description: '<em>minimum product price</em><br>optional field<br>minimum price of the returned products listed on Google Shopping for the specified query<br>example:<br><code>5</code><br><strong>Note:</strong> if you specify <code>price_min</code>, the <code>search_param</code> parameter will be ignored'
          nullable: true
        price_max:
          type: integer
          description: '<em>maximum product price</em><br>optional field<br>maximum price of the returned products listed on Google Shopping for the specified query<br>example:<br><code>100</code><br><strong>Note:</strong> if you specify <code>price_max</code>, the <code>search_param</code> parameter will be ignored'
          nullable: true
        sort_by:
          type: string
          description: '<em>results sorting rules</em><br>optional field<br>the following sorting rules are supported:<br><code>review_score</code>, <code>price_low_to_high</code>, <code>price_high_to_low</code><br>example:<br><code>sort_by:"review_score"</code><br><strong>Note:</strong> if you specify <code>sort_by</code>, the <code>search_param</code> parameter will be ignored'
          nullable: true
        tag:
          type: string
          description: <em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response
          nullable: true
        postback_url:
          type: string
          description: '<em>URL for sending task results</em><br>optional field<br>once the task is completed, we will send a POST request with its results compressed in the <code>gzip</code> format to the <code>postback_url</code> you specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/postbackscript?id=$id</code><br><code>http://your-server.com/postbackscript?id=$id&amp;tag=$tag</code><br><strong>Note:</strong> special characters in <code>postback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href="https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api" target="_blank" rel="noopener noreferrer">Help Center</a>'
          nullable: true
        postback_data:
          type: string
          description: '<em>postback_url datatype</em><br><strong>required field if you specify <code>postback_url</code></strong><br>corresponds to the datatype that will be sent to your server<br>possible values:<br><code>advanced</code>, <code>html</code>'
        pingback_url:
          type: string
          description: '<em>notification URL of a completed task</em><br>optional field<br>when a task is completed we will notify you by GET request sent to the URL you have specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/pingscript?id=$id</code><br><code>http://your-server.com/pingscript?id=$id&amp;tag=$tag</code><br><strong>Note:</strong> special characters in <code>pingback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href="https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api" target="_blank" rel="noopener noreferrer">Help Center</a>'
          nullable: true
      example:
        - language_code: en
          location_code: 2840
          keyword: iphone
          price_min: 5
    MerchantGoogleProductsTaskPostTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: object
              description: '<em>array of results</em><br>in this case, the value will be <code>null</code>'
              nullable: true
    MerchantGoogleProductsTaskPostResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/MerchantGoogleProductsTaskPostTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    MerchantGoogleProductsTasksReadyResultInfo:
      type: object
      properties:
        id:
          type: string
          description: <em>task identifier of the completed task</em><br><strong>unique task identifier in our system in the <a href="https://en.wikipedia.org/wiki/Universally_unique_identifier">UUID</a> format</strong>
          nullable: true
        se:
          type: string
          description: <em>search engine specified when setting the task</em>
          nullable: true
        se_type:
          type: string
          description: '<em>type of search engine</em><br>example: <code>products</code>'
          nullable: true
        date_posted:
          type: string
          description: <em>date when the task was posted (in the UTC format)</em>
          nullable: true
        tag:
          type: string
          description: <em>user-defined task identifier</em>
          nullable: true
        endpoint_advanced:
          type: string
          description: <em>URL for collecting the results of Google Shopping Products Advanced task</em>
          nullable: true
        endpoint_html:
          type: string
          description: <em>URL for collecting the results of Google Shopping Products HTML task</em>
          nullable: true
    MerchantGoogleProductsTasksReadyTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/MerchantGoogleProductsTasksReadyResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    MerchantGoogleProductsTasksReadyResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/MerchantGoogleProductsTasksReadyTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    MerchantTasksReadyResultInfo:
      type: object
      properties:
        id:
          type: string
          description: <em>task identifier of the completed task</em><br><strong>unique task identifier in our system in the <a href="https://en.wikipedia.org/wiki/Universally_unique_identifier">UUID</a> format</strong>
          nullable: true
        se:
          type: string
          description: <em>search engine specified when setting the task</em>
          nullable: true
        se_type:
          type: string
          description: <em>type of search engine</em>
          nullable: true
        date_posted:
          type: string
          description: <em>date when the task was posted (in the UTC format)</em>
          nullable: true
        tag:
          type: string
          description: <em>user-defined task identifier</em>
          nullable: true
        endpoint_advanced:
          type: string
          description: <em>URL for collecting the results of Amazon Sellers Advanced task</em>
          nullable: true
        endpoint_html:
          type: string
          description: <em>URL for collecting the results of Amazon Sellers HTML task</em>
          nullable: true
    MerchantTasksReadyTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/MerchantTasksReadyResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    MerchantTasksReadyResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/MerchantTasksReadyTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    RatingElement:
      type: object
      properties:
        type:
          type: string
          description: type of element
          nullable: true
        position:
          type: string
          description: '<em>the alignment of the element in Google Shopping SERP</em><br>possible values:<br><code>left</code>, <code>right</code>'
          nullable: true
        rating_type:
          type: string
          description: '<i>the type of rating</i><br>here you can find the following elements: <code>Max5</code>, <code>Percents</code>, <code>CustomMax</code>'
          nullable: true
        value:
          type: number
          description: <em>value of the rating</em>
          nullable: true
        votes_count:
          type: integer
          description: <em>the amount of feedback</em>
          format: int64
          nullable: true
        rating_max:
          type: integer
          description: the maximum value for a rating_type
          nullable: true
    DeliveryInfo:
      type: object
      properties:
        delivery_date_from:
          type: string
          description: '<em>earliest delivery date</em><br>the earliest date when the product can be shipped, in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”<br>example: <code>2019-11-15 12:57:46 +00:00</code>'
          nullable: true
        delivery_date_to:
          type: string
          description: '<em>latest delivery date</em><br>the latest date when the product can be delivered, in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”<br>example: <code>2019-11-15 12:57:46 +00:00</code>'
          nullable: true
        fastest_delivery_date_from:
          type: string
          description: '<em>earliest free delivery date</em><br>the earliest date when the product can be delivered with a fast delivery option, in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”<br>example: <code>2019-11-15 12:57:46 +00:00</code>'
          nullable: true
        fastest_delivery_date_to:
          type: string
          description: '<em>latest free delivery date</em><br>the latest date when the product can be delivered with a fast delivery option, in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”<br>example: <code>2019-11-15 12:57:46 +00:00</code>'
          nullable: true
        delivery_message:
          type: string
          description: <em>delivery information</em><br>message accompanying the delivery information as posted by the seller
          nullable: true
        delivery_price:
          type: object
          oneOf:
            - $ref: '#/components/schemas/PriceInfo'
          description: '<em>price for the delivery</em><br>price of the delivery based on the location you specified in the POST request;<br>if free delivery is available, the value is <code>null</code>'
          nullable: true
    StoresCountInfo:
      type: object
      properties:
        count:
          type: integer
          description: <em>number of stores that offer the product</em>
          nullable: true
        displayed_text:
          type: string
          description: <em>text displayed on the Google Shopping page</em>
          nullable: true
        count_from_text:
          type: boolean
          description: '<em>whether the number of stores is taken from text</em><br>indicates whether the number of stores is taken from <code>displayed_text</code>;<br>if the API finds the exact number of stores in the HTML code of the Google Shopping page, this parameter is <code>false</code>;<br>if the API cannot find the number of stores in the HTML code of the page, it takes the number from the <code>displayed_text</code>;<br>in this case, the parameter is <code>true</code>'
          nullable: true
    GoogleShoppingSerpElementItem:
      type: object
      allOf:
        - type: object
          oneOf:
            - $ref: '#/components/schemas/BaseMerchantGoogleShoppingProductsElementItem'
          nullable: true
        - type: object
          properties:
            domain:
              type: string
              description: <em>domain of the URL</em><br>domain of the URL where a special offer is posted<br><strong>Note:</strong> this field is deprecated and will return <code>null</code>
              nullable: true
            title:
              type: string
              description: <em>title of the element</em>
              nullable: true
            description:
              type: string
              description: <em>description of the product in Google Shopping SERP</em>
              nullable: true
            url:
              type: string
              description: <em>URL pointing at special offer page</em><br>URL where a special offer is posted<br><strong>Note:</strong> this field is deprecated and will return <code>null</code>
              nullable: true
            shopping_url:
              type: string
              description: <em>URL to the product page on Google Shopping</em>
              nullable: true
            tags:
              type: array
              items:
                type: string
                nullable: true
              description: <em>tags assigned to the product</em>
              nullable: true
            price:
              type: number
              description: <em>product price</em><br>example:<br><code>384.99</code>
              nullable: true
            price_multiplier:
              type: integer
              description: <em>price multiplier for instalment plan</em><br>indicates the number of months covered by the monthly payment for the product
              nullable: true
            old_price:
              type: number
              description: <em>product old price</em><br>displayed if the product price has been changed<br>example:<br><code>499</code>
              nullable: true
            currency:
              type: string
              description: <em>currency in the <a href="https://en.wikipedia.org/wiki/ISO_4217">ISO</a> format</em><br>example:<br><code>USD</code>
              nullable: true
            product_id:
              type: string
              description: '<em>unique product identifier on Google Shopping</em><br>note that there is no full list of possible values as the <code>product_id</code> is a dynamic value assigned by Google<br>if there are no values, you will get <code>null</code><br>example:<br><code>4485466949985702538</code><br>learn more about the parameter in <a href="https://dataforseo.com/help-center/product-id-google-shopping" rel="noopener noreferrer" target="_blank">this help center guide</a>'
              nullable: true
            data_docid:
              type: string
              description: <em>unique identifier of the SERP data element</em><br>note that there is no full list of possible values as the <code>data_docid</code> is a dynamic value assigned by Google<br>example:<br><code>17363035694596624076</code>
              nullable: true
            seller:
              type: string
              description: <em>name of the seller</em><br>the name of the company that placed a corresponding product on Google Shopping
              nullable: true
            additional_specifications:
              type: object
              additionalProperties:
                type: string
                nullable: true
              description: <em>object containing additional url parameters</em><br>you can get more details about the product by using this object in the POST request to the <a href="/v3/merchant/google/products/task_post/?php" rel="noopener noreferrer" target="_blank">Google Shopping Product Specification</a> and <a href="/v3/merchant/google/sellers/task_post/?php" rel="noopener noreferrer" target="_blank">Google Shopping Sellers</a> endpoint
              nullable: true
            reviews_count:
              type: integer
              description: '<em>number of product reviews</em><br>indicates the number of reviews left by users on Google Shopping<br>if there are no values, you will get <code>null</code>'
              format: int64
              nullable: true
            is_best_match:
              type: boolean
              description: '<em>"best match" label</em><br>if the value is <code>true</code>, the product is marked with the "best match" label<br>if there are no values, you will get <code>null</code>'
              nullable: true
            product_rating:
              type: object
              oneOf:
                - $ref: '#/components/schemas/RatingElement'
              description: <em>product rating</em><br>the product popularity rate based on product reviews
              nullable: true
            shop_rating:
              type: object
              oneOf:
                - $ref: '#/components/schemas/RatingElement'
              description: <em>shop rating</em><br>the popularity rate of the seller based on user reviews
              nullable: true
            product_images:
              type: array
              items:
                type: string
                nullable: true
              description: <em>URLs to the images of the product</em><br>the first URL in the array is the featured image of the product
              nullable: true
            shop_ad_aclk:
              type: string
              description: <em>unique ad click referral parameter</em><br>using this parameter you can get a URL of the advertisement in <a href="/v3/merchant/google/sellers/ad_url/">Google Shopping Sellers Ad URL</a>
              nullable: true
            gid:
              type: string
              description: '<em>global product identifier on Google Shopping</em><br>note that there is no full list of possible values as the <code>gid</code> is a dynamic value assigned by Google<br>if there are no values, you will get <code>null</code><br>example:<br><code>4702526954592161872</code><br>learn more about <code>gid</code> parameter in <a href="https://dataforseo.com/help-center/whats-a-gid-in-google-shopping-api" target="_blank">this help center guide</a>'
              nullable: true
            delivery_info:
              type: object
              oneOf:
                - $ref: '#/components/schemas/DeliveryInfo'
              description: <em>delivery information</em><br>delivery information including free and fast delivery date ranges
              nullable: true
            stores_count_info:
              type: object
              oneOf:
                - $ref: '#/components/schemas/StoresCountInfo'
              description: <em>stores count information</em><br>contains information about the number of stores that offer the same product
              nullable: true
    GoogleShoppingPaidElementItem:
      type: object
      allOf:
        - type: object
          oneOf:
            - $ref: '#/components/schemas/BaseMerchantGoogleShoppingProductsElementItem'
          nullable: true
        - type: object
          properties:
            domain:
              type: string
              description: <em>domain of the URL</em><br>domain of the URL where a special offer is posted<br><strong>Note:</strong> this field is deprecated and will return <code>null</code>
              nullable: true
            title:
              type: string
              description: <em>product title</em>
              nullable: true
            description:
              type: string
              description: <em>description of the product in Google Shopping SERP</em>
              nullable: true
            url:
              type: string
              description: <em>URL pointing at special offer page</em><br>URL where a special offer is posted<br><strong>Note:</strong> this field is deprecated and will return <code>null</code>
              nullable: true
            shop_ad_aclk:
              type: string
              description: <em>unique ad click referral parameter</em><br>using this parameter you can get a URL of the advertisement in <a href="/v3/merchant/google/sellers/ad_url/">Google Shopping Sellers Ad URL</a>
              nullable: true
    SpecialOfferInfo:
      type: object
      properties:
        title:
          type: string
          description: <em>product title</em>
          nullable: true
        sub_title:
          type: string
          description: <em>subtitle of the special offer</em>
          nullable: true
        fixed_discount:
          type: number
          description: <em>amount of the fixed discount</em>
          format: int64
          nullable: true
        fixed_discount_currency:
          type: string
          description: <em>currency of the fixed discount</em>
          nullable: true
        percentage_discount:
          type: number
          description: <em>percentage of the discount</em>
          format: int64
          nullable: true
        coupon_code:
          type: string
          description: <em>code of coupon discount</em>
          nullable: true
        coupon_info:
          type: string
          description: <em>information on coupon discount</em>
          nullable: true
        url:
          type: string
          description: <em>URL to the product page on the seller's website</em><br><strong>Note:</strong> this field is deprecated and will return <code>null</code>
          nullable: true
        domain:
          type: string
          description: <em>domain in SERP</em>
          nullable: true
    GoogleShoppingSponsoredCarouselElement:
      type: object
      properties:
        type:
          type: string
          description: type of element
          nullable: true
        xpath:
          type: string
          description: <em><a href="https://en.wikipedia.org/wiki/XPath">XPath</a> of the element</em>
          nullable: true
        title:
          type: string
          description: <em>title of the element</em>
          nullable: true
        tags:
          type: array
          items:
            type: string
            nullable: true
          description: <em>tags assigned to the product</em>
          nullable: true
        seller:
          type: string
          description: <em>name of the seller</em><br>the name of the company that placed a corresponding product on Google Shopping
          nullable: true
        price:
          type: number
          description: <em>product price</em><br>example:<br><code>384.99</code>
          nullable: true
        currency:
          type: string
          description: <em>currency in the <a href="https://en.wikipedia.org/wiki/ISO_4217">ISO</a> format</em><br>example:<br><code>USD</code>
          nullable: true
        product_rating:
          type: object
          oneOf:
            - $ref: '#/components/schemas/RatingElement'
          description: <em>product rating</em><br>the product popularity rate based on product reviews
          nullable: true
        product_images:
          type: array
          items:
            type: string
            nullable: true
          description: <em>URLs to the images of the product</em><br>the first URL in the array is the featured image of the product
          nullable: true
        shop_ad_aclk:
          type: string
          description: <em>unique ad click referral parameter</em><br>using this parameter you can get a URL of the advertisement in <a href="/v3/merchant/google/sellers/ad_url/">Google Shopping Sellers Ad URL</a>
          nullable: true
        delivery_info:
          type: object
          oneOf:
            - $ref: '#/components/schemas/DeliveryInfo'
          description: <em>delivery information</em><br>delivery information including free and fast delivery date ranges
          nullable: true
        special_offer_info:
          type: object
          oneOf:
            - $ref: '#/components/schemas/SpecialOfferInfo'
          description: '<em>special offer from the seller</em><br>information on the special offer from the seller, including discount and coupon info'
          nullable: true
    GoogleShoppingSponsoredCarouselElementItem:
      type: object
      allOf:
        - type: object
          oneOf:
            - $ref: '#/components/schemas/BaseMerchantGoogleShoppingProductsElementItem'
          nullable: true
        - type: object
          properties:
            title:
              type: string
              description: <em>title of the special offer</em>
              nullable: true
            items:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/GoogleShoppingSponsoredCarouselElement'
                nullable: true
              description: <em>items in SERP</em>
              nullable: true
    GoogleShoppingCarouselElement:
      type: object
      properties:
        type:
          type: string
          description: type of element
          nullable: true
        xpath:
          type: string
          description: <em><a href="https://en.wikipedia.org/wiki/XPath">XPath</a> of the element</em>
          nullable: true
        title:
          type: string
          description: <em>product title</em>
          nullable: true
        tags:
          type: array
          items:
            type: string
            nullable: true
          description: <em>tags assigned to the product</em>
          nullable: true
        seller:
          type: string
          description: <em>name of the seller</em><br>the name of the company that placed a corresponding product on Google Shopping
          nullable: true
        price:
          type: number
          description: <em>product price</em><br>example:<br><code>384.99</code>
          nullable: true
        currency:
          type: string
          description: <em>currency in the <a href="https://en.wikipedia.org/wiki/ISO_4217">ISO</a> format</em><br>example:<br><code>USD</code>
          nullable: true
        product_rating:
          type: object
          oneOf:
            - $ref: '#/components/schemas/RatingElement'
          description: <em>product rating</em><br>the product popularity rate based on product reviews
          nullable: true
        product_images:
          type: array
          items:
            type: string
            nullable: true
          description: <em>URLs to the images of the product</em><br>the first URL in the array is the featured image of the product
          nullable: true
        shopping_url:
          type: string
          description: <em>URL to the product page on Google Shopping</em>
          nullable: true
        product_id:
          type: string
          description: '<em>unique product identifier on Google Shopping</em><br>note that there is no full list of possible values as the <code>product_id</code> is a dynamic value assigned by Google<br>if there are no values, you will get <code>null</code><br>example:<br><code>4485466949985702538</code><br>learn more about the parameter in <a href="https://dataforseo.com/help-center/product-id-google-shopping" rel="noopener noreferrer" target="_blank">this help center guide</a>'
          nullable: true
        data_docid:
          type: string
          description: <em>unique identifier of the SERP data element</em><br>note that there is no full list of possible values as the <code>data_docid</code> is a dynamic value assigned by Google<br>example:<br><code>17363035694596624076</code>
          nullable: true
        gid:
          type: string
          description: '<em>global product identifier on Google Shopping</em><br>note that there is no full list of possible values as the <code>gid</code> is a dynamic value assigned by Google<br>if there are no values, you will get <code>null</code><br>example:<br><code>4702526954592161872</code><br>learn more about <code>gid</code> parameter in <a href="https://dataforseo.com/help-center/whats-a-gid-in-google-shopping-api" target="_blank">this help center guide</a>'
          nullable: true
        delivery_info:
          type: object
          oneOf:
            - $ref: '#/components/schemas/DeliveryInfo'
          description: <em>delivery information</em><br>delivery information including free and fast delivery date ranges
          nullable: true
        special_offer_info:
          type: object
          oneOf:
            - $ref: '#/components/schemas/SpecialOfferInfo'
          description: '<em>special offer from the seller</em><br>information on the special offer from the seller, including discount and coupon info'
          nullable: true
    GoogleShoppingCarouselElementItem:
      type: object
      allOf:
        - type: object
          oneOf:
            - $ref: '#/components/schemas/BaseMerchantGoogleShoppingProductsElementItem'
          nullable: true
        - type: object
          properties:
            title:
              type: string
              description: <em>title of the special offer</em>
              nullable: true
            items:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/GoogleShoppingCarouselElement'
                nullable: true
              description: '<em>additional items present in the element</em><br>if there are none, equals <code>null</code>'
              nullable: true
    RelatedSearchesElementItem:
      type: object
      allOf:
        - type: object
          oneOf:
            - $ref: '#/components/schemas/BaseMerchantGoogleShoppingProductsElementItem'
          nullable: true
        - type: object
          properties:
            items:
              type: array
              items:
                type: string
                nullable: true
              description: '<em>additional items present in the element</em><br>if there are none, equals <code>null</code>'
              nullable: true
    MerchantGoogleProductsTaskGetAdvancedResultInfo:
      type: object
      properties:
        keyword:
          type: string
          description: <em>keyword received in a POST array</em><br><strong>keyword is returned with decoded %## (plus character '+' will be decoded to a space character)</strong>
          nullable: true
        type:
          type: string
          description: type of element
          nullable: true
        se_domain:
          type: string
          description: <em>search engine domain in a POST array</em>
          nullable: true
        location_code:
          type: integer
          description: <em>location code in a POST array</em>
          nullable: true
        language_code:
          type: string
          description: <em>language code in a POST array</em>
          nullable: true
        check_url:
          type: string
          description: <em>direct URL to Google Shopping results</em><br>you can use it to make sure that we provided accurate results
          nullable: true
        datetime:
          type: string
          description: '<em>date and time when the result was received</em><br>in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”<br>example:<br><code>2019-11-15 12:57:46 +00:00</code>'
          nullable: true
        spell:
          type: object
          oneOf:
            - $ref: '#/components/schemas/SpellInfo'
          description: '<em>autocorrection of the search engine</em><br>if the search engine provided results for a keyword that was corrected, we will specify the keyword corrected by the search engine and the type of autocorrection'
          nullable: true
        item_types:
          type: array
          items:
            type: string
            nullable: true
          description: '<em>types of search results found in Google Shopping SERP</em><br>contains types of all search results (<code>items</code>) found in the returned SERP<br>possible item types:<br><code>google_shopping_sponsored_carousel</code>, <code>google_shopping_paid</code>, <code>google_shopping_serp</code>, <code>google_shopping_carousel</code>, <code>related_searches</code>'
          nullable: true
        items_count:
          type: integer
          description: <em>the number of results returned in the <strong><code>items</code></strong> array</em>
          format: int64
          nullable: true
        items:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/BaseMerchantGoogleShoppingProductsElementItem'
            nullable: true
          description: '<em>additional items present in the element</em><br>contains a list of related keywords;<br>if there are none, equals <code>null</code>'
          nullable: true
    MerchantGoogleProductsTaskGetAdvancedTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/MerchantGoogleProductsTaskGetAdvancedResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    MerchantGoogleProductsTaskGetAdvancedResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/MerchantGoogleProductsTaskGetAdvancedTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    MerchantGoogleProductsTaskGetHtmlResultInfo:
      type: object
      properties:
        keyword:
          type: string
          description: <em>keyword received in a POST array<br></em><strong>keyword is returned with decoded %## (plus character '+' will be decoded to a space character)</strong>
          nullable: true
        type:
          type: string
          description: type of element
          nullable: true
        se_domain:
          type: string
          description: <em>search engine domain in a POST array</em>
          nullable: true
        location_code:
          type: integer
          description: <em>location code in a POST array</em>
          nullable: true
        language_code:
          type: string
          description: <em>language code in a POST array</em>
          nullable: true
        datetime:
          type: string
          description: '<em>date and time when the result was received</em><br>in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”<br>example:<br><code class="long-string">2019-11-15 12:57:46 +00:00</code>'
          nullable: true
        items_count:
          type: integer
          description: <em>the number of results returned in the <strong><code>items</code></strong> array</em>
          format: int64
          nullable: true
        items:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/HtmlItemInfo'
            nullable: true
          description: <em>elements of search results found on Google Shopping</em>
          nullable: true
    MerchantGoogleProductsTaskGetHtmlTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/MerchantGoogleProductsTaskGetHtmlResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    MerchantGoogleProductsTaskGetHtmlResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/MerchantGoogleProductsTaskGetHtmlTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    MerchantGoogleSellersTaskPostRequestInfo:
      type: object
      properties:
        product_id:
          type: string
          description: <em>unique product identifier on Google Shopping</em><br><strong>required field if <code>data_docid</code> or <code>gid</code> is not specified</strong><br>we recommend specifying <code>product_id</code> together with <code>data_docid</code> and <code>gid</code> for optimal results;<br>you can get this value for a certain product by making a separate request to <a href="/v3/merchant/google/products/task_post">the Google Shopping Products endpoint</a><br>example:<br><code>4485466949985702538</code><br>learn more about the parameter in <a href="https://dataforseo.com/help-center/product-id-google-shopping" rel="noopener noreferrer" target="_blank">this help center guide</a>
        data_docid:
          type: string
          description: <em>unique identifier of the SERP data element</em><br><strong>required field if <code>product_id</code> or <code>gid</code> is not specified</strong><br>we recommend specifying <code>data_docid</code> together with <code>product_id</code> and <code>gid</code> for optimal results;<br>you can get this value for a certain element by making a separate request to <a href="/v3/merchant/google/products/task_post">the Google Shopping Products endpoint</a><br>example:<br><code>13071766526042404278</code>
        gid:
          type: string
          description: <em>global product identifier on Google Shopping</em><br><strong>required field if <code>product_id</code> or <code>data_docid</code> is not specified</strong><br>we recommend specifying <code>gid</code> together with <code>product_id</code> and <code>data_docid</code> for optimal results;<br>you can get this value for a certain product by making a separate request to <a href="/v3/merchant/google/products/task_post">the Google Shopping Products endpoint</a><br>example:<br><code>4702526954592161872</code><br>learn more about the parameter in <a href="https://dataforseo.com/help-center/whats-a-gid-in-google-shopping-api" rel="noopener noreferrer" target="_blank">this help center guide</a>
        pvf:
          type: string
          description: '<em>product variant filter  on Google Shopping</em><br>optional field<br>parameter in Google Shopping URL, setting optional product variant filtration;<br>example:<br><code>Eg4iBWNvbG9yKgV3aGl0ZRISIgxwYWNrYWdlIHNpemUqAjE0EgoiBHNpemUqAnhs</code>'
          nullable: true
        priority:
          type: integer
          description: <em>task priority</em><br>optional field<br>can take the following values:<br>1 – normal execution priority (set by default)<br>2 – high execution priorityYou will be additionally charged for the tasks with high execution priority.<br>The cost can be calculated on the <a title="Pricing" href="https://dataforseo.com/pricing/merchant/google-shopping-api" target="_blank" rel="noopener noreferrer">Pricing</a> page.
          nullable: true
        location_name:
          type: string
          description: '<em>full name of the location</em><br><strong>required field if you don''t specify</strong> <code>location_code</code> or <code>location_coordinate</code><br><strong>if you use this field, you don''t need to specify <code>location_code</code> or <code>location_coordinate</code></strong><br>you can receive the list of available Google Shopping locations with their <code>location_name</code> by making a separate request to the <code>https://api.dataforseo.com/v3/merchant/google/locations</code><br>example:<br><code class="long-string">London,England,United Kingdom</code>'
        location_code:
          type: integer
          description: '<em>location code</em><br><strong>required field if you don''t specify</strong> <code>location_name</code>_or <code>location_coordinate</code><br><strong>if you use this field, you don''t need to specify <code>location_name</code> or <code>location_coordinate</code></strong><br>you can receive the list of available Google Shopping locations with their <code>location_code</code> by making a separate request to the <code>https://api.dataforseo.com/v3/merchant/google/locations</code><br>example:<br><code class="long-string">2840</code>'
        location_coordinate:
          type: string
          description: '<em>GPS coordinates of a location</em><br><strong>required field if you don''t specify</strong> <code>location_name</code>_or <code>location_code</code><br><strong>if you use this field, you don''t need to specify <code>location_name</code> or <code>location_code</code></strong><br><code>location_coordinate</code> parameter should be specified in the <em>"latitude,longitude,radius"</em> format<br>the maximum number of decimal digits for <em>"latitude"</em> and <em>"longitude"</em>: 7<br>the minimum value for <em>"radius"</em>: 199.9<br>example:<br><code class="long-string">53.476225,-2.243572,200</code>'
        language_name:
          type: string
          description: '<em>full name of the language</em><br><strong>required field if you don''t specify</strong> <code>language_code</code><br><strong>if you use this field, you don''t need to specify <code>language_code</code></strong><br>you can receive the list of available Google Shopping languages with their <code>language_name</code> by making a separate request to the <code>https://api.dataforseo.com/v3/merchant/google/languages</code><br>example:<br><code class="long-string">English</code>'
        language_code:
          type: string
          description: '<em>language code</em><br><strong>required field if you don''t specify</strong> <code>language_name</code><br><strong>if you use this field, you don''t need to specify <code>language_name</code></strong><br>you can receive the list of available Google Shopping languages with their <code>language_code</code>_by making a separate request to the <code>https://api.dataforseo.com/v3/merchant/google/languages</code><em><br></em>example:<em><br></em><code class="long-string">en</code>'
        depth:
          type: integer
          description: '<em>parsing depth</em><br>optional field<br>number of results to be retrieved from Google Shopping SERP<br>default value: <code>10</code><br>max value: <code>200</code><br><strong>your account will be billed per each SERP containing up to 10 results;</strong> <br>setting depth above 10 may result in additional charges <a href="https://dataforseo.com/help-center/how-many-results-scraped" rel="noopener noreferrer" target="_blank">if the search engine returns more than 10 results</a>;<br>the cost can be calculated on the <a title="Pricing" href="https://dataforseo.com/pricing/merchant/google-shopping-api" target="_blank" rel="noopener noreferrer">Pricing</a> page'
          nullable: true
        se_domain:
          type: string
          description: '<em>search engine domain</em><br>optional field<br>we choose the relevant search engine domain automatically according to the location and language you specify<br>however, you can set a custom search engine domain in this field<br>example:<br><em><code>google.co.uk</code></em>, <em><code>google.com.au</code></em>, <em><code>google.de</code></em>, etc.'
          nullable: true
        get_shops_on_google:
          type: boolean
          description: '<em>include "buy on Google" shops</em><br>optional field<br>if set to <code>true</code>, the response will contain the list of sellers that allow to purchase a given product directly on Google<br>Note: if set to <code>true</code>, the cost of a task will be doubled'
          nullable: true
        additional_specifications:
          type: object
          additionalProperties:
            type: string
            nullable: true
          description: '<em>object containing additional url parameters</em><br>you can get additional information about the product by using the <code>"additional_specifications</code> object, which you can get by making a separate request to the <a href="/v3/merchant/google/products/task_post">Google Shopping Products endpoint</a><br>example:<br><code>"additional_specifications": {<br>"eto": "16157121050167572763_0"<br>}</code>'
          nullable: true
        tag:
          type: string
          description: <em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response
          nullable: true
        postback_url:
          type: string
          description: '<em>URL for sending task results</em><br>optional field<br>once the task is completed, we will send a POST request with its results compressed in the <code>gzip</code> format to the <code>postback_url</code> you specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/postbackscript?id=$id</code><br><code>http://your-server.com/postbackscript?id=$id&amp;tag=$tag</code><br><strong>Note:</strong> special characters in <code>postback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href="https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api" target="_blank" rel="noopener noreferrer">Help Center</a>'
          nullable: true
        postback_data:
          type: string
          nullable: true
        pingback_url:
          type: string
          description: '<em>notification URL of a completed task</em><br>optional field<br>when a task is completed we will notify you by GET request sent to the URL you have specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/pingscript?id=$id</code><br><code>http://your-server.com/pingscript?id=$id&amp;tag=$tag</code><br><strong>Note:</strong> special characters in <code>pingback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href="https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api" target="_blank" rel="noopener noreferrer">Help Center</a>'
          nullable: true
      example:
        - language_code: en
          location_code: 2840
          product_id: '1113158713975221117'
    MerchantGoogleSellersTaskPostTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: object
              description: '<em>array of results</em><br>in this case, the value will be <code>null</code>'
              nullable: true
    MerchantGoogleSellersTaskPostResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/MerchantGoogleSellersTaskPostTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    MerchantGoogleSellersTasksReadyResultInfo:
      type: object
      properties:
        id:
          type: string
          description: <em>task identifier of the completed task</em><br><strong>unique task identifier in our system in the <a href="https://en.wikipedia.org/wiki/Universally_unique_identifier">UUID</a> format</strong>
          nullable: true
        se:
          type: string
          description: <em>search engine specified when setting the task</em>
          nullable: true
        se_type:
          type: string
          description: '<em>type of search engine</em><br>can take the following values: <code>shopping</code>'
          nullable: true
        date_posted:
          type: string
          description: <em>date when the task was posted (in the UTC format)</em>
          nullable: true
        tag:
          type: string
          description: <em>user-defined task identifier</em>
          nullable: true
        endpoint_advanced:
          type: string
          description: <em>URL for collecting the results of Google Shopping Sellers Advanced task</em>
          nullable: true
        endpoint_html:
          type: string
          description: <em>URL for collecting the results of Google Shopping Sellers HTML task</em>
          nullable: true
    MerchantGoogleSellersTasksReadyTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/MerchantGoogleSellersTasksReadyResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    MerchantGoogleSellersTasksReadyResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/MerchantGoogleSellersTasksReadyTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    GoogleShoppingSellersShopsListElementItem:
      type: object
      allOf:
        - type: object
          oneOf:
            - $ref: '#/components/schemas/BaseMerchantGoogleShoppingSellersElementItem'
          nullable: true
        - type: object
          properties:
            price_multiplier:
              type: integer
              description: <em>monthly price multiplier</em><br>indicates the number of months covered by the monthly payment for the product
              nullable: true
            displayed_payment_breakdown:
              type: string
              description: '<em>installment details as displayed in the results</em><br>shows how the product price can be broken down into monthly payments, if applicable'
              nullable: true
            rating:
              type: object
              oneOf:
                - $ref: '#/components/schemas/RatingElement'
              description: <em>shop rating</em><br>the shop popularity rate based on product reviews
              nullable: true
            product_condition:
              type: string
              description: '<em>indicated condition of the product</em><br>possible values: <code>Used</code>, <code>Refurbished</code>, <code>New</code>, <code>Pre-owned</code>, <code>null</code>'
              nullable: true
            product_annotation:
              type: string
              description: '<em>data from annotations and badges with special offers</em><br>if there is no annotation for this product, the value will be <code>null</code><br>examples: <code>LOW PRICE</code>, <code>SPECIAL OFFER</code>, <code>SALE</code>, <code>PRICE DROP</code>'
              nullable: true
            product_availability:
              type: string
              description: '<em>product availability information</em><br>product availability information<br>can take the following values: <code>in_stock</code>, <code>limited_stock</code>, <code>out_of_stock</code>, <code>backordered</code>, <code>pre_order_available</code>, <code>on_display_to_order</code>'
              nullable: true
    GoogleShoppingSellersBuyOnGoogleElementItem:
      type: object
      allOf:
        - type: object
          oneOf:
            - $ref: '#/components/schemas/BaseMerchantGoogleShoppingSellersElementItem'
          nullable: true
        - type: object
          properties:
            rating:
              type: object
              oneOf:
                - $ref: '#/components/schemas/RatingInfo'
              description: <em>shop rating</em><br>the shop popularity rate based on product reviews
              nullable: true
    MerchantGoogleSellersTaskGetAdvancedResultInfo:
      type: object
      properties:
        product_id:
          type: string
          description: <em><code>product_id</code> received in a POST array</em><br>learn more about the parameter in <a href="https://dataforseo.com/help-center/product-id-google-shopping" rel="noopener noreferrer" target="_blank">this help center guide</a>
          nullable: true
        type:
          type: string
          description: type of element
          nullable: true
        se_domain:
          type: string
          description: <em>search engine domain in a POST array</em>
          nullable: true
        location_code:
          type: integer
          description: <em>location code in a POST array</em>
          nullable: true
        language_code:
          type: string
          description: <em>language code in a POST array</em>
          nullable: true
        check_url:
          type: string
          description: <em>direct URL to Google Shopping results</em><br>you can use it to make sure that we provided accurate results
          nullable: true
        datetime:
          type: string
          description: '<em>date and time when the result was received</em><br>in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”<br>example:<br><code class="long-string">2019-11-15 12:57:46 +00:00</code>'
          nullable: true
        title:
          type: string
          description: <em>title of the product</em>
          nullable: true
        url:
          type: string
          description: <em>URL to the product page</em>
          nullable: true
        image_url:
          type: string
          description: <em>URL to the product image</em>
          nullable: true
        rating:
          type: object
          oneOf:
            - $ref: '#/components/schemas/RatingInfo'
          description: <em>product rating</em><br>the product popularity rate based on product reviews
          nullable: true
        item_types:
          type: array
          items:
            type: string
            nullable: true
          description: '<em>types of search results found in Google Shopping SERP</em><br>contains types of all search results (<code>items</code>) found in the returned SERP<br>possible item types:<br><code>shops_list</code>, <code>buy_on_google</code>'
          nullable: true
        items_count:
          type: integer
          description: <em>the number of results returned in the <strong><code>items</code></strong> array</em>
          format: int64
          nullable: true
        items:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/BaseMerchantGoogleShoppingSellersElementItem'
            nullable: true
          description: <em>items in SERP</em>
          nullable: true
    MerchantGoogleSellersTaskGetAdvancedTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/MerchantGoogleSellersTaskGetAdvancedResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    MerchantGoogleSellersTaskGetAdvancedResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/MerchantGoogleSellersTaskGetAdvancedTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    MerchantGoogleProductInfoTaskPostRequestInfo:
      type: object
      properties:
        product_id:
          type: string
          description: <em>unique product identifier on Google Shopping</em><br><strong>required field if <code>data_docid</code> or <code>gid</code> is not specified</strong><br>we recommend specifying <code>product_id</code> together with <code>data_docid</code> and <code>gid</code> for optimal results;<br>you can get this value for a certain product by making a separate request to <a href="/v3/merchant/google/products/task_post">the Google Shopping Products endpoint</a><br>example:<br><code>4485466949985702538</code><br>learn more about the parameter in <a href="https://dataforseo.com/help-center/product-id-google-shopping" rel="noopener noreferrer" target="_blank">this help center guide</a>
        data_docid:
          type: string
          description: <em>unique identifier of the SERP data element</em><br><strong>required field if <code>product_id</code> or <code>gid</code> is not specified</strong><br>we recommend specifying <code>data_docid</code> together with <code>product_id</code> and <code>gid</code> for optimal results;<br>you can get this value for a certain element by making a separate request to <a href="/v3/merchant/google/products/task_post">the Google Shopping Products endpoint</a><br>example:<br><code>13071766526042404278</code>
        gid:
          type: string
          description: <em>global product identifier on Google Shopping</em><br><strong>required field if <code>product_id</code> or <code>data_docid</code> is not specified</strong><br>we recommend specifying <code>gid</code> together with <code>product_id</code> and <code>data_docid</code> for optimal results;<br>you can get this value for a certain product by making a separate request to <a href="/v3/merchant/google/products/task_post">the Google Shopping Products endpoint</a><br>example:<br><code>4702526954592161872</code><br>learn more about the parameter in <a href="https://dataforseo.com/help-center/whats-a-gid-in-google-shopping-api" rel="noopener noreferrer" target="_blank">this help center guide</a>
        priority:
          type: integer
          description: <em>task priority</em><br>optional field<br>can take the following values:<br>1 – normal execution priority (set by default)<br>2 – high execution priorityYou will be additionally charged for the tasks with high execution priority.<br>The cost can be calculated on the <a title="Pricing" href="https://dataforseo.com/pricing/merchant/google-shopping-api" target="_blank" rel="noopener noreferrer">Pricing</a> page.
          nullable: true
        location_name:
          type: string
          description: '<em>full name of the location</em><br><strong>required field if you don''t specify</strong> <code>location_code</code> or <code>location_coordinate</code><br><strong>if you use this field, you don''t need to specify <code>location_code</code> or <code>location_coordinate</code></strong><br>you can receive the list of available Google Shopping locations with their <code>location_name</code> by making a separate request to the <code>https://api.dataforseo.com/v3/merchant/google/locations</code><br>example:<br><code class="long-string">London,England,United Kingdom</code>'
        location_code:
          type: integer
          description: '<em>location code</em><br><strong>required field if you don''t specify</strong> <code>location_name</code>_or <code>location_coordinate</code><br><strong>if you use this field, you don''t need to specify <code>location_name</code> or <code>location_coordinate</code></strong><br>you can receive the list of available Google Shopping locations with their <code>location_code</code> by making a separate request to the <code>https://api.dataforseo.com/v3/merchant/google/locations</code><br>example:<br><code class="long-string">2840</code>'
        location_coordinate:
          type: string
          description: '<em>GPS coordinates of a location</em><br><strong>required field if you don''t specify</strong> <code>location_name</code>_or <code>location_code</code><br><strong>if you use this field, you don''t need to specify <code>location_name</code> or <code>location_code</code></strong><br><code>location_coordinate</code> parameter should be specified in the <em>"latitude,longitude,radius"</em> format<br>the maximum number of decimal digits for <em>"latitude"</em> and <em>"longitude"</em>: 7<br>the minimum value for <em>"radius"</em>: 199.9<br>example:<br><code class="long-string">53.476225,-2.243572,200</code>'
        language_name:
          type: string
          description: '<em>full name of the language</em><br><strong>required field if you don''t specify</strong> <code>language_code</code><br><strong>if you use this field, you don''t need to specify <code>language_code</code></strong><br>you can receive the list of available Google Shopping languages with their <code>language_name</code> by making a separate request to the <code>https://api.dataforseo.com/v3/merchant/google/languages</code><br>example:<br><code class="long-string">English</code>'
        language_code:
          type: string
          description: '<em>language code</em><br><strong>required field if you don''t specify</strong> <code>language_name</code><br><strong>if you use this field, you don''t need to specify <code>language_name</code></strong><br>you can receive the list of available Google Shopping languages with their <code>language_code</code>_by making a separate request to the <code>https://api.dataforseo.com/v3/merchant/google/languages</code><em><br></em>example:<em><br></em><code class="long-string">en</code>'
        se_domain:
          type: string
          description: '<em>search engine domain</em><br>optional field<br>we choose the relevant search engine domain automatically according to the location and language you specify<br>however, you can set a custom search engine domain in this field<br>example:<br><code><em>google.co.uk</code>, <code>google.com.au</code>, <code>google.de</code>, etc.'
          nullable: true
        tag:
          type: string
          description: <em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response
          nullable: true
        postback_url:
          type: string
          description: '<em>URL for sending task results</em><br>optional field<br>once the task is completed, we will send a POST request with its results compressed in the <code>gzip</code> format to the <code>postback_url</code> you specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/postbackscript?id=$id</code><br><code>http://your-server.com/postbackscript?id=$id&amp;tag=$tag</code><br><strong>Note:</strong> special characters in <code>postback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href="https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api" target="_blank" rel="noopener noreferrer">Help Center</a>'
          nullable: true
        postback_data:
          type: string
          description: <em>postback_url datatype</em><br>optional field<br>corresponds to the datatype that will be sent to your server<br>possible values:<br><code>advanced</code>
          nullable: true
        pingback_url:
          type: string
          description: '<em>notification URL of a completed task</em><br>optional field<br>when a task is completed we will notify you by GET request sent to the URL you have specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/pingscript?id=$id</code><br><code>http://your-server.com/pingscript?id=$id&amp;tag=$tag</code><br><strong>Note:</strong> special characters in <code>pingback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href="https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api" target="_blank" rel="noopener noreferrer">Help Center</a>'
          nullable: true
      example:
        - language_code: en
          location_code: 2840
          product_id: '1113158713975221117'
    MerchantGoogleProductInfoTaskPostTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: object
              description: '<em>array of results</em><br>in this case, the value will be <code>null</code>'
              nullable: true
    MerchantGoogleProductInfoTaskPostResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/MerchantGoogleProductInfoTaskPostTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    MerchantGoogleProductInfoTasksReadyResultInfo:
      type: object
      properties:
        id:
          type: string
          description: <em>task identifier of the completed task</em><br><strong>unique task identifier in our system in the <a href="https://en.wikipedia.org/wiki/Universally_unique_identifier">UUID</a> format</strong>
          nullable: true
        se:
          type: string
          description: <em>search engine specified when setting the task</em>
          nullable: true
        se_type:
          type: string
          description: '<em>type of search engine</em><br>can take the following values: <code>shopping_specifications</code>'
          nullable: true
        date_posted:
          type: string
          description: <em>date when the task was posted (in the UTC format)</em>
          nullable: true
        tag:
          type: string
          nullable: true
        endpoint_advanced:
          type: string
          description: <em>URL for collecting the results of the Google Shopping Product Specifications Advanced task</em>
          nullable: true
        endpoint_html:
          type: string
          description: '<em>URL for collecting the results of the Google Shopping Product Specifications HTML task</em><br><strong>note:</strong> HTML is not available for this endpoint, the value will be <code>null</code>'
          nullable: true
    MerchantGoogleProductInfoTasksReadyTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/MerchantGoogleProductInfoTasksReadyResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    MerchantGoogleProductInfoTasksReadyResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/MerchantGoogleProductInfoTasksReadyTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    ShoppingSpecification:
      type: object
      properties:
        type:
          type: string
          description: type of element
          nullable: true
        block_name:
          type: string
          description: <em>name of the block of product attributes</em><br>indicates the name of the product specification section in which the related element is listed
          nullable: true
        specification_name:
          type: string
          description: <em>product attribute</em><br>attribute name of the <a href="https://support.google.com/merchants/answer/7052112?hl=en" target="_blank" rel="noopener noreferrer">product data specification</a>
          nullable: true
        specification_value:
          type: string
          description: <em>content of the specification</em>
          nullable: true
    ProductSeller:
      type: object
      properties:
        type:
          type: string
          description: type of element
          nullable: true
        title:
          type: string
          description: <em>product title</em>
          nullable: true
        url:
          type: string
          description: <em>seller url</em><br>url of the page where the product is sold
          nullable: true
        seller_rating:
          type: object
          oneOf:
            - $ref: '#/components/schemas/RatingElement'
          description: <em>rating of the seller</em>
          nullable: true
        seller_review_count:
          type: integer
          description: "number of seller reviews\nnumber of reviews on the product seller’s account"
          nullable: true
        price:
          type: object
          oneOf:
            - $ref: '#/components/schemas/PriceInfo'
          description: <em>product price</em><br>product price details on the seller's website
          nullable: true
        delivery_info:
          type: object
          oneOf:
            - $ref: '#/components/schemas/DeliveryInfo'
          description: <em>delivery information</em><br>product delivery information
          nullable: true
        product_availability:
          type: string
          description: '<em>product availability information</em><br>can take the following values: <code>in_stock</code>, <code>limited_stock</code>, <code>out_of_stock</code>, <code>backordered</code>, <code>pre_order_available</code>, <code>on_display_to_order</code>'
          nullable: true
    ProductVariation:
      type: object
      properties:
        type:
          type: string
          description: type of element
          nullable: true
        product_id:
          type: string
          description: <em>product ID in a POST array</em><br>learn more about the parameter in <a href="https://dataforseo.com/help-center/product-id-google-shopping" rel="noopener noreferrer" target="_blank">this help center guide</a>
          nullable: true
        gid:
          type: string
          description: <em>GID ID in a POST array</em><br>learn more about the parameter in <a href="https://dataforseo.com/help-center/whats-a-gid-in-google-shopping-api" rel="noopener noreferrer" target="_blank">this help center guide</a>
          nullable: true
        data_docid:
          type: string
          description: <em>unique identifier of the SERP data element in the POST array</em>
          nullable: true
        pvf:
          type: string
          description: <em>product variation filter</em><br>used in the product variation URL as the identifier of the specific product variation
          nullable: true
        title:
          type: string
          description: <em>name of the product seller</em>
          nullable: true
        url:
          type: string
          description: <em>product variation URL on Google Shopping</em>
          nullable: true
        variation_category:
          type: string
          description: '<em>category of the product variation</em><br>example: <code>"Storage Capacity"</code>'
          nullable: true
    ProductInfoElement:
      type: object
      properties:
        type:
          type: string
          description: type of element
          nullable: true
        rank_group:
          type: integer
          description: <em>position within a group of elements with identical <code>type</code> values</em><br>positions of elements with different <code>type</code> values are omitted from <code>rank_group</code>
          nullable: true
        rank_absolute:
          type: integer
          description: <em>absolute rank on the product specification page</em><br>absolute position among all the elements found on the product specification page
          nullable: true
        position:
          type: string
          description: '<em>alignment of the element on the product specification page</em><br>can take the following values:<br><code>right</code>, <code>left</code>'
          nullable: true
        product_id:
          type: string
          description: <em>product_id received in a POST array</em><br>ilearn more about the parameter in <a href="https://dataforseo.com/help-center/product-id-google-shopping" rel="noopener noreferrer" target="_blank">this help center guide</a>
          nullable: true
        title:
          type: string
          description: <em>title of the product</em>
          nullable: true
        description:
          type: string
          description: <em>description of the product</em>
          nullable: true
        url:
          type: string
          description: <em>product url</em><br>url of the product on Google Shopping
          nullable: true
        images:
          type: array
          items:
            type: string
            nullable: true
          description: <em>product images</em><br>contains urls to product images
          nullable: true
        features:
          type: array
          items:
            type: string
            nullable: true
          description: <em>product features</em><br>contains snippets with the description of product features
          nullable: true
        rating:
          type: object
          oneOf:
            - $ref: '#/components/schemas/RatingElement'
          description: <em>product rating </em><br>the popularity rate based on reviews
          nullable: true
        seller_reviews_count:
          type: integer
          description: <em>number of seller reviews</em><br>number of reviews on the product seller's account
          format: int64
          nullable: true
        data_docid:
          type: string
          description: <em>unique identifier of the SERP data element</em><br>note that there is no full list of possible values as the <code>data_docid</code> is a dynamic value assigned by Google<br>example:<br><code>17363035694596624076</code>
          nullable: true
        gid:
          type: string
          description: '<em>global product identifier on Google Shopping</em><br>note that there is no full list of possible values as the gid is a dynamic value assigned by Google<br>if there are no values, you will get <code>null</code><br>example:<br><code>4702526954592161872</code><br>learn more about <code>gid</code> in <a href="https://dataforseo.com/help-center/whats-a-gid-in-google-shopping-api" target="_blank">this help center guide</a>'
          nullable: true
        specifications:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/ShoppingSpecification'
            nullable: true
          description: <em>product specifications</em><br>contains all product attributes and related data listed on the product specification page
          nullable: true
        sellers:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/ProductSeller'
            nullable: true
          description: <em>sellers of the product</em><br>number of reviews on the product seller's account
          nullable: true
        variations:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/ProductVariation'
            nullable: true
          description: <em>variations of the product</em><br>contains brief information about different product variations
          nullable: true
    MerchantGoogleProductInfoTaskGetAdvancedResultInfo:
      type: object
      properties:
        product_id:
          type: string
          description: <em>product ID in a POST array</em><br>learn more about the parameter in <a href="https://dataforseo.com/help-center/product-id-google-shopping" rel="noopener noreferrer" target="_blank">this help center guide</a>
          nullable: true
        type:
          type: string
          description: type of element
          nullable: true
        se_domain:
          type: string
          description: <em>search engine domain in a POST array</em>
          nullable: true
        location_code:
          type: integer
          description: <em>location code in a POST array</em>
          nullable: true
        language_code:
          type: string
          description: <em>language code in a POST array</em>
          nullable: true
        check_url:
          type: string
          description: <em>direct URL to search engine results</em><br>you can use it to make sure that we provided accurate results
          nullable: true
        datetime:
          type: string
          description: '<em>date and time when the result was received</em><br>in the format: “year-month-date:minutes:UTC_difference_hours:UTC_difference_minutes”<br>example:<br><code class="long-string">2019-11-15 12:57:46 +00:00</code>'
          nullable: true
        item_types:
          type: array
          items:
            type: string
            nullable: true
          description: <em>types of items found on the product specification page</em><br>possible item types:<br><code>product_info_element</code>
          nullable: true
        items_count:
          type: integer
          description: <em>the number of results returned in the <strong><code>items</code></strong> array</em>
          format: int64
          nullable: true
        items:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/ProductInfoElement'
            nullable: true
          description: <em>items on the product page</em><br>contains all product attributes and related data listed on the product page
          nullable: true
    MerchantGoogleProductInfoTaskGetAdvancedTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/MerchantGoogleProductInfoTaskGetAdvancedResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    MerchantGoogleProductInfoTaskGetAdvancedResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/MerchantGoogleProductInfoTaskGetAdvancedTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    MerchantGoogleSellersAdUrlResultInfo:
      type: object
      properties:
        ad_aclk:
          type: string
          description: <em>unique ad click referral parameter</em>
          nullable: true
        ad_url:
          type: string
          description: <em>full URL of the advertisement</em>
          nullable: true
        ad_url_redirects:
          type: array
          items:
            type: string
            nullable: true
          description: <em>URLs where the link from Google Shopping redirects before reaching a final URL</em><br>includes up to 10 URLs of the ad's redirect path to the seller's <code>ad_url</code>
          nullable: true
    MerchantGoogleSellersAdUrlTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/MerchantGoogleSellersAdUrlResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    MerchantGoogleSellersAdUrlResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/MerchantGoogleSellersAdUrlTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    MerchantAmazonLocationsResultInfo:
      type: object
      properties:
        location_code:
          type: integer
          description: <em>location code</em>
          nullable: true
        location_name:
          type: string
          description: <em>full name of the location</em>
          nullable: true
        location_name_parent:
          type: string
          description: '<em>the name of the superordinate location</em><br>example:<br><code>"location_code": 9041134,<br>"location_name": "90290,California,United States",<br>"location_name_parent": "California,United States"</code>'
          nullable: true
        country_iso_code:
          type: string
          description: <em>ISO country code of the location</em>
          nullable: true
        location_type:
          type: string
          description: <em>location type</em>
          nullable: true
    MerchantAmazonLocationsTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/MerchantAmazonLocationsResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    MerchantAmazonLocationsResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/MerchantAmazonLocationsTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    MerchantAmazonLocationsCountryResultInfo:
      type: object
      properties:
        location_code:
          type: integer
          description: <em>location code</em>
          nullable: true
        location_name:
          type: string
          description: <em>full name of the location</em>
          nullable: true
        location_name_parent:
          type: string
          description: '<em>the name of the superordinate location</em><br>example:<br><code>"location_code": 9041134,<br>"location_name": "90290,California,United States",<br>"location_name_parent": "California,United States"</code>'
          nullable: true
        country_iso_code:
          type: string
          description: <em>ISO country code of the location</em>
          nullable: true
        location_type:
          type: string
          description: <em>location type</em>
          nullable: true
    MerchantAmazonLocationsCountryTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/MerchantAmazonLocationsCountryResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    MerchantAmazonLocationsCountryResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/MerchantAmazonLocationsCountryTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    MerchantAmazonLanguagesResultInfo:
      type: object
      properties:
        language_name:
          type: string
          description: <em>language name</em>
          nullable: true
        language_code:
          type: string
          description: <em>language code according to <a href="https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes" target="_blank" rel="noopener noreferrer">ISO 639-1</a></em>
          nullable: true
    MerchantAmazonLanguagesTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/MerchantAmazonLanguagesResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    MerchantAmazonLanguagesResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/MerchantAmazonLanguagesTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    MerchantAmazonProductsTaskPostRequestInfo:
      type: object
      properties:
        keyword:
          type: string
          description: '<em>keyword</em><br><strong>required field</strong><br>you can specify <strong>up to 700 characters</strong> in this field<br><strong>all %## will be decoded (plus character ‘+’ will be decoded to a space character)</strong><br>if you need to use the “%” character for your <code>keyword</code>, please specify it as “%25”;<p>learn more about rules and limitations of <code>keyword</code> and <code>keywords</code> fields in DataForSEO APIs in this <a href="https://dataforseo.com/help-center/rules-and-limitations-of-keyword-and-keywords-fields-in-dataforseo-apis" rel="noopener noreferrer" target="_blank">Help Center article</a>'
        url:
          type: string
          description: '<em>direct URL of the search query</em><br>optional field<br>you can specify a direct URL and we will sort it out to the necessary fields. Note that this method is the most difficult for our API to process and also requires you to specify the exact language and location in the URL. In most cases, we wouldn’t recommend using this method.<br>example:<br><code class="long-string">https://www.amazon.com/s/?field-keywords=shoes&amp;language=en_US</code>'
          nullable: true
        priority:
          type: integer
          description: <em>task priority</em><br>optional field<br>can take the following values:<br>1 – normal execution priority (set by default)<br>2 – high execution priorityYou will be additionally charged for the tasks with high execution priority.<br>The cost can be calculated on the <a title="Pricing" href="https://dataforseo.com/pricing/merchant/amazon-api" target="_blank" rel="noopener noreferrer">Pricing</a> page.
          nullable: true
        location_name:
          type: string
          description: '<em>full name of search engine location</em><br><strong>required field if you don''t specify</strong> <code>location_code</code> or <code>location_coordinate</code><br><strong>if you use this field, you don''t need to specify <code>location_code</code> or <code>location_coordinate</code></strong><br>you can receive the list of available locations with their <code>location_name</code> parameters by making a separate request to the <code>https://api.dataforseo.com/v3/merchant/amazon/locations</code><br>example:<br><code class="long-string">HA1,England,United Kingdom</code>'
        location_code:
          type: integer
          description: '<em>search engine location code</em><br><strong>required field if you don''t specify</strong> <code>location_name</code>_or <code>location_coordinate</code><br><strong>if you use this field, you don''t need to specify <code>location_name</code> or <code>location_coordinate</code></strong><br>you can receive the list of available locations with their <code>location_code</code> parameters by making a separate request to the<br><code>https://api.dataforseo.com/v3/merchant/amazon/locations</code><br>example:<br><code class="long-string">9045969</code>'
        location_coordinate:
          type: string
          description: '<em>GPS coordinates of a location</em><br><strong>required field if you don''t specify</strong> <code>location_name</code>_or <code>location_code</code><br><strong>if you use this field, you don''t need to specify <code>location_name</code> or <code>location_code</code></strong><br><code>location_coordinate</code> parameter should be specified in the <em>"latitude,longitude,radius"</em> format<br>the maximum number of decimal digits for <em>"latitude"</em> and <em>"longitude"</em>: 7<br>the minimum value for <em>"radius"</em>: 199.9<br>example:<br><code class="long-string">53.476225,-2.243572,200</code>'
        language_name:
          type: string
          description: '<em>full name of search engine language</em><br><strong>required field if you don''t specify</strong> <code>language_code</code><br><strong>if you use this field, you don''t need to specify <code>language_code</code></strong><br>you can receive the list of available languages with their <code>language_name</code> parameters by making a separate request to the<br><code>https://api.dataforseo.com/v3/merchant/amazon/languages</code><br>example:<br><code class="long-string">English (United Kingdom)</code>'
        language_code:
          type: string
          description: '<em>search engine language code</em><br><strong>required field if you don''t specify</strong> <code>language_name</code><br><strong>if you use this field, you don''t need to specify <code>language_name</code></strong><br>you can receive the list of available languages with their <code>language_code</code>_parameters by making a separate request to the <code>https://api.dataforseo.com/v3/merchant/amazon/languages</code><em><br></em>example:<em><br></em><code class="long-string">en_GB</code>'
        se_domain:
          type: string
          description: '<em>search engine domain</em><br>optional field<br>we choose the relevant search engine domain automatically according to the location and language you specify<br>however, you can set a custom search engine domain in this field<br>example:<br><code><em>amazon.com</em></code>, <code><em>amazon.co.uk</em></code>, <code><em>amazon.fr</em></code>, etc.'
          nullable: true
        depth:
          type: integer
          description: '<em>parsing depth</em><br>optional field<br>number of results to be retrieved from the Amazon results page<br>default value: <code>100</code><br>max value: <code>700</code><br><strong>Your account will be billed per each SERP containing up to 100 results;</strong> <br>Setting depth above 100 may result in additional charges if the search engine returns more than 100 results</a>;<br>The cost can be calculated on the <a title="Pricing" href="https://dataforseo.com/pricing/merchant/amazon-api" target="_blank" rel="noopener noreferrer">Pricing</a> page.'
          nullable: true
        max_crawl_pages:
          type: integer
          description: '<em>page crawl limit</em><br>optional field<br>number of search results pages to crawl<br>max value: <code>7</code><br><strong>Note:</strong> the <code>max_crawl_pages</code> and <code>depth</code> parameters complement each other;<br>learn more at <a href="https://dataforseo.com/help-center/what-is-max-crawl-pages-and-how-does-it-work" rel="noopener noreferrer" target="_blank">our help center</a>'
          nullable: true
        department:
          type: string
          description: '<em>amazon product department</em><br>optional field<br>specify one of the following amazon departments for extracting product listings:<br><code>"Arts & Crafts"</code>, <code>"Automotive"</code>, <code>"Baby"</code>, <code>"Beauty & Personal Care"</code>, <code>"Books"</code>, <code>"Computers"</code>, <code>"Digital Music"</code>, <code>"Electronics"</code>, <code>"Kindle Store"</code>, <code>"Prime Video"</code>, <code>"Women''s Fashion"</code>, <code>"Men''s Fashion"</code>, <code>"Girls'' Fashion"</code>, <code>"Boys'' Fashion"</code>, <code>"Deals"</code>, <code>"Health & Household"</code>, <code>"Home & Kitchen"</code>, <code>"Industrial & Scientific"</code>, <code>"Luggage"</code>, <code>"Movies & TV"</code>, <code>"Music, CDs & Vinyl"</code>, <code>"Pet Supplies"</code>, <code>"Software"</code>, <code>"Sports & Outdoors"</code>, <code>"Tools & Home Improvement"</code>, <code>"Toys & Games"</code>, <code>"Video Games"</code>'
          nullable: true
        search_param:
          type: string
          description: '<em>additional parameters of the search query</em><br>optional field<br>you can use the following Amazon search URL parameters for customizing the search<br>example:<br><code>&low-price=52</code> - search for products that cost <em>more than 52 USD</em>;<br><code>&high-price=45</code> - search for products that cost <em>less than 45 USD</em>;<br><code>&sort=relevancerank</code> - sort results by <em>relevance</em>;<br><code>&sort=featured-rank</code> - sort results by <em>featured</em> products;<br><code>&sort=price-asc-rank</code> - sort by <em>ascending price</em>;<br><code>&sort=price-desc-rank</code> - sort by <em>descending price</em>;<br><code>&sort=review-rank</code> - sort by the average <em>customer reviews</em> value;<br><code>&sort=date-desc-rank</code> - sort by the <em>newest arrival</em><br><strong>Note</strong> that <code>search_param</code> values will be ignored if any of the following parameters is used: <code>price_min</code>, <code>price_max</code>, <code>sort_by</code>'
          nullable: true
        price_min:
          type: integer
          description: '<em>minimum product price</em><br>optional field<br>minimum price of the returned products listed on Amazon for the specified query<br>example:<br><code>5</code><br><strong>Note:</strong> if you specify <code>price_min</code>, the <code>search_param</code> parameter will be ignored'
          nullable: true
        price_max:
          type: integer
          description: '<em>maximum product price</em><br>optional field<br>maximum price of the returned products listed on Amazon for the specified query<br>example:<br><code>100</code><br><strong>Note:</strong> if you specify <code>price_max</code>, the <code>search_param</code> parameter will be ignored'
          nullable: true
        sort_by:
          type: string
          description: '<em>results sorting rules</em><br>optional field<br>the following sorting rules are supported:<br><code>relevance</code>, <code>price_low_to_high</code>, <code>price_high_to_low</code>, <code>featured</code>, <code>avg_customer_review</code>, <code>newest_arrival</code><br>example:<br><code>sort_by:"relevance"</code><br><strong>Note:</strong> if you specify <code>sort_by</code>, the <code>search_param</code> parameter will be ignored'
          nullable: true
        tag:
          type: string
          description: <em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response
          nullable: true
        postback_url:
          type: string
          description: '<em>URL for sending task results</em><br>optional field<br>once the task is completed, we will send a POST request with its results compressed in the <code>gzip</code> format to the <code>postback_url</code> you specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/postbackscript?id=$id</code><br><code>http://your-server.com/postbackscript?id=$id&amp;tag=$tag</code><br><strong>Note:</strong> special characters in <code>postback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href="https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api" target="_blank" rel="noopener noreferrer">Help Center</a>'
          nullable: true
        postback_data:
          type: string
          description: '<em>postback_url datatype</em><br><strong>required field if you specify <code>postback_url</code></strong><br>corresponds to the datatype that will be sent to your server<br>possible values:<br><code>advanced</code>, <code>html</code>'
        pingback_url:
          type: string
          description: '<em>notification URL of a completed task</em><br>optional field<br>when a task is completed we will notify you by GET request sent to the URL you have specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/pingscript?id=$id</code><br><code>http://your-server.com/pingscript?id=$id&amp;tag=$tag</code><br><strong>Note:</strong> special characters in <code>pingback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href="https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api" target="_blank" rel="noopener noreferrer">Help Center</a>'
          nullable: true
      example:
        - language_code: en_US
          location_code: 2840
          keyword: shoes
    MerchantAmazonProductsTaskPostTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: object
              description: '<em>array of results</em><br>in this case, the value will be <code>null</code>'
              nullable: true
    MerchantAmazonProductsTaskPostResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/MerchantAmazonProductsTaskPostTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    MerchantAmazonProductsTasksReadyResultInfo:
      type: object
      properties:
        id:
          type: string
          description: <em>task identifier of the completed task</em><br><strong>unique task identifier in our system in the <a href="https://en.wikipedia.org/wiki/Universally_unique_identifier">UUID</a> format</strong>
          nullable: true
        se:
          type: string
          description: <em>search engine specified when setting the task</em>
          nullable: true
        se_type:
          type: string
          description: '<em>type of search engine</em><br>can take the following values: <code>organic</code>'
          nullable: true
        date_posted:
          type: string
          description: <em>date when the task was posted (in the UTC format)</em>
          nullable: true
        tag:
          type: string
          description: <em>user-defined task identifier</em>
          nullable: true
        endpoint_advanced:
          type: string
          description: <em>URL for collecting the results of the Amazon Products Advanced task</em>
          nullable: true
        endpoint_html:
          type: string
          description: <em>URL for collecting the results of the Amazon Products HTML task</em>
          nullable: true
    MerchantAmazonProductsTasksReadyTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/MerchantAmazonProductsTasksReadyResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    MerchantAmazonProductsTasksReadyResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/MerchantAmazonProductsTasksReadyTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    MerchantAmazonPaidSerpElementItem:
      type: object
      allOf:
        - type: object
          oneOf:
            - $ref: '#/components/schemas/BaseMerchantAmazonElementItem'
          nullable: true
        - type: object
          properties:
            domain:
              type: string
              description: <em>Amazon domain</em>
              nullable: true
            title:
              type: string
              description: <em>product title</em>
              nullable: true
            url:
              type: string
              description: <em>the URL of the product page</em>
              nullable: true
            image_url:
              type: string
              description: <em>URL of the product image featured in the results</em>
              nullable: true
            bought_past_month:
              type: integer
              description: <em>number of product purchases in the past month</em>
              nullable: true
            price_from:
              type: number
              description: <em>the regular price of a product</em><br>example:<br><code>49.98</code>
              nullable: true
            price_to:
              type: number
              description: <em>the upper limit of the product price range</em><br>example:<br><code>384.99</code>
              nullable: true
            currency:
              type: string
              description: <em>currency in the <a href="https://en.wikipedia.org/wiki/ISO_4217">ISO</a> format</em><br>example:<br><code>USD</code>
              nullable: true
            special_offers:
              type: array
              items:
                type: string
                nullable: true
              description: '<em>special offer details</em><br>contains special offer details, including coupon and Subscribe & Save discounts'
              nullable: true
            data_asin:
              type: string
              description: <em>unique product identifier on Amazon</em><br>note that there is no full list of possible values as the <code>data_asin</code> is a dynamic value assigned by Amazon<br>example:<br><code>B07G82D89J</code>
              nullable: true
            rating:
              type: object
              oneOf:
                - $ref: '#/components/schemas/RatingElement'
              description: <em>product rating info</em>
              nullable: true
            is_amazon_choice:
              type: boolean
              description: '<em>"Amazon''s choice" label</em><br>if the value is <code>true</code>, the product is marked with the "Amazon''s choice" label'
              nullable: true
            is_best_seller:
              type: boolean
              description: '<em>"Best Seller" label</em><br>if the value is <code>true</code>, the product is marked with the "Best Seller" label'
              nullable: true
            delivery_info:
              type: object
              oneOf:
                - $ref: '#/components/schemas/AmazonDeliveryInfo'
              description: <em>delivery information</em><br>delivery information including free and fast delivery date ranges
              nullable: true
            labels:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AmazonLabelElement'
                nullable: true
              description: '<em>product labels</em><br>array containing an object with main Amazon labels’ information<br>if the product contains no labels, the value will be <code>null</code>'
              nullable: true
    MerchantAmazonSerpSerpElementItem:
      type: object
      allOf:
        - type: object
          oneOf:
            - $ref: '#/components/schemas/BaseMerchantAmazonElementItem'
          nullable: true
        - type: object
          properties:
            domain:
              type: string
              description: <em>Amazon domain</em>
              nullable: true
            title:
              type: string
              description: <em>product title</em>
              nullable: true
            url:
              type: string
              description: <em>the URL of the product page</em>
              nullable: true
            image_url:
              type: string
              description: <em>URL of the product image featured in the results</em>
              nullable: true
            bought_past_month:
              type: integer
              description: <em>number of product purchases in the past month</em>
              nullable: true
            price_from:
              type: number
              description: <em>the regular price of a product</em><br>example:<br><code>49.98</code>
              nullable: true
            price_to:
              type: number
              description: <em>the upper limit of the product price range</em><br>example:<br><code>384.99</code>
              nullable: true
            currency:
              type: string
              description: <em>currency in the <a href="https://en.wikipedia.org/wiki/ISO_4217">ISO</a> format</em><br>example:<br><code>USD</code>
              nullable: true
            special_offers:
              type: array
              items:
                type: string
                nullable: true
              description: '<em>special offer details</em><br>contains special offer details, including coupon and Subscribe & Save discounts'
              nullable: true
            data_asin:
              type: string
              description: <em>unique product identifier on Amazon</em><br>note that there is no full list of possible values as the <code>data_asin</code> is a dynamic value assigned by Amazon<br>example:<br><code>B07G82D89J</code>
              nullable: true
            rating:
              type: object
              oneOf:
                - $ref: '#/components/schemas/RatingElement'
              description: <em>product rating info</em>
              nullable: true
            is_amazon_choice:
              type: boolean
              description: '<em>"Amazon''s choice" label</em><br>if the value is <code>true</code>, the product is marked with the "Amazon''s choice" label'
              nullable: true
            is_best_seller:
              type: boolean
              description: '<em>"Best Seller" label</em><br>if the value is <code>true</code>, the product is marked with the "Best Seller" label'
              nullable: true
            delivery_info:
              type: object
              oneOf:
                - $ref: '#/components/schemas/AmazonDeliveryInfo'
              description: <em>delivery information</em><br>delivery information including free and fast delivery date ranges
              nullable: true
            labels:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AmazonLabelElement'
                nullable: true
              description: '<em>product labels</em><br>array containing an object with main Amazon labels’ information<br>if the product contains no labels, the value will be <code>null</code>'
              nullable: true
    AmazonSerpElement:
      type: object
      properties:
        type:
          type: string
          description: type of element
          nullable: true
        xpath:
          type: string
          description: <em>the <a href="https://en.wikipedia.org/wiki/XPath">XPath</a> of the element</em>
          nullable: true
        domain:
          type: string
          description: <em>Amazon domain</em>
          nullable: true
        title:
          type: string
          description: <em>product title</em>
          nullable: true
        url:
          type: string
          description: <em>the URL of the product page</em>
          nullable: true
        image_url:
          type: string
          description: <em>URL of the product image featured in the results</em>
          nullable: true
        bought_past_month:
          type: integer
          description: <em>number of product purchases in the past month</em>
          nullable: true
        price_from:
          type: number
          description: <em>the regular price of a product</em><br>example:<br><code>49.98</code>
          nullable: true
        price_to:
          type: number
          description: <em>the upper limit of the product price range</em><br>example:<br><code>384.99</code>
          nullable: true
        currency:
          type: string
          description: <em>currency in the <a href="https://en.wikipedia.org/wiki/ISO_4217">ISO</a> format</em><br>example:<br><code>USD</code>
          nullable: true
        special_offers:
          type: array
          items:
            type: string
            nullable: true
          description: '<em>special offer details</em><br>contains special offer details, including coupon and Subscribe & Save discounts'
          nullable: true
        data_asin:
          type: string
          description: <em>unique product identifier on Amazon</em><br>note that there is no full list of possible values as the <code>data_asin</code> is a dynamic value assigned by Amazon<br>example:<br><code>B07G82D89J</code>
          nullable: true
        rating:
          type: object
          oneOf:
            - $ref: '#/components/schemas/RatingElement'
          description: <em>product rating info</em>
          nullable: true
        is_amazon_choice:
          type: boolean
          description: '<em>"Amazon''s choice" label</em><br>if the value is <code>true</code>, the product is marked with the "Amazon''s choice" label'
          nullable: true
        is_best_seller:
          type: boolean
          description: '<em>"Best Seller" label</em><br>if the value is <code>true</code>, the product is marked with the "Best Seller" label'
          nullable: true
        delivery_info:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AmazonDeliveryInfo'
          description: <em>delivery information</em><br>delivery information including free and fast delivery date ranges
          nullable: true
        labels:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/AmazonLabelElement'
            nullable: true
          description: '<em>product labels</em><br>array containing an object with main Amazon labels’ information<br>if the product contains no labels, the value will be <code>null</code>'
          nullable: true
    MerchantEditorialRecommendationsSerpElementItem:
      type: object
      allOf:
        - type: object
          oneOf:
            - $ref: '#/components/schemas/BaseMerchantAmazonElementItem'
          nullable: true
        - type: object
          properties:
            position:
              type: string
              description: '<em>the alignment of the element in Amazon SERP</em><br>possible values:<br><code>left</code>, <code>right</code>'
              nullable: true
            items:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AmazonSerpElement'
                nullable: true
              description: <em>Amazon product items</em>
              nullable: true
    MerchantRelatedSearchesSerpElementItem:
      type: object
      allOf:
        - type: object
          oneOf:
            - $ref: '#/components/schemas/BaseMerchantAmazonElementItem'
          nullable: true
        - type: object
          properties:
            position:
              type: string
              description: '<em>the alignment of the element in Amazon SERP</em><br>possible values:<br><code>left</code>, <code>right</code>'
              nullable: true
            items:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/RelatedSearchesElement'
                nullable: true
              description: <em>Amazon product items</em>
              nullable: true
    MerchantTopRatedFromOurBrandsSerpElementItem:
      type: object
      allOf:
        - type: object
          oneOf:
            - $ref: '#/components/schemas/BaseMerchantAmazonElementItem'
          nullable: true
        - type: object
          properties:
            position:
              type: string
              description: '<em>the alignment of the element in Amazon SERP</em><br>possible values:<br><code>left</code>, <code>right</code>'
              nullable: true
            items:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AmazonSerpElement'
                nullable: true
              description: <em>Amazon product items</em>
              nullable: true
    MerchantAmazonProductsTaskGetAdvancedResultInfo:
      type: object
      properties:
        keyword:
          type: string
          description: <em>keyword received in a POST array</em><br><strong>keyword is returned with decoded %## (plus character '+' will be decoded to a space character)</strong>
          nullable: true
        type:
          type: string
          description: type of element
          nullable: true
        se_domain:
          type: string
          description: <em>search engine domain in a POST array</em>
          nullable: true
        location_code:
          type: integer
          description: <em>location code in a POST array</em>
          nullable: true
        language_code:
          type: string
          description: <em>language code in a POST array</em>
          nullable: true
        check_url:
          type: string
          description: <em>direct URL to Amazon results</em><br>you can use it to make sure that we provided accurate results
          nullable: true
        datetime:
          type: string
          description: '<em>date and time when the result was received</em><br>in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”<br>example:<br><code class="long-string">2019-11-15 12:57:46 +00:00</code>'
          nullable: true
        spell:
          type: object
          oneOf:
            - $ref: '#/components/schemas/SpellInfo'
          description: '<em>autocorrection of the search engine</em><br>if the search engine provided results for a keyword that was corrected, we will specify the keyword corrected by the search engine and the type of autocorrection'
          nullable: true
        item_types:
          type: array
          items:
            type: string
            nullable: true
          description: '<em>types of search results found in Amazon SERP</em><br>contains types of all search results (<code>items</code>) found in the returned SERP<br>possible item types:<br><code>amazon_serp</code>, <code>amazon_paid</code>, <code>editorial_recommendations</code>, <code>top_rated_from_our_brands</code>, <code>related_searches</code>'
          nullable: true
        se_results_count:
          type: integer
          description: <em>search engine results count</em>
          format: int64
          nullable: true
        categories:
          type: array
          items:
            type: string
            nullable: true
          description: <em>amazon product departments and subcategories</em>
          nullable: true
        items_count:
          type: integer
          description: <em>the number of results returned in the <strong><code>items</code></strong> array</em>
          format: int64
          nullable: true
        items:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/BaseMerchantAmazonElementItem'
            nullable: true
          description: <em>Amazon product items within the <code>editorial_recommendations</code> element</em>
          nullable: true
    MerchantAmazonProductsTaskGetAdvancedTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/MerchantAmazonProductsTaskGetAdvancedResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    MerchantAmazonProductsTaskGetAdvancedResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/MerchantAmazonProductsTaskGetAdvancedTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    MerchantAmazonProductsLiveAdvancedRequestInfo:
      type: object
      properties:
        keyword:
          type: string
          description: '<em>keyword</em><br><strong>required field</strong><br>you can specify <strong>up to 700 characters</strong> in this field<br><strong>all %## will be decoded (plus character ‘+’ will be decoded to a space character)</strong><br>if you need to use the “%” character for your <code>keyword</code>, please specify it as “%25”;<p>learn more about rules and limitations of <code>keyword</code> and <code>keywords</code> fields in DataForSEO APIs in this <a href="https://dataforseo.com/help-center/rules-and-limitations-of-keyword-and-keywords-fields-in-dataforseo-apis" rel="noopener noreferrer" target="_blank">Help Center article</a>'
        url:
          type: string
          description: '<em>direct URL of the search query</em><br>optional field<br>you can specify a direct URL and we will sort it out to the necessary fields. Note that this method is the most difficult for our API to process and also requires you to specify the exact language and location in the URL. In most cases, we wouldn’t recommend using this method.<br>example:<br><code class="long-string">https://www.amazon.com/s/?field-keywords=shoes&amp;language=en_US</code>'
          nullable: true
        location_name:
          type: string
          description: '<em>full name of search engine location</em><br><strong>required field if you don''t specify</strong> <code>location_code</code> or <code>location_coordinate</code><br><strong>if you use this field, you don''t need to specify <code>location_code</code> or <code>location_coordinate</code></strong><br>you can receive the list of available locations with their <code>location_name</code> parameters by making a separate request to the <code>https://api.dataforseo.com/v3/merchant/amazon/locations</code><br>example:<br><code class="long-string">HA1,England,United Kingdom</code>'
        location_code:
          type: integer
          description: '<em>search engine location code</em><br><strong>required field if you don''t specify</strong> <code>location_name</code> or <code>location_coordinate</code><br><strong>if you use this field, you don''t need to specify <code>location_name</code> or <code>location_coordinate</code></strong><br>you can receive the list of available locations with their <code>location_code</code> parameters by making a separate request to the<br><code>https://api.dataforseo.com/v3/merchant/amazon/locations</code><br>example:<br><code class="long-string">9045969</code>'
        location_coordinate:
          type: string
          description: '<em>GPS coordinates of a location</em><br><strong>required field if you don''t specify</strong> <code>location_name</code> or <code>location_code</code><br><strong>if you use this field, you don''t need to specify <code>location_name</code> or <code>location_code</code></strong><br><code>location_coordinate</code> parameter should be specified in the <em>"latitude,longitude,radius"</em> format<br>the maximum number of decimal digits for <em>"latitude"</em> and <em>"longitude"</em>: 7<br>the minimum value for <em>"radius"</em>: 199.9<br>example:<br><code class="long-string">53.476225,-2.243572,200</code>'
        language_name:
          type: string
          description: '<em>full name of search engine language</em><br><strong>required field if you don''t specify</strong> <code>language_code</code><br><strong>if you use this field, you don''t need to specify <code>language_code</code></strong><br>you can receive the list of available languages with their <code>language_name</code> parameters by making a separate request to the<br><code>https://api.dataforseo.com/v3/merchant/amazon/languages</code><br>example:<br><code class="long-string">English (United Kingdom)</code>'
        language_code:
          type: string
          description: '<em>search engine language code</em><br><strong>required field if you don''t specify</strong> <code>language_name</code><br><strong>if you use this field, you don''t need to specify <code>language_name</code></strong><br>you can receive the list of available languages with their <code>language_code</code> parameters by making a separate request to the <code>https://api.dataforseo.com/v3/merchant/amazon/languages</code><em><br></em>example:<em><br></em><code class="long-string">en_GB</code>'
        se_domain:
          type: string
          description: '<em>search engine domain</em><br>optional field<br>we choose the relevant search engine domain automatically according to the location and language you specify<br>however, you can set a custom search engine domain in this field<br>example:<br><code><em>amazon.com</em></code>, <code><em>amazon.co.uk</em></code>, <code><em>amazon.fr</em></code>, etc.'
          nullable: true
        depth:
          type: integer
          description: '<em>parsing depth</em><br>optional field<br>number of results to be retrieved from the Amazon results page<br>default value: <code>100</code><br>max value: <code>700</code><br><strong>Your account will be billed per each SERP containing up to 100 results;</strong> <br>Setting depth above 100 may result in additional charges if the search engine returns more than 100 results</a>;<br>The cost can be calculated on the <a title="Pricing" href="https://dataforseo.com/pricing/merchant/amazon-api" target="_blank" rel="noopener noreferrer">Pricing</a> page.'
          nullable: true
        max_crawl_pages:
          type: integer
          description: '<em>page crawl limit</em><br>optional field<br>number of search results pages to crawl<br>max value: <code>7</code><br><strong>Note:</strong> the <code>max_crawl_pages</code> and <code>depth</code> parameters complement each other;<br>learn more at <a href="https://dataforseo.com/help-center/what-is-max-crawl-pages-and-how-does-it-work" rel="noopener noreferrer" target="_blank">our help center</a>'
          nullable: true
        department:
          type: string
          description: '<em>amazon product department</em><br>optional field<br>specify one of the following amazon departments for extracting product listings:<br><code>"Arts & Crafts"</code>, <code>"Automotive"</code>, <code>"Baby"</code>, <code>"Beauty & Personal Care"</code>, <code>"Books"</code>, <code>"Computers"</code>, <code>"Digital Music"</code>, <code>"Electronics"</code>, <code>"Kindle Store"</code>, <code>"Prime Video"</code>, <code>"Women''s Fashion"</code>, <code>"Men''s Fashion"</code>, <code>"Girls'' Fashion"</code>, <code>"Boys'' Fashion"</code>, <code>"Deals"</code>, <code>"Health & Household"</code>, <code>"Home & Kitchen"</code>, <code>"Industrial & Scientific"</code>, <code>"Luggage"</code>, <code>"Movies & TV"</code>, <code>"Music, CDs & Vinyl"</code>, <code>"Pet Supplies"</code>, <code>"Software"</code>, <code>"Sports & Outdoors"</code>, <code>"Tools & Home Improvement"</code>, <code>"Toys & Games"</code>, <code>"Video Games"</code>'
          nullable: true
        search_param:
          type: string
          description: '<em>additional parameters of the search query</em><br>optional field<br>you can use the following Amazon search URL parameters for customizing the search<br>example:<br><code>&low-price=52</code> - search for products that cost <em>more than 52 USD</em>;<br><code>&high-price=45</code> - search for products that cost <em>less than 45 USD</em>;<br><code>&sort=relevancerank</code> - sort results by <em>relevance</em>;<br><code>&sort=featured-rank</code> - sort results by <em>featured</em> products;<br><code>&sort=price-asc-rank</code> - sort by <em>ascending price</em>;<br><code>&sort=price-desc-rank</code> - sort by <em>descending price</em>;<br><code>&sort=review-rank</code> - sort by the average <em>customer reviews</em> value;<br><code>&sort=date-desc-rank</code> - sort by the <em>newest arrival</em><br><strong>Note</strong> that <code>search_param</code> values will be ignored if any of the following parameters is used: <code>price_min</code>, <code>price_max</code>, <code>sort_by</code>'
          nullable: true
        price_min:
          type: integer
          description: '<em>minimum product price</em><br>optional field<br>minimum price of the returned products listed on Amazon for the specified query<br>example:<br><code>5</code><br><strong>Note:</strong> if you specify <code>price_min</code>, the <code>search_param</code> parameter will be ignored'
          nullable: true
        price_max:
          type: integer
          description: '<em>maximum product price</em><br>optional field<br>maximum price of the returned products listed on Amazon for the specified query<br>example:<br><code>100</code><br><strong>Note:</strong> if you specify <code>price_max</code>, the <code>search_param</code> parameter will be ignored'
          nullable: true
        sort_by:
          type: string
          description: '<em>results sorting rules</em><br>optional field<br>the following sorting rules are supported:<br><code>relevance</code>, <code>price_low_to_high</code>, <code>price_high_to_low</code>, <code>featured</code>, <code>avg_customer_review</code>, <code>newest_arrival</code><br>example:<br><code>sort_by:"relevance"</code><br><strong>Note:</strong> if you specify <code>sort_by</code>, the <code>search_param</code> parameter will be ignored'
          nullable: true
        tag:
          type: string
          description: <em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response
          nullable: true
      example:
        - language_code: en_US
          location_code: 2840
          keyword: shoes
    MerchantAmazonProductsLiveAdvancedResultInfo:
      type: object
      properties:
        keyword:
          type: string
          description: <em>keyword received in a POST array</em><br><strong>keyword is returned with decoded %## (plus character '+' will be decoded to a space character)</strong>
          nullable: true
        type:
          type: string
          description: type of element
          nullable: true
        se_domain:
          type: string
          description: <em>search engine domain in a POST array</em>
          nullable: true
        location_code:
          type: integer
          description: <em>location code in a POST array</em>
          nullable: true
        language_code:
          type: string
          description: <em>language code in a POST array</em>
          nullable: true
        check_url:
          type: string
          description: <em>direct URL to Amazon results</em><br>you can use it to make sure that we provided accurate results
          nullable: true
        datetime:
          type: string
          description: '<em>date and time when the result was received</em><br>in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”<br>example:<br><code class="long-string">2019-11-15 12:57:46 +00:00</code>'
          nullable: true
        spell:
          type: object
          oneOf:
            - $ref: '#/components/schemas/SpellInfo'
          description: '<em>autocorrection of the search engine</em><br>if the search engine provided results for a keyword that was corrected, we will specify the keyword corrected by the search engine and the type of autocorrection'
          nullable: true
        item_types:
          type: array
          items:
            type: string
            nullable: true
          description: '<em>types of search results found in Amazon SERP</em><br>contains types of all search results (<code>items</code>) found in the returned SERP<br>possible item types:<br><code>amazon_serp</code>, <code>amazon_paid</code>, <code>editorial_recommendations</code>, <code>top_rated_from_our_brands</code>, <code>related_searches</code>'
          nullable: true
        se_results_count:
          type: integer
          description: <em>search engine results count</em>
          format: int64
          nullable: true
        categories:
          type: object
          description: <em>amazon product departments and subcategories</em>
          nullable: true
        items_count:
          type: integer
          description: <em>the number of results returned in the <strong><code>items</code></strong> array</em>
          format: int64
          nullable: true
        items:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/BaseMerchantAmazonElementItem'
            nullable: true
          description: <em>Amazon product items</em>
          nullable: true
    MerchantAmazonProductsLiveAdvancedTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/MerchantAmazonProductsLiveAdvancedResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    MerchantAmazonProductsLiveAdvancedResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/MerchantAmazonProductsLiveAdvancedTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    MerchantAmazonProductsTaskGetHtmlResultInfo:
      type: object
      properties:
        keyword:
          type: string
          description: <em>keyword received in a POST array<br></em><strong>keyword is returned with decoded %## (plus character '+' will be decoded to a space character)</strong>
          nullable: true
        type:
          type: string
          description: type of element
          nullable: true
        se_domain:
          type: string
          description: <em>search engine domain in a POST array</em>
          nullable: true
        location_code:
          type: integer
          description: <em>location code in a POST array</em>
          nullable: true
        language_code:
          type: string
          description: <em>language code in a POST array</em>
          nullable: true
        datetime:
          type: string
          description: '<em>date and time when the result was received</em><br>in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”<br>example:<br><code class="long-string">2019-11-15 12:57:46 +00:00</code>'
          nullable: true
        items_count:
          type: integer
          description: <em>the number of results returned in the <strong><code>items</code></strong> array</em>
          format: int64
          nullable: true
        items:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/HtmlItemInfo'
            nullable: true
          description: <em>HTML pages and related data</em>
          nullable: true
    MerchantAmazonProductsTaskGetHtmlTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/MerchantAmazonProductsTaskGetHtmlResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    MerchantAmazonProductsTaskGetHtmlResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/MerchantAmazonProductsTaskGetHtmlTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    MerchantAmazonProductsLiveHtmlRequestInfo:
      type: object
      properties:
        keyword:
          type: string
          description: '<em>keyword</em><br><strong>required field</strong><br>you can specify <strong>up to 700 characters</strong> in this field<br><strong>all %## will be decoded (plus character ‘+’ will be decoded to a space character)</strong><br>if you need to use the “%” character for your <code>keyword</code>, please specify it as “%25”;<p>learn more about rules and limitations of <code>keyword</code> and <code>keywords</code> fields in DataForSEO APIs in this <a href="https://dataforseo.com/help-center/rules-and-limitations-of-keyword-and-keywords-fields-in-dataforseo-apis" rel="noopener noreferrer" target="_blank">Help Center article</a>'
        url:
          type: string
          description: '<em>direct URL of the search query</em><br>optional field<br>you can specify a direct URL and we will sort it out to the necessary fields. Note that this method is the most difficult for our API to process and also requires you to specify the exact language and location in the URL. In most cases, we wouldn’t recommend using this method.<br>example:<br><code class="long-string">https://www.amazon.com/s/?field-keywords=shoes&amp;language=en_US</code>'
          nullable: true
        location_name:
          type: string
          description: '<em>full name of search engine location</em><br><strong>required field if you don''t specify</strong> <code>location_code</code> or <code>location_coordinate</code><br><strong>if you use this field, you don''t need to specify <code>location_code</code> or <code>location_coordinate</code></strong><br>you can receive the list of available locations with their <code>location_name</code> parameters by making a separate request to the <code>https://api.dataforseo.com/v3/merchant/amazon/locations</code><br>example:<br><code class="long-string">HA1,England,United Kingdom</code>'
        location_code:
          type: integer
          description: '<em>search engine location code</em><br><strong>required field if you don''t specify</strong> <code>location_name</code> or <code>location_coordinate</code><br><strong>if you use this field, you don''t need to specify <code>location_name</code> or <code>location_coordinate</code></strong><br>you can receive the list of available locations with their <code>location_code</code> parameters by making a separate request to the<br><code>https://api.dataforseo.com/v3/merchant/amazon/locations</code><br>example:<br><code class="long-string">9045969</code>'
        location_coordinate:
          type: string
          description: '<em>GPS coordinates of a location</em><br><strong>required field if you don''t specify</strong> <code>location_name</code> or <code>location_code</code><br><strong>if you use this field, you don''t need to specify <code>location_name</code> or <code>location_code</code></strong><br><code>location_coordinate</code> parameter should be specified in the <em>"latitude,longitude,radius"</em> format<br>the maximum number of decimal digits for <em>"latitude"</em> and <em>"longitude"</em>: 7<br>the minimum value for <em>"radius"</em>: 199.9<br>example:<br><code class="long-string">53.476225,-2.243572,200</code>'
        language_name:
          type: string
          description: '<em>full name of search engine language</em><br><strong>required field if you don''t specify</strong> <code>language_code</code><br><strong>if you use this field, you don''t need to specify <code>language_code</code></strong><br>you can receive the list of available languages with their <code>language_name</code> parameters by making a separate request to the<br><code>https://api.dataforseo.com/v3/merchant/amazon/languages</code><br>example:<br><code class="long-string">English (United Kingdom)</code>'
        language_code:
          type: string
          description: '<em>search engine language code</em><br><strong>required field if you don''t specify</strong> <code>language_name</code><br><strong>if you use this field, you don''t need to specify <code>language_name</code></strong><br>you can receive the list of available languages with their <code>language_code</code> parameters by making a separate request to the <code>https://api.dataforseo.com/v3/merchant/amazon/languages</code><em><br></em>example:<em><br></em><code class="long-string">en_GB</code>'
        se_domain:
          type: string
          description: '<em>search engine domain</em><br>optional field<br>we choose the relevant search engine domain automatically according to the location and language you specify<br>however, you can set a custom search engine domain in this field<br>example:<br><code><em>amazon.com</em></code>, <code><em>amazon.co.uk</em></code>, <code><em>amazon.fr</em></code>, etc.'
          nullable: true
        depth:
          type: integer
          description: '<em>parsing depth</em><br>optional field<br>number of results to be retrieved from the Amazon results page<br>default value: <code>100</code><br>max value: <code>700</code><br><strong>Your account will be billed per each SERP containing up to 100 results;</strong> <br>Setting depth above 100 may result in additional charges if the search engine returns more than 100 results</a>;<br>The cost can be calculated on the <a title="Pricing" href="https://dataforseo.com/pricing/merchant/amazon-api" target="_blank" rel="noopener noreferrer">Pricing</a> page.'
          nullable: true
        max_crawl_pages:
          type: integer
          description: '<em>page crawl limit</em><br>optional field<br>number of search results pages to crawl<br>max value: <code>7</code><br><strong>Note:</strong> the <code>max_crawl_pages</code> and <code>depth</code> parameters complement each other;<br>learn more at <a href="https://dataforseo.com/help-center/what-is-max-crawl-pages-and-how-does-it-work" rel="noopener noreferrer" target="_blank">our help center</a>'
          nullable: true
        department:
          type: string
          description: '<em>amazon product department</em><br>optional field<br>specify one of the following amazon departments for extracting product listings:<br><code>"Arts & Crafts"</code>, <code>"Automotive"</code>, <code>"Baby"</code>, <code>"Beauty & Personal Care"</code>, <code>"Books"</code>, <code>"Computers"</code>, <code>"Digital Music"</code>, <code>"Electronics"</code>, <code>"Kindle Store"</code>, <code>"Prime Video"</code>, <code>"Women''s Fashion"</code>, <code>"Men''s Fashion"</code>, <code>"Girls'' Fashion"</code>, <code>"Boys'' Fashion"</code>, <code>"Deals"</code>, <code>"Health & Household"</code>, <code>"Home & Kitchen"</code>, <code>"Industrial & Scientific"</code>, <code>"Luggage"</code>, <code>"Movies & TV"</code>, <code>"Music, CDs & Vinyl"</code>, <code>"Pet Supplies"</code>, <code>"Software"</code>, <code>"Sports & Outdoors"</code>, <code>"Tools & Home Improvement"</code>, <code>"Toys & Games"</code>, <code>"Video Games"</code>'
          nullable: true
        search_param:
          type: string
          description: '<em>additional parameters of the search query</em><br>optional field<br>you can use the following Amazon search URL parameters for customizing the search<br>example:<br><code>&low-price=52</code> - search for products that cost <em>more than 52 USD</em>;<br><code>&high-price=45</code> - search for products that cost <em>less than 45 USD</em>;<br><code>&sort=relevancerank</code> - sort results by <em>relevance</em>;<br><code>&sort=featured-rank</code> - sort results by <em>featured</em> products;<br><code>&sort=price-asc-rank</code> - sort by <em>ascending price</em>;<br><code>&sort=price-desc-rank</code> - sort by <em>descending price</em>;<br><code>&sort=review-rank</code> - sort by the average <em>customer reviews</em> value;<br><code>&sort=date-desc-rank</code> - sort by the <em>newest arrival</em><br><strong>Note</strong> that <code>search_param</code> values will be ignored if any of the following parameters is used: <code>price_min</code>, <code>price_max</code>, <code>sort_by</code>'
          nullable: true
        price_min:
          type: integer
          description: '<em>minimum product price</em><br>optional field<br>minimum price of the returned products listed on Amazon for the specified query<br>example:<br><code>5</code><br><strong>Note:</strong> if you specify <code>price_min</code>, the <code>search_param</code> parameter will be ignored'
          nullable: true
        price_max:
          type: integer
          description: '<em>maximum product price</em><br>optional field<br>maximum price of the returned products listed on Amazon for the specified query<br>example:<br><code>100</code><br><strong>Note:</strong> if you specify <code>price_max</code>, the <code>search_param</code> parameter will be ignored'
          nullable: true
        sort_by:
          type: string
          description: '<em>results sorting rules</em><br>optional field<br>the following sorting rules are supported:<br><code>relevance</code>, <code>price_low_to_high</code>, <code>price_high_to_low</code>, <code>featured</code>, <code>avg_customer_review</code>, <code>newest_arrival</code><br>example:<br><code>sort_by:"relevance"</code><br><strong>Note:</strong> if you specify <code>sort_by</code>, the <code>search_param</code> parameter will be ignored'
          nullable: true
        tag:
          type: string
          description: <em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response
          nullable: true
      example:
        - language_code: en_US
          location_code: 2840
          keyword: shoes
    MerchantAmazonProductsLiveHtmlResultInfo:
      type: object
      properties:
        keyword:
          type: string
          description: <em>keyword received in a POST array<br></em><strong>keyword is returned with decoded %## (plus character '+' will be decoded to a space character)</strong>
          nullable: true
        type:
          type: string
          description: type of element
          nullable: true
        se_domain:
          type: string
          description: <em>search engine domain in a POST array</em>
          nullable: true
        location_code:
          type: integer
          description: <em>location code in a POST array</em>
          nullable: true
        language_code:
          type: string
          description: <em>language code in a POST array</em>
          nullable: true
        datetime:
          type: string
          description: '<em>date and time when the result was received</em><br>in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”<br>example:<br><code class="long-string">2019-11-15 12:57:46 +00:00</code>'
          nullable: true
        items_count:
          type: integer
          description: <em>the number of results returned in the <strong><code>items</code></strong> array</em>
          format: int64
          nullable: true
        items:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/HtmlItemInfo'
            nullable: true
          description: <em>HTML pages and related data</em>
          nullable: true
    MerchantAmazonProductsLiveHtmlTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/MerchantAmazonProductsLiveHtmlResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    MerchantAmazonProductsLiveHtmlResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/MerchantAmazonProductsLiveHtmlTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    MerchantAmazonAsinTaskPostRequestInfo:
      type: object
      properties:
        asin:
          type: string
          description: <em>product ID</em><br><strong>required field</strong><br><a href="https://dataforseo.com/help-center/asin-in-amazon-api" target="_blank" rel="noopener noreferrer">unique product identifier (ASIN)</a> in Amazon<br>you can receive the <code>asin</code> parameter by making a separate request to the <a href="/v3/merchant/amazon/products/task_post/" target="_blank" rel="noopener noreferrer">Amazon Products endpoint</a>
        priority:
          type: integer
          description: <em>task priority</em><br>optional field<br>can take the following values:<br>1 – normal execution priority (set by default)<br>2 – high execution priorityYou will be additionally charged for the tasks with high execution priority.<br>The cost can be calculated on the <a title="Pricing" href="https://dataforseo.com/pricing/merchant/amazon-api" target="_blank" rel="noopener noreferrer">Pricing</a> page.
          nullable: true
        location_name:
          type: string
          description: '<em>full name of search engine location</em><br><strong>required field if you don''t specify</strong> <code>location_code</code> or <code>location_coordinate</code><br><strong>if you use this field, you don''t need to specify <code>location_code</code> or <code>location_coordinate</code></strong><br>you can receive the list of available locations with their <code>location_name</code> parameters by making a separate request to the <code>https://api.dataforseo.com/v3/merchant/amazon/locations</code><br>example:<br><code class="long-string">HA1,England,United Kingdom</code>'
        location_code:
          type: integer
          description: '<em>search engine location code</em><br><strong>required field if you don''t specify</strong> <code>location_name</code>_or <code>location_coordinate</code><br><strong>if you use this field, you don''t need to specify <code>location_name</code> or <code>location_coordinate</code></strong><br>you can receive the list of available locations with their <code>location_code</code> parameters by making a separate request to the<br><code>https://api.dataforseo.com/v3/merchant/amazon/locations</code><br>example:<br><code class="long-string">9045969</code>n'
        location_coordinate:
          type: string
          description: '<em>GPS coordinates of a location</em><br><strong>required field if you don''t specify</strong> <code>location_name</code>_or <code>location_code</code><br><strong>if you use this field, you don''t need to specify <code>location_name</code> or <code>location_code</code></strong><br><code>location_coordinate</code> parameter should be specified in the <em>"latitude,longitude,radius"</em> format<br>the maximum number of decimal digits for <em>"latitude"</em> and <em>"longitude"</em>: 7<br>the minimum value for <em>"radius"</em>: 199.9<br>example:<br><code class="long-string">53.476225,-2.243572,200</code>'
        language_name:
          type: string
          description: '<em>full name of search engine language</em><br><strong>required field if you don''t specify</strong> <code>language_code</code><br><strong>if you use this field, you don''t need to specify <code>language_code</code></strong><br>you can receive the list of available languages with their <code>language_name</code> parameters by making a separate request to the<br><code>https://api.dataforseo.com/v3/merchant/amazon/languages</code><br>example:<br><code class="long-string">English (United Kingdom)</code>'
        language_code:
          type: string
          description: '<em>search engine language code</em><br><strong>required field if you don''t specify</strong> <code>language_name</code><br><strong>if you use this field, you don''t need to specify <code>language_name</code></strong><br>you can receive the list of available languages with their <code>language_code</code>_parameters by making a separate request to the <code>https://api.dataforseo.com/v3/merchant/amazon/languages</code><em><br></em>example:<em><br></em><code class="long-string">en_GB</code>'
        se_domain:
          type: string
          description: '<em>search engine domain</em><br>optional field<br>we choose the relevant search engine domain automatically according to the location and language you specify<br>however, you can set a custom search engine domain in this field<br>example:<br><em><code>amazon.com</code></em>, <em><code>amazon.co.uk</code></em>, <em><code>amazon.fr</code></em>, etc.'
          nullable: true
        tag:
          type: string
          description: <em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response
          nullable: true
        postback_url:
          type: string
          description: '<em>URL for sending task results</em><br>optional field<br>once the task is completed, we will send a POST request with its results compressed in the <code>gzip</code> format to the <code>postback_url</code> you specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/postbackscript?id=$id</code><br><code>http://your-server.com/postbackscript?id=$id&amp;tag=$tag</code><br><strong>Note:</strong> special characters in <code>postback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href="https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api" target="_blank" rel="noopener noreferrer">Help Center</a>'
          nullable: true
        postback_data:
          type: string
          description: '<em>postback_url datatype</em><br><strong>required field if you specify <code>postback_url</code></strong><br>corresponds to the datatype that will be sent to your server<br>possible values:<br><code>advanced</code>, <code>html</code>'
        pingback_url:
          type: string
          description: '<em>notification URL of a completed task</em><br>optional field<br>when a task is completed we will notify you by GET request sent to the URL you have specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/pingscript?id=$id</code><br><code>http://your-server.com/pingscript?id=$id&amp;tag=$tag</code><br><strong>Note:</strong> special characters in <code>pingback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href="https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api" target="_blank" rel="noopener noreferrer">Help Center</a>'
          nullable: true
      example:
        - language_code: en_US
          location_code: 2840
          asin: B0756FCPPN
    MerchantAmazonAsinTaskPostTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: object
              description: '<em>array of results</em><br>in this case, the value will be <code>null</code>'
              nullable: true
    MerchantAmazonAsinTaskPostResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/MerchantAmazonAsinTaskPostTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    MerchantAmazonAsinTasksReadyResultInfo:
      type: object
      properties:
        id:
          type: string
          description: <em>task identifier of the completed task</em><br><strong>unique task identifier in our system in the <a href="https://en.wikipedia.org/wiki/Universally_unique_identifier">UUID</a> format</strong>
          nullable: true
        se:
          type: string
          description: <em>search engine specified when setting the task</em>
          nullable: true
        se_type:
          type: string
          description: '<em>type of search engine</em><br>can take the following values: <code>shopping</code>'
          nullable: true
        date_posted:
          type: string
          description: <em>date when the task was posted (in the UTC format)</em>
          nullable: true
        tag:
          type: string
          nullable: true
        endpoint_advanced:
          type: string
          description: <em>URL for collecting the results of the Amazon ASIN Advanced task</em>
          nullable: true
        endpoint_html:
          type: string
          description: <em>URL for collecting the results of the Amazon ASIN HTML task</em>
          nullable: true
    MerchantAmazonAsinTasksReadyTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/MerchantAmazonAsinTasksReadyResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    MerchantAmazonAsinTasksReadyResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/MerchantAmazonAsinTasksReadyTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    AmazonApplicableVouchersItem:
      type: object
      properties:
        type:
          type: string
          description: type of element
          nullable: true
        text:
          type: string
          description: <em>text of the voucher</em>
          nullable: true
        fixed_discount:
          type: number
          description: <em>value of the fixed discount</em>
          nullable: true
        fixed_discount_currency:
          type: string
          description: <em>currency code of the fixed discount</em>
          nullable: true
        percentage_discount:
          type: number
          description: '<em>value of the percentage discount</em><br>if the discount is fixed, the value will be <code>null</code>'
          nullable: true
        important_details:
          type: string
          description: <em>important details about the terms of discount vouchers</em>
          nullable: true
    NewerModel:
      type: object
      properties:
        title:
          type: string
          description: <em>product title</em>
          nullable: true
        newer_model_asin:
          type: string
          description: <em>ASIN of the newer product model</em>
          nullable: true
    Categories:
      type: object
      properties:
        category:
          type: string
          description: <em>product category name</em>
          nullable: true
        url:
          type: string
          description: <em>product category URL</em><br>indicates the <a href="https://sellercentral.amazon.com/gp/help/external/G1661?language=en_US" rel="noopener noreferrer" target="_blank">browse path on Amazon</a> with the unique browse node ID (product category ID on Amazon)
          nullable: true
    ProductInformationProductInformationDetailsItem:
      type: object
      allOf:
        - type: object
          oneOf:
            - $ref: '#/components/schemas/BaseMerchantAmazonProductInformationElementItem'
          nullable: true
        - type: object
          properties:
            body:
              type: object
              additionalProperties:
                type: string
                nullable: true
              description: <em>contains information specified about the product within the <code>section_name</code></em>
              nullable: true
    ProductInformationProductInformationTextItem:
      type: object
      allOf:
        - type: object
          oneOf:
            - $ref: '#/components/schemas/BaseMerchantAmazonProductInformationElementItem'
          nullable: true
        - type: object
          properties:
            text:
              type: string
              description: <em>text specified under the given <code>title</code> within the <code>section_name</code></em>
              nullable: true
    ProductInformationRowProductInformationImageRowElementItem:
      type: object
      allOf:
        - type: object
          oneOf:
            - $ref: '#/components/schemas/BaseMerchantAmazonProductInformationRowElementItem'
          nullable: true
        - type: object
          properties:
            alt:
              type: string
              description: <em>alternative text of the related product image</em>
              nullable: true
            url:
              type: string
              description: <em>URL of the image</em>
              nullable: true
    ProductInformationRowProductInformationTextRowElementItem:
      type: object
      allOf:
        - type: object
          oneOf:
            - $ref: '#/components/schemas/BaseMerchantAmazonProductInformationRowElementItem'
          nullable: true
        - type: object
          properties:
            text:
              type: string
              description: <em>text of the voucher</em>
              nullable: true
    ProductInformationRows:
      type: object
      properties:
        type:
          type: string
          description: type of element
          nullable: true
        title:
          type: string
          description: <em>title under which related product information appears on the Amazon product page</em>
          nullable: true
        rows:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/BaseMerchantAmazonProductInformationRowElementItem'
            nullable: true
          description: <em>rows containing related product information</em>
          nullable: true
    ProductInformationProductInformationExtendedItem:
      type: object
      allOf:
        - type: object
          oneOf:
            - $ref: '#/components/schemas/BaseMerchantAmazonProductInformationElementItem'
          nullable: true
        - type: object
          properties:
            contents:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/ProductInformationRows'
                nullable: true
              description: <em>contains information specified about the product within the <code>section_name</code></em>
              nullable: true
    UserProfileInfo:
      type: object
      properties:
        name:
          type: string
          nullable: true
        avatar:
          type: string
          nullable: true
        url:
          type: string
          description: <em>relevant url</em>
          nullable: true
        reviews_count:
          type: integer
          format: int64
          nullable: true
        locations:
          type: string
          nullable: true
    AmazonReviewItem:
      type: object
      properties:
        type:
          type: string
          description: type of element
          nullable: true
        rank_group:
          type: integer
          description: <em>position within a group of elements with identical <code>type</code> values</em><br>positions of elements with different <code>type</code> values are omitted from <code>rank_group</code>
          nullable: true
        rank_absolute:
          type: integer
          description: <em>absolute rank among all the listed reviews</em><br>absolute position among all reviews on the list
          nullable: true
        position:
          type: string
          description: '<em>the alignment of the review in SERP</em><br>can take the following values: <code>right</code>'
          nullable: true
        xpath:
          type: string
          description: <em>the <a href="https://en.wikipedia.org/wiki/XPath">XPath</a> of the element</em>
          nullable: true
        verified:
          type: boolean
          description: <em>indicates whether the review has the "Verified Purchase" mark</em>
          nullable: true
        subtitle:
          type: string
          description: <em>subtitle of the review</em>
          nullable: true
        helpful_votes:
          type: string
          description: <em>helpful votes count</em><br>number of users who clicked on the 'Helpful" button under the review text
          nullable: true
        images:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/AiModeImagesElementInfo'
            nullable: true
          description: <em>images of the product submitted by the reviewer</em>
          nullable: true
        videos:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/VideoElement'
            nullable: true
          description: <em>videos of the product submitted by the reviewer</em>
          nullable: true
        user_profile:
          type: object
          oneOf:
            - $ref: '#/components/schemas/UserProfileInfo'
          description: <em>user profile of the reviewer</em>
          nullable: true
        title:
          type: string
          description: <em>title of the review</em>
          nullable: true
        url:
          type: string
          nullable: true
        review_text:
          type: string
          description: <em>content of the review</em>
          nullable: true
        publication_date:
          type: string
          description: '<em>date and time when the review was published</em><br>in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”;<br>example:<br><code>2019-11-15 12:57:46 +00:00</code>'
          nullable: true
        rating:
          type: object
          oneOf:
            - $ref: '#/components/schemas/RatingInfo'
          description: <em>the rating score submitted by the reviewer</em>
          nullable: true
    AmazonProductInfo:
      type: object
      properties:
        type:
          type: string
          description: type of element
          nullable: true
        rank_group:
          type: integer
          description: <em>position within a group of elements with identical <code>type</code> values</em><br>positions of elements with different <code>type</code> values are omitted from <code>rank_group</code>
          nullable: true
        rank_absolute:
          type: integer
          description: <em> absolute rank</em><br>absolute position among all the elements in the response array
          nullable: true
        position:
          type: string
          description: '<em>the alignment of the element in Amazon SERP</em><br>possible values:<br><code>left</code>, <code>right</code>'
          nullable: true
        xpath:
          type: string
          description: <em>the <a href="https://en.wikipedia.org/wiki/XPath">XPath</a> of the element</em>
          nullable: true
        title:
          type: string
          description: <em>product title</em>
          nullable: true
        details:
          type: string
          description: <em>product specs and other details</em>
          nullable: true
        image_url:
          type: string
          description: <em>the URL of the product image</em>
          nullable: true
        author:
          type: string
          description: <em>product brand name</em>
          nullable: true
        data_asin:
          type: string
          description: <em>ASIN of the product received in a POST array</em>
          nullable: true
        parent_asin:
          type: string
          description: <em><a href="https://sellercentral.amazon.com/gp/help/external/help.html?itemID=8831&amp;language=en-US&amp;ref=mpbc_200779220_cont_8831&amp;" target="_blank" rel="noopener noreferrer">parent ASIN</a> of the product</em>
          nullable: true
        product_asins:
          type: array
          items:
            type: string
            nullable: true
          description: <em>ASINs of all found product modifications</em>
          nullable: true
        price_from:
          type: number
          description: <em>the lower limit of the product price range</em><br>example:<br><code>49.98</code>
          nullable: true
        price_to:
          type: number
          description: <em>the upper limit of the product price range</em><br>example:<br><code>384.99</code>
          nullable: true
        percentage_discount:
          type: string
          description: <em>value of the percentage discount</em>
          nullable: true
        currency:
          type: string
          description: <em>currency in the <a href="https://en.wikipedia.org/wiki/ISO_4217">ISO</a> format</em><br>example:<br><code>USD</code>
          nullable: true
        is_amazon_choice:
          type: boolean
          description: '<em>"Amazon''s choice" label</em><br>if the value is <code>true</code>, the product is marked with the "Amazon''s choice" label'
          nullable: true
        rating:
          type: object
          oneOf:
            - $ref: '#/components/schemas/RatingElement'
          description: <em>product rating info</em>
          nullable: true
        is_newer_model_available:
          type: boolean
          description: <em>indicates whether the newer model of the product is available</em>
          nullable: true
        is_prime_video:
          type: boolean
          description: '<em>indicates whether a product has an Amazon Prime Video label</em><br>if <code>true</code>, specified product is a part of Amazon Prime Video service'
          nullable: true
        applicable_vouchers:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/AmazonApplicableVouchersItem'
            nullable: true
          description: <em>array of objects containing information about applicable vouchers</em>
          nullable: true
        newer_model:
          type: object
          oneOf:
            - $ref: '#/components/schemas/NewerModel'
          description: <em>information about the newer model of the product</em>
          nullable: true
        categories:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/Categories'
            nullable: true
          description: <em>contains related product categories</em>
          nullable: true
        product_information:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/BaseMerchantAmazonProductInformationElementItem'
            nullable: true
          description: <em>contains related product information</em>
          nullable: true
        product_images_list:
          type: array
          items:
            type: string
            nullable: true
          description: <em>contains URLs for all images of the product displayed on the left side of the main image</em>
          nullable: true
        product_videos_list:
          type: array
          items:
            type: string
            nullable: true
          description: <em>contains URLs for all videos of the product displayed on the right side of the main video</em>
          nullable: true
        description:
          type: string
          description: <em>contains description of the product</em>
          nullable: true
        is_available:
          type: boolean
          description: '<em>indicates whether the product is <a href="https://www.amazon.com/gp/help/customer/display.html?nodeId=201910280" rel="noopener noreferrer" target="_blank">available for ordering</a></em><br>if the value is <code>true</code>, the product can be ordered'
          nullable: true
        top_local_reviews:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/AmazonReviewItem'
            nullable: true
          description: <em>array of objects with top reviews from target location</em>
          nullable: true
        top_global_reviews:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/AmazonReviewItem'
            nullable: true
          description: <em>array of objects with top reviews from around the world</em>
          nullable: true
    MerchantAmazonAsinTaskGetAdvancedResultInfo:
      type: object
      properties:
        asin:
          type: string
          description: <em>ASIN received in a POST array</em><br>the unique product identifier in Amazon (ASIN) received in a POST array<br>learn more about the identified in <a href="https://dataforseo.com/help-center/asin-in-amazon-api" rel="noopener noreferrer" target="_blank">this help center guide</a>
          nullable: true
        type:
          type: string
          description: type of element
          nullable: true
        se_domain:
          type: string
          description: <em>Amazon domain in a POST array</em>
          nullable: true
        location_code:
          type: integer
          description: <em>location code in a POST array</em>
          nullable: true
        language_code:
          type: string
          description: <em>language code in a POST array</em>
          nullable: true
        check_url:
          type: string
          description: <em>direct URL to Amazon results</em><br>you can use it to make sure that we provided accurate results
          nullable: true
        datetime:
          type: string
          description: '<em>date and time when the result was received</em><br>in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”<br>example:<br><code class="long-string">2019-11-15 12:57:46 +00:00</code>'
          nullable: true
        item_types:
          type: array
          items:
            type: string
            nullable: true
          description: <em>types of search results found on Amazon</em><br>contains types of all search results (<code>items</code>) found in the returned SERP<br>possible item types:<br><code>amazon_product_info</code>
          nullable: true
        items_count:
          type: integer
          description: <em>the number of results returned in the <strong><code>items</code></strong> array</em>
          format: int64
          nullable: true
        items:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/AmazonProductInfo'
            nullable: true
          description: <em>Amazon product info items</em>
          nullable: true
    MerchantAmazonAsinTaskGetAdvancedTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/MerchantAmazonAsinTaskGetAdvancedResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    MerchantAmazonAsinTaskGetAdvancedResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/MerchantAmazonAsinTaskGetAdvancedTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    MerchantAmazonAsinLiveAdvancedRequestInfo:
      type: object
      properties:
        asin:
          type: string
          description: <em>product ID</em><br><strong>required field</strong><br><a href="https://dataforseo.com/help-center/asin-in-amazon-api" target="_blank" rel="noopener noreferrer">unique product identifier (ASIN)</a> in Amazon<br>you can receive the <code>asin</code> parameter by making a separate request to the <a href="/v3/merchant/amazon/products/live/advanced/" target="_blank" rel="noopener noreferrer">Amazon Products endpoint</a>
        location_name:
          type: string
          description: '<em>full name of search engine location</em><br><strong>required field if you don''t specify</strong> <code>location_code</code> or <code>location_coordinate</code><br><strong>if you use this field, you don''t need to specify <code>location_code</code> or <code>location_coordinate</code></strong><br>you can receive the list of available locations with their <code>location_name</code> parameters by making a separate request to the <code>https://api.dataforseo.com/v3/merchant/amazon/locations</code><br>example:<br><code class="long-string">HA1,England,United Kingdom</code>'
        location_code:
          type: integer
          description: '<em>search engine location code</em><br><strong>required field if you don''t specify</strong> <code>location_name</code> or <code>location_coordinate</code><br><strong>if you use this field, you don''t need to specify <code>location_name</code> or <code>location_coordinate</code></strong><br>you can receive the list of available locations with their <code>location_code</code> parameters by making a separate request to the<br><code>https://api.dataforseo.com/v3/merchant/amazon/locations</code><br>example:<br><code class="long-string">9045969</code>'
        location_coordinate:
          type: string
          description: '<em>GPS coordinates of a location</em><br><strong>required field if you don''t specify</strong> <code>location_name</code> or <code>location_code</code><br><strong>if you use this field, you don''t need to specify <code>location_name</code> or <code>location_code</code></strong><br><code>location_coordinate</code> parameter should be specified in the <em>"latitude,longitude,radius"</em> format<br>the maximum number of decimal digits for <em>"latitude"</em> and <em>"longitude"</em>: 7<br>the minimum value for <em>"radius"</em>: 199.9<br>example:<br><code class="long-string">53.476225,-2.243572,200</code>'
        language_name:
          type: string
          description: '<em>full name of search engine language</em><br><strong>required field if you don''t specify</strong> <code>language_code</code><br><strong>if you use this field, you don''t need to specify <code>language_code</code></strong><br>you can receive the list of available languages with their <code>language_name</code> parameters by making a separate request to the<br><code>https://api.dataforseo.com/v3/merchant/amazon/languages</code><br>example:<br><code class="long-string">English (United Kingdom)</code>'
        language_code:
          type: string
          description: '<em>search engine language code</em><br><strong>required field if you don''t specify</strong> <code>language_name</code><br><strong>if you use this field, you don''t need to specify <code>language_name</code></strong><br>you can receive the list of available languages with their <code>language_code</code> parameters by making a separate request to the <code>https://api.dataforseo.com/v3/merchant/amazon/languages</code><em><br></em>example:<em><br></em><code class="long-string">en_GB</code>'
        se_domain:
          type: string
          description: '<em>search engine domain</em><br>optional field<br>we choose the relevant search engine domain automatically according to the location and language you specify<br>however, you can set a custom search engine domain in this field<br>example:<br><em><code>amazon.com</code></em>, <em><code>amazon.co.uk</code></em>, <em><code>amazon.fr</code></em>, etc.'
          nullable: true
        tag:
          type: string
          description: <em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response
          nullable: true
      example:
        - language_code: en_US
          location_code: 2840
          asin: B0756FCPPN
    MerchantAmazonAsinLiveAdvancedResultInfo:
      type: object
      properties:
        asin:
          type: string
          description: <em>ASIN received in a POST array</em><br>the unique product identifier in Amazon (ASIN) received in a POST array<br>learn more about the identified in <a href="https://dataforseo.com/help-center/asin-in-amazon-api" rel="noopener noreferrer" target="_blank">this help center guide</a>
          nullable: true
        type:
          type: string
          description: type of element
          nullable: true
        se_domain:
          type: string
          description: <em>Amazon domain in a POST array</em>
          nullable: true
        location_code:
          type: integer
          description: <em>location code in a POST array</em>
          nullable: true
        language_code:
          type: string
          description: <em>language code in a POST array</em>
          nullable: true
        check_url:
          type: string
          description: <em>direct URL to Amazon results</em><br>you can use it to make sure that we provided accurate results
          nullable: true
        datetime:
          type: string
          description: '<em>date and time when the result was received</em><br>in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”<br>example:<br><code class="long-string">2019-11-15 12:57:46 +00:00</code>'
          nullable: true
        item_types:
          type: array
          items:
            type: string
            nullable: true
          description: <em>types of search results found on Amazon</em><br>contains types of all search results (<code>items</code>) found in the returned SERP<br>possible item types:<br><code>amazon_product_info</code>
          nullable: true
        items_count:
          type: integer
          description: <em>the number of results returned in the <strong><code>items</code></strong> array</em>
          format: int64
          nullable: true
        items:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/AmazonProductInfo'
            nullable: true
          description: <em>Amazon product info items</em>
          nullable: true
    MerchantAmazonAsinLiveAdvancedTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/MerchantAmazonAsinLiveAdvancedResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    MerchantAmazonAsinLiveAdvancedResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/MerchantAmazonAsinLiveAdvancedTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    MerchantAmazonAsinTaskGetHtmlResultInfo:
      type: object
      properties:
        asin:
          type: string
          description: <em>ASIN received in a POST array</em>
          nullable: true
        type:
          type: string
          description: type of element
          nullable: true
        se_domain:
          type: string
          description: <em>search engine domain in a POST array</em>
          nullable: true
        location_code:
          type: integer
          description: <em>location code in a POST array</em>
          nullable: true
        language_code:
          type: string
          description: <em>language code in a POST array</em>
          nullable: true
        datetime:
          type: string
          description: '<em>date and time when the result was received</em><br>in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”<br>example:<br><code class="long-string">2019-11-15 12:57:46 +00:00</code>'
          nullable: true
        items_count:
          type: integer
          description: <em>the number of results returned in the <strong><code>items</code></strong> array</em>
          format: int64
          nullable: true
        items:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/HtmlItemInfo'
            nullable: true
          description: <em>HTML pages and related data</em>
          nullable: true
    MerchantAmazonAsinTaskGetHtmlTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/MerchantAmazonAsinTaskGetHtmlResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    MerchantAmazonAsinTaskGetHtmlResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/MerchantAmazonAsinTaskGetHtmlTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    MerchantAmazonAsinLiveHtmlRequestInfo:
      type: object
      properties:
        asin:
          type: string
          description: <em>product ID</em><br><strong>required field</strong><br><a href="https://dataforseo.com/help-center/asin-in-amazon-api" target="_blank" rel="noopener noreferrer">unique product identifier (ASIN)</a> in Amazon<br>you can receive the <code>asin</code> parameter by making a separate request to the <a href="/v3/merchant/amazon/products/products/live/advanced/" target="_blank" rel="noopener noreferrer">Amazon Products endpoint</a>
        location_name:
          type: string
          description: '<em>full name of search engine location</em><br><strong>required field if you don''t specify</strong> <code>location_code</code> or <code>location_coordinate</code><br><strong>if you use this field, you don''t need to specify <code>location_code</code> or <code>location_coordinate</code></strong><br>you can receive the list of available locations with their <code>location_name</code> parameters by making a separate request to the <code>https://api.dataforseo.com/v3/merchant/amazon/locations</code><br>example:<br><code class="long-string">HA1,England,United Kingdom</code>'
        location_code:
          type: integer
          description: '<em>search engine location code</em><br><strong>required field if you don''t specify</strong> <code>location_name</code> or <code>location_coordinate</code><br><strong>if you use this field, you don''t need to specify <code>location_name</code> or <code>location_coordinate</code></strong><br>you can receive the list of available locations with their <code>location_code</code> parameters by making a separate request to the<br><code>https://api.dataforseo.com/v3/merchant/amazon/locations</code><br>example:<br><code class="long-string">9045969</code>'
        location_coordinate:
          type: string
          description: '<em>GPS coordinates of a location</em><br><strong>required field if you don''t specify</strong> <code>location_name</code> or <code>location_code</code><br><strong>if you use this field, you don''t need to specify <code>location_name</code> or <code>location_code</code></strong><br><code>location_coordinate</code> parameter should be specified in the <em>"latitude,longitude,radius"</em> format<br>the maximum number of decimal digits for <em>"latitude"</em> and <em>"longitude"</em>: 7<br>the minimum value for <em>"radius"</em>: 199.9<br>example:<br><code class="long-string">53.476225,-2.243572,200</code>'
        language_name:
          type: string
          description: '<em>full name of search engine language</em><br><strong>required field if you don''t specify</strong> <code>language_code</code><br><strong>if you use this field, you don''t need to specify <code>language_code</code></strong><br>you can receive the list of available languages with their <code>language_name</code> parameters by making a separate request to the<br><code>https://api.dataforseo.com/v3/merchant/amazon/languages</code><br>example:<br><code class="long-string">English (United Kingdom)</code>'
        language_code:
          type: string
          description: '<em>search engine language code</em><br><strong>required field if you don''t specify</strong> <code>language_name</code><br><strong>if you use this field, you don''t need to specify <code>language_name</code></strong><br>you can receive the list of available languages with their <code>language_code</code> parameters by making a separate request to the <code>https://api.dataforseo.com/v3/merchant/amazon/languages</code><em><br></em>example:<em><br></em><code class="long-string">en_GB</code>'
        se_domain:
          type: string
          description: '<em>search engine domain</em><br>optional field<br>we choose the relevant search engine domain automatically according to the location and language you specify<br>however, you can set a custom search engine domain in this field<br>example:<br><em><code>amazon.com</code></em>, <em><code>amazon.co.uk</code></em>, <em><code>amazon.fr</code></em>, etc.'
          nullable: true
        tag:
          type: string
          description: <em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response
          nullable: true
      example:
        - language_code: en_US
          location_code: 2840
          asin: B0756FCPPN
    MerchantAmazonAsinLiveHtmlResultInfo:
      type: object
      properties:
        asin:
          type: string
          description: <em>ASIN received in a POST array</em>
          nullable: true
        type:
          type: string
          description: type of element
          nullable: true
        se_domain:
          type: string
          description: <em>search engine domain in a POST array</em>
          nullable: true
        location_code:
          type: integer
          description: <em>location code in a POST array</em>
          nullable: true
        language_code:
          type: string
          description: <em>language code in a POST array</em>
          nullable: true
        datetime:
          type: string
          description: '<em>date and time when the result was received</em><br>in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”<br>example:<br><code class="long-string">2019-11-15 12:57:46 +00:00</code>'
          nullable: true
        items_count:
          type: integer
          description: <em>the number of results returned in the <strong><code>items</code></strong> array</em>
          format: int64
          nullable: true
        items:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/HtmlItemInfo'
            nullable: true
          description: <em>HTML pages and related data</em>
          nullable: true
    MerchantAmazonAsinLiveHtmlTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/MerchantAmazonAsinLiveHtmlResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    MerchantAmazonAsinLiveHtmlResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/MerchantAmazonAsinLiveHtmlTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    MerchantAmazonSellersTaskPostRequestInfo:
      type: object
      properties:
        asin:
          type: string
          description: <em>unique product identifier on Amazon</em><br><strong>required field</strong><br>you can get this value making a separate request to <a href="/v3/merchant/amazon/products/task_post">the Amazon Products endpoint</a><br>note that there is no full list of possible values as the <code>asin</code> values is a dynamic value assigned by Amazon<br>example:<br><code>B085RFFC9Q</code><br>learn more about the identifier in <a href="https://dataforseo.com/help-center/asin-in-amazon-api" rel="noopener noreferrer" target="_blank">this help center guide</a>
        priority:
          type: integer
          description: <em>task priority</em><br>optional field<br>can take the following values:<br>1 – normal execution priority (set by default)<br>2 – high execution priorityYou will be additionally charged for the tasks with high execution priority.<br>The cost can be calculated on the <a title="Pricing" href="https://dataforseo.com/pricing/merchant/amazon-api" target="_blank" rel="noopener noreferrer">Pricing</a> page.
          nullable: true
        location_name:
          type: string
          description: '<em>full name of the location</em><br><strong>required field if you don''t specify</strong> <code>location_code</code> or <code>location_coordinate</code><br><strong>if you use this field, you don''t need to specify <code>location_code</code> or <code>location_coordinate</code></strong><br>you can receive the list of available Amazon locations with their <code>location_name</code> by making a separate request to the <code>https://api.dataforseo.com/v3/merchant/amazon/locations</code><br>example:<br><code class="long-string">London,England,United Kingdom</code>'
        location_code:
          type: integer
          description: '<em>location code</em><br><strong>required field if you don''t specify</strong> <code>location_name</code>_or <code>location_coordinate</code><br><strong>if you use this field, you don''t need to specify <code>location_name</code> or <code>location_coordinate</code></strong><br>you can receive the list of available Amazon locations with their <code>location_code</code> by making a separate request to the <code>https://api.dataforseo.com/v3/merchant/amazon/locations</code><br>example:<br><code class="long-string">2840</code>'
        location_coordinate:
          type: string
          description: '<em>GPS coordinates of a location</em><br><strong>required field if you don''t specify</strong> <code>location_name</code>_or <code>location_code</code><br><strong>if you use this field, you don''t need to specify <code>location_name</code> or <code>location_code</code></strong><br><code>location_coordinate</code> parameter should be specified in the <em>"latitude,longitude,radius"</em> format<br>the maximum number of decimal digits for <em>"latitude"</em> and <em>"longitude"</em>: 7<br>the minimum value for <em>"radius"</em>: 199.9<br>example:<br><code class="long-string">53.476225,-2.243572,200</code>'
        language_name:
          type: string
          description: '<em>full name of the language</em><br><strong>required field if you don''t specify</strong> <code>language_code</code><br><strong>if you use this field, you don''t need to specify <code>language_code</code></strong><br>you can receive the list of available Amazon languages with their <code>language_name</code> by making a separate request to the <code>https://api.dataforseo.com/v3/merchant/amazon/languages</code><br>example:<br><code class="long-string">English (United States)</code>'
        language_code:
          type: string
          description: '<em>language code</em><br><strong>required field if you don''t specify</strong> <code>language_name</code><br><strong>if you use this field, you don''t need to specify <code>language_name</code></strong><br>you can receive the list of available Amazon languages with their <code>language_code</code> by making a separate request to the <code>https://api.dataforseo.com/v3/merchant/amazon/languages</code><em><br></em>example:<em><br></em><code class="long-string">en_US</code>'
        se_domain:
          type: string
          description: '<em>search engine domain</em><br>optional field<br>we choose the relevant search engine domain automatically according to the location and language you specify<br>however, you can set a custom search engine domain in this field<br>example:<br><em><code>amazon.co.uk</code></em>, <em><code>amazon.com.au</code></em>, <em><code>amazon.de</code></em>, etc.'
          nullable: true
        tag:
          type: string
          description: <em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response
          nullable: true
        postback_url:
          type: string
          description: '<em>URL for sending task results</em><br>optional field<br>once the task is completed, we will send a POST request with its results compressed in the <code>gzip</code> format to the <code>postback_url</code> you specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/postbackscript?id=$id</code><br><code>http://your-server.com/postbackscript?id=$id&amp;tag=$tag</code><br><strong>Note:</strong> special characters in <code>postback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href="https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api" target="_blank" rel="noopener noreferrer">Help Center</a>'
          nullable: true
        postback_data:
          type: string
          description: '<em>postback_url datatype</em><br><strong>required field if you specify <code>postback_url</code></strong><br>corresponds to the datatype that will be sent to your server<br>possible values:<br><code>advanced</code>, <code>html</code>'
        pingback_url:
          type: string
          description: '<em>notification URL of a completed task</em><br>optional field<br>when a task is completed we will notify you by GET request sent to the URL you have specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/pingscript?id=$id</code><br><code>http://your-server.com/pingscript?id=$id&amp;tag=$tag</code><br><strong>Note:</strong> special characters in <code>pingback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href="https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api" target="_blank" rel="noopener noreferrer">Help Center</a>'
          nullable: true
      example:
        - language_code: en
          location_code: 2840
          asin: B085RFFC9Q
    MerchantAmazonSellersTaskPostTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: object
              description: '<em>array of results</em><br>in this case, the value will be <code>null</code>'
              nullable: true
    MerchantAmazonSellersTaskPostResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/MerchantAmazonSellersTaskPostTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    MerchantAmazonSellersTasksReadyResultInfo:
      type: object
      properties:
        id:
          type: string
          description: <em>task identifier of the completed task</em><br><strong>unique task identifier in our system in the <a href="https://en.wikipedia.org/wiki/Universally_unique_identifier">UUID</a> format</strong>
          nullable: true
        se:
          type: string
          description: <em>search engine specified when setting the task</em>
          nullable: true
        se_type:
          type: string
          description: <em>type of search engine</em>
          nullable: true
        date_posted:
          type: string
          description: <em>date when the task was posted (in the UTC format)</em>
          nullable: true
        tag:
          type: string
          description: <em>user-defined task identifier</em>
          nullable: true
        endpoint_advanced:
          type: string
          description: <em>URL for collecting the results of Amazon Sellers Advanced task</em>
          nullable: true
        endpoint_html:
          type: string
          description: <em>URL for collecting the results of Amazon Sellers HTML task</em>
          nullable: true
    MerchantAmazonSellersTasksReadyTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/MerchantAmazonSellersTasksReadyResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    MerchantAmazonSellersTasksReadyResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/MerchantAmazonSellersTasksReadyTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    MerchantAmazonSellerMainItemSerpElementItem:
      type: object
      allOf:
        - type: object
          oneOf:
            - $ref: '#/components/schemas/BaseMerchantAmazonSellersElementItem'
          nullable: true
        - type: object
    MerchantAmazonSellerItemSerpElementItem:
      type: object
      allOf:
        - type: object
          oneOf:
            - $ref: '#/components/schemas/BaseMerchantAmazonSellersElementItem'
          nullable: true
        - type: object
    MerchantAmazonSellersTaskGetAdvancedResultInfo:
      type: object
      properties:
        asin:
          type: string
          description: <em><code>asin</code> received in a POST array</em><br>learn more about ASINs in <a href="https://dataforseo.com/help-center/asin-in-amazon-api" rel="noopener noreferrer" target="_blank">this help center guide</a>
          nullable: true
        type:
          type: string
          description: type of element
          nullable: true
        se_domain:
          type: string
          description: <em>search engine domain received in a POST array</em>
          nullable: true
        location_code:
          type: integer
          description: <em>location code received in a POST array</em>
          nullable: true
        language_code:
          type: string
          description: <em>language code received in a POST array</em>
          nullable: true
        check_url:
          type: string
          description: <em>direct URL to Amazon results</em><br>you can use it to make sure the provided results are accurate
          nullable: true
        datetime:
          type: string
          description: '<em>date and time when the result was received</em><br>in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”<br>example:<br><code class="long-string">2019-11-15 12:57:46 +00:00</code>'
          nullable: true
        title:
          type: string
          description: <em>product title</em><br>title of the product relevant to the <code>asin</code> received in a POST array
          nullable: true
        image:
          type: string
          description: <em>product image url</em><br>image URL of the product relevant to the <code>asin</code> received in a POST array
          nullable: true
        item_types:
          type: array
          items:
            type: string
            nullable: true
          description: '<em>types of search results found in Amazon Sellers SERP</em><br>contains types of all search results (<code>items</code>) found in the returned SERP<br>possible item types:<br><code>amazon_seller_main_item</code>, <code>amazon_seller_item</code>'
          nullable: true
        items_count:
          type: integer
          description: <em>the number of results returned in the <strong><code>items</code></strong> array</em>
          format: int64
          nullable: true
        items:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/BaseMerchantAmazonSellersElementItem'
            nullable: true
          description: <em>items in SERP</em>
          nullable: true
    MerchantAmazonSellersTaskGetAdvancedTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/MerchantAmazonSellersTaskGetAdvancedResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    MerchantAmazonSellersTaskGetAdvancedResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/MerchantAmazonSellersTaskGetAdvancedTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    MerchantAmazonSellersLiveAdvancedRequestInfo:
      type: object
      properties:
        asin:
          type: string
          description: <em>unique product identifier on Amazon</em><br><strong>required field</strong><br>you can get this value making a separate request to <a href="/v3/merchant/amazon/products/task_post">the Amazon Products endpoint</a><br>note that there is no full list of possible values as the <code>asin</code> values is a dynamic value assigned by Amazon<br>example:<br><code>B085RFFC9Q</code><br>learn more about the identifier in <a href="https://dataforseo.com/help-center/asin-in-amazon-api" rel="noopener noreferrer" target="_blank">this help center guide</a>
        location_name:
          type: string
          description: '<em>full name of the location</em><br><strong>required field if you don''t specify</strong> <code>location_code</code> or <code>location_coordinate</code><br><strong>if you use this field, you don''t need to specify <code>location_code</code> or <code>location_coordinate</code></strong><br>you can receive the list of available Amazon locations with their <code>location_name</code> by making a separate request to the <code>https://api.dataforseo.com/v3/merchant/amazon/locations</code><br>example:<br><code class="long-string">London,England,United Kingdom</code>'
        location_code:
          type: integer
          description: '<em>location code</em><br><strong>required field if you don''t specify</strong> <code>location_name</code> or <code>location_coordinate</code><br><strong>if you use this field, you don''t need to specify <code>location_name</code> or <code>location_coordinate</code></strong><br>you can receive the list of available Amazon locations with their <code>location_code</code> by making a separate request to the <code>https://api.dataforseo.com/v3/merchant/amazon/locations</code><br>example:<br><code class="long-string">2840</code>'
        location_coordinate:
          type: string
          description: '<em>GPS coordinates of a location</em><br><strong>required field if you don''t specify</strong> <code>location_name</code> or <code>location_code</code><br><strong>if you use this field, you don''t need to specify <code>location_name</code> or <code>location_code</code></strong><br><code>location_coordinate</code> parameter should be specified in the <em>"latitude,longitude,radius"</em> format<br>the maximum number of decimal digits for <em>"latitude"</em> and <em>"longitude"</em>: 7<br>the minimum value for <em>"radius"</em>: 199.9<br>example:<br><code class="long-string">53.476225,-2.243572,200</code>'
        language_name:
          type: string
          description: '<em>full name of the language</em><br><strong>required field if you don''t specify</strong> <code>language_code</code><br><strong>if you use this field, you don''t need to specify <code>language_code</code></strong><br>you can receive the list of available Amazon languages with their <code>language_name</code> by making a separate request to the <code>https://api.dataforseo.com/v3/merchant/amazon/languages</code><br>example:<br><code class="long-string">English (United States)</code>'
        language_code:
          type: string
          description: '<em>language code</em><br><strong>required field if you don''t specify</strong> <code>language_name</code><br><strong>if you use this field, you don''t need to specify <code>language_name</code></strong><br>you can receive the list of available Amazon languages with their <code>language_code</code> by making a separate request to the <code>https://api.dataforseo.com/v3/merchant/amazon/languages</code><em><br></em>example:<em><br></em><code class="long-string">en_US</code>'
        se_domain:
          type: string
          description: '<em>search engine domain</em><br>optional field<br>we choose the relevant search engine domain automatically according to the location and language you specify<br>however, you can set a custom search engine domain in this field<br>example:<br><em><code>amazon.co.uk</code></em>, <em><code>amazon.com.au</code></em>, <em><code>amazon.de</code></em>, etc.'
          nullable: true
        tag:
          type: string
          description: <em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response
          nullable: true
      example:
        - language_code: en_US
          location_code: 2840
          asin: B07D528W98
    MerchantAmazonSellersLiveAdvancedResultInfo:
      type: object
      properties:
        asin:
          type: string
          description: <em><code>asin</code> received in a POST array</em><br>learn more about ASINs in <a href="https://dataforseo.com/help-center/asin-in-amazon-api" rel="noopener noreferrer" target="_blank">this help center guide</a>
          nullable: true
        type:
          type: string
          description: type of element
          nullable: true
        se_domain:
          type: string
          description: <em>search engine domain received in a POST array</em>
          nullable: true
        location_code:
          type: integer
          description: <em>location code received in a POST array</em>
          nullable: true
        language_code:
          type: string
          description: <em>language code received in a POST array</em>
          nullable: true
        check_url:
          type: string
          description: <em>direct URL to Amazon results</em><br>you can use it to make sure the provided results are accurate
          nullable: true
        datetime:
          type: string
          description: '<em>date and time when the result was received</em><br>in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”<br>example:<br><code class="long-string">2019-11-15 12:57:46 +00:00</code>'
          nullable: true
        title:
          type: string
          description: <em>product title</em><br>title of the product relevant to the <code>asin</code> received in a POST array
          nullable: true
        image:
          type: string
          description: <em>product image url</em><br>image URL of the product relevant to the <code>asin</code> received in a POST array
          nullable: true
        item_types:
          type: array
          items:
            type: string
            nullable: true
          description: '<em>types of search results found in Amazon Sellers SERP</em><br>contains types of all search results (<code>items</code>) found in the returned SERP<br>possible item types:<br><code>amazon_seller_main_item</code>, <code>amazon_seller_item</code>'
          nullable: true
        items_count:
          type: integer
          description: <em>the number of results returned in the <strong><code>items</code></strong> array</em>
          format: int64
          nullable: true
        items:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/BaseMerchantAmazonSellersElementItem'
            nullable: true
          description: <em>items in SERP</em>
          nullable: true
    MerchantAmazonSellersLiveAdvancedTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/MerchantAmazonSellersLiveAdvancedResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    MerchantAmazonSellersLiveAdvancedResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/MerchantAmazonSellersLiveAdvancedTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    MerchantAmazonSellersTaskGetHtmlResultInfo:
      type: object
      properties:
        asin:
          type: string
          description: <em>ASIN received in a POST array </em>
          nullable: true
        type:
          type: string
          description: type of element
          nullable: true
        se_domain:
          type: string
          description: <em>search engine domain in a POST array</em>
          nullable: true
        location_code:
          type: integer
          description: <em>location code in a POST array</em>
          nullable: true
        language_code:
          type: string
          description: <em>language code in a POST array</em>
          nullable: true
        datetime:
          type: string
          description: '<em>date and time when the result was received</em><br>in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”<br>example:<br><code class="long-string">2019-11-15 12:57:46 +00:00</code>'
          nullable: true
        items_count:
          type: integer
          description: <em>the number of results returned in the <strong><code>items</code></strong> array</em>
          format: int64
          nullable: true
        items:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/HtmlItemInfo'
            nullable: true
          description: <em>elements of search results found on Amazon</em>
          nullable: true
    MerchantAmazonSellersTaskGetHtmlTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/MerchantAmazonSellersTaskGetHtmlResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    MerchantAmazonSellersTaskGetHtmlResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/MerchantAmazonSellersTaskGetHtmlTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    MerchantAmazonSellersLiveHtmlRequestInfo:
      type: object
      properties:
        asin:
          type: string
          description: <em>unique product identifier on Amazon</em><br><strong>required field</strong><br>you can get this value making a separate request to <a href="/v3/merchant/amazon/products/task_post">the Amazon Products endpoint</a><br>note that there is no full list of possible values as the <code>asin</code> values is a dynamic value assigned by Amazon<br>example:<br><code>B085RFFC9Q</code><br>learn more about the identifier in <a href="https://dataforseo.com/help-center/asin-in-amazon-api" rel="noopener noreferrer" target="_blank">this help center guide</a>
        location_name:
          type: string
          description: '<em>full name of the location</em><br><strong>required field if you don''t specify</strong> <code>location_code</code> or <code>location_coordinate</code><br><strong>if you use this field, you don''t need to specify <code>location_code</code> or <code>location_coordinate</code></strong><br>you can receive the list of available Amazon locations with their <code>location_name</code> by making a separate request to the <code>https://api.dataforseo.com/v3/merchant/amazon/locations</code><br>example:<br><code class="long-string">London,England,United Kingdom</code>'
        location_code:
          type: integer
          description: '<em>location code</em><br><strong>required field if you don''t specify</strong> <code>location_name</code> or <code>location_coordinate</code><br><strong>if you use this field, you don''t need to specify <code>location_name</code> or <code>location_coordinate</code></strong><br>you can receive the list of available Amazon locations with their <code>location_code</code> by making a separate request to the <code>https://api.dataforseo.com/v3/merchant/amazon/locations</code><br>example:<br><code class="long-string">2840</code>'
        location_coordinate:
          type: string
          description: '<em>GPS coordinates of a location</em><br><strong>required field if you don''t specify</strong> <code>location_name</code> or <code>location_code</code><br><strong>if you use this field, you don''t need to specify <code>location_name</code> or <code>location_code</code></strong><br><code>location_coordinate</code> parameter should be specified in the <em>"latitude,longitude,radius"</em> format<br>the maximum number of decimal digits for <em>"latitude"</em> and <em>"longitude"</em>: 7<br>the minimum value for <em>"radius"</em>: 199.9<br>example:<br><code class="long-string">53.476225,-2.243572,200</code>'
        language_name:
          type: string
          description: '<em>full name of the language</em><br><strong>required field if you don''t specify</strong> <code>language_code</code><br><strong>if you use this field, you don''t need to specify <code>language_code</code></strong><br>you can receive the list of available Amazon languages with their <code>language_name</code> by making a separate request to the <code>https://api.dataforseo.com/v3/merchant/amazon/languages</code><br>example:<br><code class="long-string">English (United States)</code>'
        language_code:
          type: string
          description: '<em>language code</em><br><strong>required field if you don''t specify</strong> <code>language_name</code><br><strong>if you use this field, you don''t need to specify <code>language_name</code></strong><br>you can receive the list of available Amazon languages with their <code>language_code</code> by making a separate request to the <code>https://api.dataforseo.com/v3/merchant/amazon/languages</code><em><br></em>example:<em><br></em><code class="long-string">en_US</code>'
        se_domain:
          type: string
          description: '<em>search engine domain</em><br>optional field<br>we choose the relevant search engine domain automatically according to the location and language you specify<br>however, you can set a custom search engine domain in this field<br>example:<br><em><code>amazon.co.uk</code></em>, <em><code>amazon.com.au</code></em>, <em><code>amazon.de</code></em>, etc.'
          nullable: true
        tag:
          type: string
          description: <em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response
          nullable: true
      example:
        - language_code: en_US
          location_code: 2840
          asin: B085RFFC9Q
    MerchantAmazonSellersLiveHtmlResultInfo:
      type: object
      properties:
        asin:
          type: string
          description: <em>ASIN received in a POST array </em>
          nullable: true
        type:
          type: string
          description: type of element
          nullable: true
        se_domain:
          type: string
          description: <em>search engine domain in a POST array</em>
          nullable: true
        location_code:
          type: integer
          description: <em>location code in a POST array</em>
          nullable: true
        language_code:
          type: string
          description: <em>language code in a POST array</em>
          nullable: true
        datetime:
          type: string
          description: '<em>date and time when the result was received</em><br>in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”<br>example:<br><code class="long-string">2019-11-15 12:57:46 +00:00</code>'
          nullable: true
        items_count:
          type: integer
          description: <em>the number of results returned in the <strong><code>items</code></strong> array</em>
          format: int64
          nullable: true
        items:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/HtmlItemInfo'
            nullable: true
          description: <em>elements of search results found on Amazon</em>
          nullable: true
    MerchantAmazonSellersLiveHtmlTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/MerchantAmazonSellersLiveHtmlResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    MerchantAmazonSellersLiveHtmlResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/MerchantAmazonSellersLiveHtmlTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    AppDataIdListRequestInfo:
      type: object
      properties:
        datetime_from:
          type: string
          description: '<em>start time for filtering results</em><br><strong>required field</strong><br>if <code>include_metadata</code> is set to <code>true</code>, maximum value: a month from current datetime;<br>if <code>include_metadata</code> is set to <code>false</code>, maximum value: six months from current datetime;<br>must be specified in the UTC format: "yyyy-mm-dd hh-mm-ss +00:00"<br>example:<br><code>2023-01-15 12:57:46 +00:00</code>'
        datetime_to:
          type: string
          description: '<em>finish time for filtering results</em><br><strong>required field</strong><br>maximum value: current datetime;<br>must be specified in the UTC format: "yyyy-mm-dd hh-mm-ss +00:00"<br>example:<br><code>2023-01-31 13:57:46 +00:00</code>'
        limit:
          type: integer
          description: '<em>the maximum number of returned task IDs</em><br>optional field<br>default value: <code>1000</code><br>maximum value: <code>1000</code>'
          nullable: true
        offset:
          type: integer
          description: '<em>offset in the results array of returned task IDs</em><br>optional field<br>default value: <code>0</code><br>if you specify the <code>10</code> value, the first ten tasks in the results array will be omitted'
          nullable: true
        sort:
          type: string
          description: '<em>sorting by task execution time</em><br>optional field<br>possible values: <code>"asc"</code>, <code>"desc"</code><br>default value: <code>"asc"</code>'
          nullable: true
        include_metadata:
          type: boolean
          description: '<em>include task metadata in the respond</em><br>optional field<br>default value: <code>false</code>'
          nullable: true
      example:
        - datetime_from: '2026-09-10 11:12:35'
          datetime_to: '2026-09-20 11:12:35'
          limit: 10
          include_metadata: true
    AppDataIdListResultInfo:
      type: object
      properties:
        id:
          type: string
          description: <em>task identifier</em><br><strong>unique task identifier in our system in the <a href="https://en.wikipedia.org/wiki/Universally_unique_identifier">UUID</a> format</strong>
          nullable: true
        url:
          type: string
          description: <em>URL of the task</em><br>URL you used for making an API call
          nullable: true
        datetime_posted:
          type: string
          description: '<em>date and time when the task was made</em><br>in the UTC format: "yyyy-mm-dd hh-mm-ss +00:00"<br>example:<br><code>2023-01-15 12:57:46 +00:00</code>'
          nullable: true
        datetime_done:
          type: string
          description: '<em>date and time when the task was completed</em><br>in the UTC format: "yyyy-mm-dd hh-mm-ss +00:00"<br>example:<br><code>2023-01-15 12:57:46 +00:00</code>'
          nullable: true
        status:
          type: string
          description: <em>informational message of the task</em><br>you can find the full list of general informational messages <a href="/v3/appendix-errors/">here</a>
          nullable: true
        cost:
          type: number
          description: '<em>total tasks cost, USD</em>'
          nullable: true
        metadata:
          type: object
          additionalProperties:
            type: object
            nullable: true
          description: <em>contains parameters you specified in the POST request</em>
          nullable: true
    AppDataIdListTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AppDataIdListResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    AppDataIdListResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AppDataIdListTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    AppDataErrorsRequestInfo:
      type: object
      properties:
        limit:
          type: integer
          description: '<em>the maximum number of returned tasks that responded with an error</em><br>optional field<br>default value: <code>1000</code><br>maximum value: <code>1000</code>'
          nullable: true
        offset:
          type: integer
          description: '<em>offset in the results array of returned tasks</em><br>optional field<br>default value: <code>0</code><br>if you specify the <code>10</code> value, the first ten tasks in the results array will be omitted and the data will be provided for the successive tasks'
          nullable: true
        filtered_function:
          type: string
          description: '<em>return tasks with a certain function</em><br>use this field to obtain a list of tasks that returned an error filtered by a certain function<br>you can filter the results by the values you receive in the <code>function</code> fields of the API response<br>i.e., once you receive unfiltered results, you can call this API again to filter them by <code>function</code> <br>example: <code>app_data/task_get/advanced</code>, <code>postback_url</code>, <code>pingback_url</code>'
          nullable: true
        datetime_from:
          type: string
          description: '<em>start time for filtering results</em><br>optional field<br>allows filtering results by the <code>datetime</code> parameter within the range of the last 7 days;<br>must be specified in the UTC format: "yyyy-mm-dd hh-mm-ss +00:00"<br>example:<br><code>2021-11-15 12:57:46 +00:00</code>'
          nullable: true
        datetime_to:
          type: string
          description: '<em>finish time for filtering results</em><br>optional field<br>allows filtering results by the <code>datetime</code> parameter within the range of the last 7 days;<br>must be specified in the UTC format: "yyyy-mm-dd hh-mm-ss +00:00"<br>example:<br><code>2021-11-15 13:57:46 +00:00</code>'
          nullable: true
      example:
        - limit: 10
    AppDataErrorsResultInfo:
      type: object
      properties:
        id:
          type: string
          description: <em>task identifier</em><br><strong>unique task identifier in our system in the <a href="https://en.wikipedia.org/wiki/Universally_unique_identifier">UUID</a> format</strong>
          nullable: true
        datetime:
          type: string
          description: '<em>date and time when an error occurred</em><br>in the UTC format: "yyyy-mm-dd hh-mm-ss +00:00"<br>example:<br><code>2019-11-15 12:57:46 +00:00</code>'
          nullable: true
        function:
          type: string
          description: <em>corresponding API function</em>
          nullable: true
        error_code:
          type: integer
          description: <em>error code</em>
          nullable: true
        error_message:
          type: string
          description: <em>error message or error URL</em><br>error message <a href="https://docs.dataforseo.com/v3/appendix/errors/" rel="noopener noreferrer" target="_blank">(see full list)</a> or URL that caused an error
          nullable: true
        http_url:
          type: string
          description: <em>URL that caused an error</em><br>URL you used for making an API call or pingback/postback URL
          nullable: true
        http_method:
          type: string
          description: <em>HTTP method</em>
          nullable: true
        http_code:
          type: integer
          description: <em>HTTP status code</em>
          nullable: true
        http_time:
          type: number
          description: '<em>time taken by HTTP request</em><br>for tasks set with a pingback/postback, this field will show the time it took your server to respond'
          nullable: true
        http_response:
          type: string
          description: <em>HTTP response</em><br>server response
          nullable: true
    AppDataErrorsTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AppDataErrorsResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    AppDataErrorsResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AppDataErrorsTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    AppDataGoogleCategoriesResultInfo:
      type: object
      properties:
        categories:
          type: array
          items:
            type: string
            nullable: true
          description: <em>contains full list of supported app categories</em>
          nullable: true
    AppDataGoogleCategoriesTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AppDataGoogleCategoriesResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    AppDataGoogleCategoriesResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AppDataGoogleCategoriesTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    AppDataGoogleLocationsResultInfo:
      type: object
      properties:
        location_code:
          type: integer
          description: <em>location code</em>
          nullable: true
        location_name:
          type: string
          description: <em>full name of the location</em>
          nullable: true
        location_name_parent:
          type: string
          description: '<em>the name of the superordinate location</em><br>example:<br><code>"location_code": 1006473,<br>"location_name": "Altrincham,England,United Kingdom",<br>"location_name_parent": "England,United Kingdom",</code> where <code>location_name_parent</code> corresponds to:<p><code>"location_code": 20339,<br>"location_name": "England,United Kingdom"</code>'
          nullable: true
        country_iso_code:
          type: string
          description: <em>ISO country code of the location</em>
          nullable: true
        location_type:
          type: string
          description: <em>location type</em>
          nullable: true
    AppDataGoogleLocationsTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AppDataGoogleLocationsResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    AppDataGoogleLocationsResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AppDataGoogleLocationsTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    AppDataGoogleLocationsCountryResultInfo:
      type: object
      properties:
        location_code:
          type: integer
          description: <em>location code</em>
          nullable: true
        location_name:
          type: string
          description: <em>full name of the location</em>
          nullable: true
        location_name_parent:
          type: string
          description: '<em>the name of the superordinate location</em><br>example:<br><code>"location_code": 1006473,<br>"location_name": "Altrincham,England,United Kingdom",<br>"location_name_parent": "England,United Kingdom",</code> where <code>location_name_parent</code> corresponds to:<p><code>"location_code": 20339,<br>"location_name": "England,United Kingdom"</code>'
          nullable: true
        country_iso_code:
          type: string
          description: <em>ISO country code of the location</em>
          nullable: true
        location_type:
          type: string
          description: <em>location type</em>
          nullable: true
    AppDataGoogleLocationsCountryTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AppDataGoogleLocationsCountryResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    AppDataGoogleLocationsCountryResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AppDataGoogleLocationsCountryTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    AppDataGoogleLanguagesResultInfo:
      type: object
      properties:
        language_name:
          type: string
          description: <em>language name</em>
          nullable: true
        language_code:
          type: string
          description: <em>language code according to <a href="https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes" target="_blank" rel="noopener noreferrer">ISO 639-1</a></em>
          nullable: true
    AppDataGoogleLanguagesTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AppDataGoogleLanguagesResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    AppDataGoogleLanguagesResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AppDataGoogleLanguagesTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    AppDataGoogleAppSearchesTaskPostRequestInfo:
      type: object
      properties:
        keyword:
          type: string
          description: '<em>keyword</em><br><strong>required field</strong><br>you can specify <strong>up to 700 characters</strong> in the <code>keyword</code> field;<br>all %## will be decoded (plus character ‘+’ will be decoded to a space character);<br>if you need to use the “%” character for your <code>keyword</code>, please specify it as “%25”;<br>if you need to use the “+” character for your <code>keyword</code>, please specify it as “%2B”<p>learn more about rules and limitations of <code>keyword</code> and <code>keywords</code> fields in DataForSEO APIs in this <a href="https://dataforseo.com/help-center/rules-and-limitations-of-keyword-and-keywords-fields-in-dataforseo-apis" rel="noopener noreferrer" target="_blank">Help Center article</a>'
        location_name:
          type: string
          description: '<em>full name of search engine location</em><br><strong>required field if you don''t specify <code>location_code</code></strong><br><strong>if you use this field, you don''t need to specify <code>location_code</code></strong><br>you can receive the list of available locations of the search engine with their <code>location_name</code> by making a separate request to <code>https://api.dataforseo.com/v3/app_data/google/locations</code><br>example:<br><code class="long-string">West Los Angeles,California,United States</code>'
        location_code:
          type: integer
          description: '<em>search engine location code</em><br><strong>required field if you don''t specify <code>location_name</code></strong><br><strong>if you use this field, you don''t need to specify <code>location_name</code></strong><br>you can receive the list of available locations of the search engine with their <code>location_code</code> by making a separate request to <code>https://api.dataforseo.com/v3/app_data/google/locations</code><br>example:<br><code class="long-string">9061121</code>'
        language_name:
          type: string
          description: '<em>full name of search engine language</em><br>optional field<br><strong>if you use this field, you don''t need to specify <code>language_code</code></strong><br>you can receive the list of available languages with <code>language_name</code> by making a separate request to <code>https://api.dataforseo.com/v3/app_data/google/languages</code><br>example:<br><code class="long-string">English</code>'
          nullable: true
        language_code:
          type: string
          description: '<em>search engine language code</em><br>optional field<br><strong>if you use this field, you don''t need to specify <code>language_name</code></strong><br>you can receive the list of available languages with their <code>language_code</code> by making a separate request to <code>https://api.dataforseo.com/v3/app_data/google/languages</code><em><br></em>example:<em><br></em><code class="long-string">en</code>'
          nullable: true
        priority:
          type: integer
          description: <em>task priority</em><br>optional field<br>can take the following values:<br>1 – normal execution priority (set by default)<br>2 – high execution priorityYou will be additionally charged for the tasks with high execution priority.<br>The cost can be calculated on the <a title="Pricing" href="https://dataforseo.com/pricing/api/google-play" target="_blank" rel="noopener noreferrer">Pricing</a> page.
          nullable: true
        depth:
          type: integer
          description: '<em>parsing depth</em><br>optional field<br>number of results to be returned to be returned from the Google Play SERP;<br>we strongly recommend setting the parsing depth in the multiples of 30, because our system processes 30 results in a row;<br>default value: <code>30</code>;<br>maximum value: <code>200</code>;<br><strong>Your account will be billed per each SERP containing up to 30 results;</strong> <br>Setting depth above 30 may result in additional charges if the search engine returns more than 30 results</a>;<br>The cost can be calculated on the <a title="Pricing" href="https://dataforseo.com/pricing/app-data/google-play" target="_blank" rel="noopener noreferrer">Pricing</a> page.'
          nullable: true
        tag:
          type: string
          description: <em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response
          nullable: true
        postback_url:
          type: string
          description: '<em>URL for sending task results</em><br>optional field<br>once the task is completed, we will send a POST request with its results compressed in the <code>gzip</code> format to the <code>postback_url</code> you specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/postbackscript?id=$id</code><br><code>http://your-server.com/postbackscript?id=$id&amp;tag=$tag</code><br><strong>Note:</strong> special characters in <code>postback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code>'
          nullable: true
        postback_data:
          type: string
          description: '<em>postback_url datatype</em><br><strong>required field if you specify <code>postback_url</code></strong><br>corresponds to the datatype that will be sent to your server<br>possible values:<br><code>advanced</code>, <code>html</code>'
        pingback_url:
          type: string
          description: '<em>notification URL of a completed task</em><br>optional field<br>when a task is completed we will notify you by GET request sent to the URL you have specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/pingscript?id=$id</code><br><code>http://your-server.com/pingscript?id=$id&amp;tag=$tag</code><br><strong>Note:</strong> special characters in <code>pingback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code>'
          nullable: true
      example:
        - keyword: vpn
          location_code: 2840
          language_code: en
          depth: 30
    AppDataGoogleAppSearchesTaskPostTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: object
              description: '<em>array of results</em><br>in this case, the value will be <code>null</code>'
              nullable: true
    AppDataGoogleAppSearchesTaskPostResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AppDataGoogleAppSearchesTaskPostTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    AppDataGoogleAppSearchesTasksReadyResultInfo:
      type: object
      properties:
        id:
          type: string
          description: <em>task identifier of the completed task</em><br><strong>unique task identifier in our system in the <a href="https://en.wikipedia.org/wiki/Universally_unique_identifier">UUID</a> format</strong>
          nullable: true
        se:
          type: string
          description: <em>search engine specified when setting the task</em>
          nullable: true
        se_type:
          type: string
          description: <em>search engine type</em>
          nullable: true
        date_posted:
          type: string
          description: <em>date when the task was posted (in the UTC format)</em>
          nullable: true
        tag:
          type: string
          nullable: true
        endpoint_advanced:
          type: string
          description: '<em>URL for collecting the results of the {{up_se_name}} {{normal_se_type}} task</em>'
          nullable: true
        endpoint_html:
          type: string
          description: '<em>URL for collecting the results of the {{up_se_name}} {{normal_se_type}} HTML task</em><br>if HTML tasks are not supported in the specified endpoint, the value will be <code>null</code>'
          nullable: true
    AppDataGoogleAppSearchesTasksReadyTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AppDataGoogleAppSearchesTasksReadyResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    AppDataGoogleAppSearchesTasksReadyResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AppDataGoogleAppSearchesTasksReadyTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    AppDataTasksReadyResultInfo:
      type: object
      properties:
        id:
          type: string
          description: <em>task identifier of the completed task</em><br><strong>unique task identifier in our system in the <a href="https://en.wikipedia.org/wiki/Universally_unique_identifier">UUID</a> format</strong>
          nullable: true
        se:
          type: string
          description: <em>search engine specified when setting the task</em>
          nullable: true
        se_type:
          type: string
          description: <em>search engine type</em>
          nullable: true
        date_posted:
          type: string
          description: <em>date when the task was posted (in the UTC format)</em>
          nullable: true
        tag:
          type: string
          nullable: true
        endpoint_advanced:
          type: string
          description: '<em>URL for collecting the results of the {{up_se_name}} {{normal_se_type}} task</em>'
          nullable: true
        endpoint_html:
          type: string
          description: '<em>URL for collecting the results of the {{up_se_name}} {{normal_se_type}} HTML task</em><br>if HTML tasks are not supported in the specified endpoint, the value will be <code>null</code>'
          nullable: true
    AppDataTasksReadyTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AppDataTasksReadyResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    AppDataTasksReadyResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AppDataTasksReadyTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    AppDataGoogleAppSearchesTaskGetAdvancedResultInfo:
      type: object
      properties:
        keyword:
          type: string
          description: <em>keyword received in a POST request</em>
          nullable: true
        se_domain:
          type: string
          description: <em>search engine domain in a POST array</em>
          nullable: true
        location_code:
          type: integer
          description: <em>location code in a POST array</em>
          nullable: true
        language_code:
          type: string
          description: <em>language code in a POST array</em>
          nullable: true
        check_url:
          type: string
          description: <em>direct URL to search engine results</em><br>you can use it to make sure that we provided accurate results
          nullable: true
        datetime:
          type: string
          description: '<em>date and time when the result was received</em><br>in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”<br>example:<br><code class="long-string">2019-11-15 12:57:46 +00:00</code>'
          nullable: true
        se_results_count:
          type: integer
          description: <em>the total number of results</em>
          format: int64
          nullable: true
        items_count:
          type: integer
          description: <em>the number of items in the results array</em>
          format: int64
          nullable: true
        items:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/GooglePlaySearchOrganic'
            nullable: true
          description: <em>found apps</em>
          nullable: true
    AppDataGoogleAppSearchesTaskGetAdvancedTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AppDataGoogleAppSearchesTaskGetAdvancedResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    AppDataGoogleAppSearchesTaskGetAdvancedResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AppDataGoogleAppSearchesTaskGetAdvancedTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    AppDataGoogleAppSearchesTaskGetHtmlResultInfo:
      type: object
      properties:
        keyword:
          type: string
          description: <em>keyword received in a POST request</em>
          nullable: true
        type:
          type: string
          description: type of element
          nullable: true
        se_domain:
          type: string
          description: <em>search engine domain in a POST array</em>
          nullable: true
        location_code:
          type: integer
          description: <em>location code in a POST array</em>
          nullable: true
        language_code:
          type: string
          description: <em>language code in a POST array</em>
          nullable: true
        datetime:
          type: string
          description: '<em>date and time when the result was received</em><br>in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”<br>example:<br><code class="long-string">2019-11-15 12:57:46 +00:00</code>'
          nullable: true
        items_count:
          type: integer
          description: <em>the number of results returned in the <strong><code>items</code></strong> array</em>
          format: int64
          nullable: true
        items:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/HtmlItemInfo'
            nullable: true
          description: <em>HTML pages and related data</em>
          nullable: true
    AppDataGoogleAppSearchesTaskGetHtmlTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AppDataGoogleAppSearchesTaskGetHtmlResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    AppDataGoogleAppSearchesTaskGetHtmlResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AppDataGoogleAppSearchesTaskGetHtmlTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    AppDataGoogleAppListTaskPostRequestInfo:
      type: object
      properties:
        app_collection:
          type: string
          description: '<em>app collection</em><br><strong>required field</strong><br>app collection on Google Play from which apps will be collected;<br>you can specify the following values:<br><code>featured</code>, <code>topselling_paid</code>, <code>topselling_free</code>, <code>topselling_new_free</code>, <code>topselling_new_paid</code>, <code>topgrossing</code>, <code>movers_shakers</code><br><strong>Note:</strong> if <code>featured</code> is selected, the <code>app_category</code> parameter cannot be used'
        location_name:
          type: string
          description: '<em>full name of search engine location</em><br><strong>required field if you don''t specify <code>location_code</code></strong><br><strong>if you use this field, you don''t need to specify <code>location_code</code></strong><br>you can receive the list of available locations of the search engine with their <code>location_name</code> by making a separate request to <code>https://api.dataforseo.com/v3/app_data/google/locations</code><br>example:<br><code class="long-string">West Los Angeles,California,United States</code>'
        location_code:
          type: integer
          description: '<em>search engine location code</em><br><strong>required field if you don''t specify <code>location_name</code></strong><br><strong>if you use this field, you don''t need to specify <code>location_name</code></strong><br>you can receive the list of available locations of the search engine with their <code>location_code</code> by making a separate request to <code>https://api.dataforseo.com/v3/app_data/google/locations</code><br>example:<br><code class="long-string">9061121</code>'
        language_name:
          type: string
          description: '<em>full name of search engine language</em><br><strong>required field if <code>language_code</code> is not specified</strong><br>if you use this field, you don''t need to specify <code>language_code</code><br>you can receive the list of available languages with <code>language_name</code> by making a separate request to <code>https://api.dataforseo.com/v3/app_data/google/languages</code><br>example:<br><code class="long-string">English</code>'
        language_code:
          type: string
          description: '<em>search engine language code</em><br><strong>required field if <code>language_name</code> is not specified</strong><br>if you use this field, you don''t need to specify <code>language_name</code><br>you can receive the list of available languages with their <code>language_code</code>_by making a separate request to <code>https://api.dataforseo.com/v3/app_data/google/languages</code><em><br></em>example:<em><br></em><code class="long-string">en</code>'
        priority:
          type: integer
          description: <em>task priority</em><br>optional field<br>can take the following values:<br>1 – normal execution priority (set by default)<br>2 – high execution priorityYou will be additionally charged for the tasks with high execution priority.<br>The cost can be calculated on the <a title="Pricing" href="https://dataforseo.com/pricing/api/google-play" target="_blank" rel="noopener noreferrer">Pricing</a> page.
          nullable: true
        depth:
          type: integer
          description: '<em>parsing depth</em><br>optional field<br>number of apps to be returned in the API response;<br>we strongly recommend setting the parsing depth in the multiples of 100, because our system processes 100 results in a row;<br>default value: <code>100</code>;<br>maximum value: <code>200</code>;<br><strong>Your account will be billed per each SERP containing up to 100 results;</strong> <br>Setting depth above 100 may result in additional charges if the search engine returns more than 100 results</a>;<br>The cost can be calculated on the <a title="Pricing" href="https://dataforseo.com/pricing/app-data/google-play" target="_blank" rel="noopener noreferrer">Pricing</a> page.'
          nullable: true
        app_category:
          type: string
          description: <em>application category on Google Play</em><br>optional field<br>you can filter the results by app category;<br>example:<br><code>family</code>;<br>you can receive the full list of available categories by making a separate request to <code>https://api.dataforseo.com/v3/app_data/google/categories</code><br><strong>Note:</strong> <code>app_category</code> cannot be used if <code>app_collection</code> parameter is set to <code>featured</code>
          nullable: true
        age_rating:
          type: string
          description: '<em>filter results by age rating</em><br>optional field<br>you can use this field to filter the results by age rating;<br>possible types of filtering:<br><code>ages_up_to_5</code> — return apps approved for children up to 5 years old;<br><code>ages_6_8</code> — return apps approved for children from 6 to 8 years old;<br><code>ages_9_12</code> — return apps approved for children from 9 to 12 years old;<br>by default, the API returns apps for all ages;<br><strong>Note:</strong> this filter works only in conjunction with the <code>"category": "family"</code> parameter'
          nullable: true
        tag:
          type: string
          description: <em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response
          nullable: true
        postback_url:
          type: string
          description: '<em>URL for sending task results</em><br>optional field<br>once the task is completed, we will send a POST request with its results compressed in the <code>gzip</code> format to the <code>postback_url</code> you specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/postbackscript?id=$id</code><br><code>http://your-server.com/postbackscript?id=$id&amp;tag=$tag</code><br><strong>Note:</strong> special characters in <code>postback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code>'
          nullable: true
        postback_data:
          type: string
          description: '<em>postback_url datatype</em><br><strong>required field if you specify <code>postback_url</code></strong><br>corresponds to the datatype that will be sent to your server<br>possible values:<br><code>advanced</code>, <code>html</code>'
        pingback_url:
          type: string
          description: '<em>notification URL of a completed task</em><br>optional field<br>when a task is completed we will notify you by GET request sent to the URL you have specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/pingscript?id=$id</code><br><code>http://your-server.com/pingscript?id=$id&amp;tag=$tag</code><br><strong>Note:</strong> special characters in <code>pingback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code>'
          nullable: true
      example:
        - app_collection: topselling_free
          location_code: 2840
          language_code: en
          depth: 100
    AppDataGoogleAppListTaskPostTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: object
              description: '<em>array of results</em><br>in this case, the value will be <code>null</code>'
              nullable: true
    AppDataGoogleAppListTaskPostResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AppDataGoogleAppListTaskPostTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    AppDataGoogleAppListTasksReadyResultInfo:
      type: object
      properties:
        id:
          type: string
          description: <em>task identifier of the completed task</em><br><strong>unique task identifier in our system in the <a href="https://en.wikipedia.org/wiki/Universally_unique_identifier">UUID</a> format</strong>
          nullable: true
        se:
          type: string
          description: <em>search engine specified when setting the task</em>
          nullable: true
        se_type:
          type: string
          description: <em>search engine type</em>
          nullable: true
        date_posted:
          type: string
          description: <em>date when the task was posted (in the UTC format)</em>
          nullable: true
        tag:
          type: string
          nullable: true
        endpoint_advanced:
          type: string
          description: '<em>URL for collecting the results of the {{up_se_name}} {{normal_se_type}} task</em>'
          nullable: true
        endpoint_html:
          type: string
          description: '<em>URL for collecting the results of the {{up_se_name}} {{normal_se_type}} HTML task</em><br>if HTML tasks are not supported in the specified endpoint, the value will be <code>null</code>'
          nullable: true
    AppDataGoogleAppListTasksReadyTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AppDataGoogleAppListTasksReadyResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    AppDataGoogleAppListTasksReadyResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AppDataGoogleAppListTasksReadyTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    AppDataGoogleAppListTaskGetAdvancedResultInfo:
      type: object
      properties:
        keyword:
          type: string
          description: <em>app collection received in a POST array</em>
          nullable: true
        se_domain:
          type: string
          description: <em>search engine domain in a POST array</em>
          nullable: true
        location_code:
          type: integer
          description: <em>location code in a POST array</em>
          nullable: true
        language_code:
          type: string
          description: <em>language code in a POST array</em>
          nullable: true
        check_url:
          type: string
          description: <em>direct URL to search engine results</em><br>you can use it to make sure that we provided accurate results
          nullable: true
        datetime:
          type: string
          description: '<em>date and time when the result was received</em><br>in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”<br>example:<br><code class="long-string">2019-11-15 12:57:46 +00:00</code>'
          nullable: true
        se_results_count:
          type: integer
          description: <em>the total number of results</em>
          format: int64
          nullable: true
        items_count:
          type: integer
          description: <em>the number of app items in the results array</em><br>you can get more results by using the <code>depth</code> parameter when setting a task
          format: int64
          nullable: true
        items:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/GooglePlaySearchOrganic'
            nullable: true
          description: <em>found apps</em>
          nullable: true
    AppDataGoogleAppListTaskGetAdvancedTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AppDataGoogleAppListTaskGetAdvancedResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    AppDataGoogleAppListTaskGetAdvancedResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AppDataGoogleAppListTaskGetAdvancedTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    AppDataGoogleAppListTaskGetHtmlResultInfo:
      type: object
      properties:
        keyword:
          type: string
          description: <em>app collection received in a POST array</em>
          nullable: true
        type:
          type: string
          description: type of element
          nullable: true
        se_domain:
          type: string
          description: <em>search engine domain in a POST array</em>
          nullable: true
        location_code:
          type: integer
          description: <em>location code in a POST array</em>
          nullable: true
        language_code:
          type: string
          description: <em>language code in a POST array</em>
          nullable: true
        datetime:
          type: string
          description: '<em>date and time when the result was received</em><br>in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”<br>example:<br><code class="long-string">2019-11-15 12:57:46 +00:00</code>'
          nullable: true
        items_count:
          type: integer
          description: <em>the number of results returned in the <strong><code>items</code></strong> array</em>
          format: int64
          nullable: true
        items:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/HtmlItemInfo'
            nullable: true
          description: <em>HTML pages and related data</em>
          nullable: true
    AppDataGoogleAppListTaskGetHtmlTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AppDataGoogleAppListTaskGetHtmlResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    AppDataGoogleAppListTaskGetHtmlResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AppDataGoogleAppListTaskGetHtmlTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    AppDataGoogleAppInfoTaskPostRequestInfo:
      type: object
      properties:
        app_id:
          type: string
          description: <em>id of the app</em><br><strong>required field</strong><br>ID of the mobile application on Google Play;<br>you can find the ID in the URL of every app listed on Google Play;<br>example:<br>in the URL <code>https://play.google.com/store/apps/details?id=<strong>org.telegram.messenger</strong></code><br>the id is <code>org.telegram.messenger</code>
        location_name:
          type: string
          description: '<em>full name of search engine location</em><br><strong>required field if you don''t specify <code>location_code</code></strong><br><strong>if you use this field, you don''t need to specify <code>location_code</code></strong><br>you can receive the list of available locations of the search engine with their <code>location_name</code> by making a separate request to <code>https://api.dataforseo.com/v3/app_data/google/locations</code><br>example:<br><code class="long-string">West Los Angeles,California,United States</code>'
        location_code:
          type: integer
          description: '<em>search engine location code</em><br><strong>required field if you don''t specify <code>location_name</code></strong><br><strong>if you use this field, you don''t need to specify <code>location_name</code></strong><br>you can receive the list of available locations of the search engine with their <code>location_code</code> by making a separate request to <code>https://api.dataforseo.com/v3/app_data/google/locations</code><br>example:<br><code class="long-string">9061121</code>'
        language_name:
          type: string
          description: '<em>full name of search engine language</em><br><strong>required field if <code>language_code</code> is not specified</strong><br>if you use this field, you don''t need to specify <code>language_code</code><br>you can receive the list of available languages with <code>language_name</code> by making a separate request to <code>https://api.dataforseo.com/v3/app_data/google/languages</code><br>example:<br><code class="long-string">English</code>'
        language_code:
          type: string
          description: '<em>search engine language code</em><br><strong>required field if <code>language_name</code> is not specified</strong><br>if you use this field, you don''t need to specify <code>language_name</code><br>you can receive the list of available languages with their <code>language_code</code>_by making a separate request to <code>https://api.dataforseo.com/v3/app_data/google/languages</code><em><br></em>example:<em><br></em><code class="long-string">en</code>'
        priority:
          type: integer
          description: <em>task priority</em><br>optional field<br>can take the following values:<br>1 – normal execution priority (set by default)<br>2 – high execution priorityYou will be additionally charged for the tasks with high execution priority.<br>The cost can be calculated on the <a title="Pricing" href="https://dataforseo.com/pricing/api/google-play" target="_blank" rel="noopener noreferrer">Pricing</a> page.
          nullable: true
        tag:
          type: string
          description: <em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response
          nullable: true
        postback_url:
          type: string
          description: '<em>URL for sending task results</em><br>optional field<br>once the task is completed, we will send a POST request with its results compressed in the <code>gzip</code> format to the <code>postback_url</code> you specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/postbackscript?id=$id</code><br><code>http://your-server.com/postbackscript?id=$id&amp;tag=$tag</code><br><strong>Note:</strong> special characters in <code>postback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code>'
          nullable: true
        postback_data:
          type: string
          description: '<em>postback_url datatype</em><br><strong>required field if you specify <code>postback_url</code></strong><br>corresponds to the datatype that will be sent to your server<br>possible values:<br><code>advanced</code>, <code>html</code>'
        pingback_url:
          type: string
          description: '<em>notification URL of a completed task</em><br>optional field<br>when a task is completed we will notify you by GET request sent to the URL you have specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/pingscript?id=$id</code><br><code>http://your-server.com/pingscript?id=$id&amp;tag=$tag</code><br><strong>Note:</strong> special characters in <code>pingback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code>'
          nullable: true
      example:
        - app_id: org.telegram.messenger
          location_code: 2840
          language_code: en
    AppDataGoogleAppInfoTaskPostTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: object
              description: '<em>array of results</em><br>in this case, the value will be <code>null</code>'
              nullable: true
    AppDataGoogleAppInfoTaskPostResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AppDataGoogleAppInfoTaskPostTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    AppDataGoogleAppInfoTasksReadyResultInfo:
      type: object
      properties:
        id:
          type: string
          description: <em>task identifier of the completed task</em><br><strong>unique task identifier in our system in the <a href="https://en.wikipedia.org/wiki/Universally_unique_identifier">UUID</a> format</strong>
          nullable: true
        se:
          type: string
          description: <em>search engine specified when setting the task</em>
          nullable: true
        se_type:
          type: string
          description: <em>search engine type</em>
          nullable: true
        date_posted:
          type: string
          description: <em>date when the task was posted (in the UTC format)</em>
          nullable: true
        tag:
          type: string
          nullable: true
        endpoint_advanced:
          type: string
          description: '<em>URL for collecting the results of the {{up_se_name}} {{normal_se_type}} task</em>'
          nullable: true
        endpoint_html:
          type: string
          description: '<em>URL for collecting the results of the {{up_se_name}} {{normal_se_type}} HTML task</em><br>if HTML tasks are not supported in the specified endpoint, the value will be <code>null</code>'
          nullable: true
    AppDataGoogleAppInfoTasksReadyTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AppDataGoogleAppInfoTasksReadyResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    AppDataGoogleAppInfoTasksReadyResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AppDataGoogleAppInfoTasksReadyTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    AppsInfo:
      type: object
      properties:
        app_id:
          type: string
          description: <i>ID of the app</i>
          nullable: true
        title:
          type: string
          description: <i>title of the app</i>
          nullable: true
        url:
          type: string
          description: <i>URL to the app page on Google Play</i>
          nullable: true
    GooglePlayInfoOrganic:
      type: object
      properties:
        type:
          type: string
          description: type of element
          nullable: true
        rank_group:
          type: integer
          description: <em>position within a group of elements with identical <code>type</code> values</em><br>positions of elements with different <code>type</code> values are omitted from <code>rank_group</code>
          nullable: true
        rank_absolute:
          type: integer
          description: <em>absolute rank among all the listed apps</em><br>absolute position among all apps on the list
          nullable: true
        position:
          type: string
          description: '<em>the alignment of the element in SERP</em><br>can take the following values: <code>left</code>'
          nullable: true
        app_id:
          type: string
          description: <em>ID of the app</em>
          nullable: true
        title:
          type: string
          description: <em>title of the app</em>
          nullable: true
        url:
          type: string
          description: <em>URL to the app page on Google Play</em>
          nullable: true
        icon:
          type: string
          description: <em>URL to the app icon</em>
          nullable: true
        description:
          type: string
          description: <em>description of the app</em>
          nullable: true
        reviews_count:
          type: integer
          description: <em>the total number of reviews the app has</em>
          format: int64
          nullable: true
        rating:
          type: object
          oneOf:
            - $ref: '#/components/schemas/RatingInfo'
          description: <em>average rating of the app</em>
          nullable: true
        price:
          type: object
          oneOf:
            - $ref: '#/components/schemas/PriceInfo'
          description: <em>price of the app</em>
          nullable: true
        is_free:
          type: boolean
          description: <em>indicates whether the app is free</em>
          nullable: true
        main_category:
          type: string
          description: <em>main category of the app</em>
          nullable: true
        installs:
          type: string
          description: <em>number of installs of the app</em><br>approximate number of installs as displayed on the app page
          nullable: true
        installs_count:
          type: integer
          description: <em>number of installs of the app</em><br>the exact number of installs of the app
          format: int64
          nullable: true
        developer:
          type: string
          description: <em>name of the app developer</em>
          nullable: true
        developer_id:
          type: string
          description: <em>ID of the app developer</em>
          nullable: true
        developer_url:
          type: string
          description: <em>URL to the developer page on Google Play</em>
          nullable: true
        developer_email:
          type: string
          description: <em>email address of the developer</em>
          nullable: true
        developer_address:
          type: string
          description: <em>physical address of the developer</em>
          nullable: true
        developer_website:
          type: string
          description: <em>official website of the developer</em>
          nullable: true
        version:
          type: string
          description: <em>current version of the app</em>
          nullable: true
        minimum_os_version:
          type: string
          description: <em>minimum OS version required to install the app</em>
          nullable: true
        size:
          type: string
          description: <em>size of the app</em>
          nullable: true
        released_date:
          type: string
          description: '<em>date and time when the app was released</em><br>in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”;<br>example:<br><code>2019-11-15 12:57:46 +00:00</code>'
          nullable: true
        last_update_date:
          type: string
          description: '<em>date and time when the app was last updated</em><br>in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”;<br>example:<br><code>2019-11-15 12:57:46 +00:00</code>'
          nullable: true
        update_notes:
          type: string
          description: <em>update notes</em><br>contains the latest update notes from the developer
          nullable: true
        images:
          type: array
          items:
            type: string
            nullable: true
          description: <em>app images</em><br>contains URLs to the images published on the app page on Google Play
          nullable: true
        videos:
          type: array
          items:
            type: string
            nullable: true
          description: <em>app videos</em><br>contains URLs to the video published on the app page on Google Play
          nullable: true
        similar_apps:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/AppsInfo'
            nullable: true
          description: <em>similar apps</em><br>displays apps similar to the app in a POST request
          nullable: true
        more_apps_by_developer:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/AppsInfo'
            nullable: true
          description: <em>similar apps</em><br>information about apps built by the same developer
          nullable: true
        genres:
          type: array
          items:
            type: string
            nullable: true
          description: <em>app genres</em><br>contains relevant app categories
          nullable: true
        tags:
          type: array
          items:
            type: string
            nullable: true
          description: <em>app tags</em><br>contains relevant app tags
          nullable: true
    AppDataGoogleAppInfoTaskGetAdvancedResultInfo:
      type: object
      properties:
        app_id:
          type: string
          description: <em>application id received in a POST request</em>
          nullable: true
        se_domain:
          type: string
          description: <em>search engine domain in a POST array</em>
          nullable: true
        location_code:
          type: integer
          description: <em>location code in a POST array</em>
          nullable: true
        language_code:
          type: string
          description: <em>language code in a POST array</em>
          nullable: true
        check_url:
          type: string
          description: <em>direct URL to search engine results</em><br>you can use it to make sure that we provided accurate results
          nullable: true
        datetime:
          type: string
          description: '<em>date and time when the result was received</em><br>in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”<br>example:<br><code class="long-string">2019-11-15 12:57:46 +00:00</code>'
          nullable: true
        se_results_count:
          type: integer
          description: <em>the total number of results</em>
          format: int64
          nullable: true
        items_count:
          type: integer
          description: <em>the number of items in the results array</em>
          format: int64
          nullable: true
        items:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/GooglePlayInfoOrganic'
            nullable: true
          description: <em>found app info</em>
          nullable: true
    AppDataGoogleAppInfoTaskGetAdvancedTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AppDataGoogleAppInfoTaskGetAdvancedResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    AppDataGoogleAppInfoTaskGetAdvancedResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AppDataGoogleAppInfoTaskGetAdvancedTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    AppDataGoogleAppInfoTaskGetHtmlResultInfo:
      type: object
      properties:
        app_id:
          type: string
          description: <em>application ID received in a POST request</em>
          nullable: true
        type:
          type: string
          description: type of element
          nullable: true
        se_domain:
          type: string
          description: <em>search engine domain in a POST array</em>
          nullable: true
        location_code:
          type: integer
          description: <em>location code in a POST array</em>
          nullable: true
        language_code:
          type: string
          description: <em>language code in a POST array</em>
          nullable: true
        datetime:
          type: string
          description: '<em>date and time when the result was received</em><br>in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”<br>example:<br><code class="long-string">2019-11-15 12:57:46 +00:00</code>'
          nullable: true
        items_count:
          type: integer
          description: <em>the number of results returned in the <strong><code>items</code></strong> array</em>
          format: int64
          nullable: true
        items:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/HtmlItemInfo'
            nullable: true
          description: <em>HTML pages and related data</em>
          nullable: true
    AppDataGoogleAppInfoTaskGetHtmlTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AppDataGoogleAppInfoTaskGetHtmlResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    AppDataGoogleAppInfoTaskGetHtmlResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AppDataGoogleAppInfoTaskGetHtmlTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    AppDataGoogleAppReviewsTaskPostRequestInfo:
      type: object
      properties:
        app_id:
          type: string
          description: <em>id of the app</em><br><strong>required field</strong><br>ID of the mobile application on Google Play;<br>you can find the ID in the URL of every app listed on Google Play;<br>example:<br><code>https://play.google.com/store/apps/details?id=<strong>org.telegram.messenger</strong></code>
        location_name:
          type: string
          description: '<em>full name of search engine location</em><br><strong>required field if you don''t specify <code>location_code</code></strong><br><strong>if you use this field, you don''t need to specify <code>location_code</code></strong><br>you can receive the list of available locations of the search engine with their <code>location_name</code> by making a separate request to <code>https://api.dataforseo.com/v3/app_data/google/locations</code><br>example:<br><code class="long-string">West Los Angeles,California,United States</code>'
        location_code:
          type: integer
          description: '<em>search engine location code</em><br><strong>required field if you don''t specify <code>location_name</code></strong><br><strong>if you use this field, you don''t need to specify <code>location_name</code></strong><br>you can receive the list of available locations of the search engine with their <code>location_code</code> by making a separate request to <code>https://api.dataforseo.com/v3/app_data/google/locations</code><br>example:<br><code class="long-string">9061121</code>'
        language_name:
          type: string
          description: '<em>full name of search engine language</em><br><strong>required field if you don''t specify <code>language_code</code></strong><br>if you use this field, you don''t need to specify <code>language_code</code><br>you can receive the list of available languages with <code>language_name</code> by making a separate request to <code>https://api.dataforseo.com/v3/app_data/google/languages</code><br>example:<br><code class="long-string">English</code>'
        language_code:
          type: string
          description: '<em>search engine language code</em><br><strong>required field if you don''t specify <code>language_name</code></strong><br>if you use this field, you don''t need to specify <code>language_name</code><br>you can receive the list of available languages with their <code>language_code</code> by making a separate request to <code>https://api.dataforseo.com/v3/app_data/google/languages</code><em><br></em>example:<em><br></em><code class="long-string">en</code>'
        priority:
          type: integer
          description: <em>task priority</em><br>optional field<br>can take the following values:<br>1 – normal execution priority (set by default)<br>2 – high execution priorityYou will be additionally charged for the tasks with high execution priority.<br>The cost can be calculated on the <a title="Pricing" href="https://dataforseo.com/pricing/api/google-play" target="_blank" rel="noopener noreferrer">Pricing</a> page.
          nullable: true
        depth:
          type: integer
          description: '<em>parsing depth</em><br>optional field<br>number of reviews to be returned in the API response;<br>we strongly recommend setting the parsing depth in the multiples of 150, because our system processes 150 reviews in a row;<br>default value: <code>150</code>;<br>maximum value: <code>100000</code>;<br><strong>Your account will be billed per each SERP containing up to 150 results;</strong> <br>Setting depth above 150 may result in additional charges if the search engine returns more than 150 results</a>;<br>The cost can be calculated on the <a title="Pricing" href="https://dataforseo.com/pricing/app-data/google-play" target="_blank" rel="noopener noreferrer">Pricing</a> page.'
          nullable: true
        rating:
          type: integer
          description: '<em>filter reviews by rating</em><br>optional field<br>you can use this field to filter the results;<br>possible types of filtering:<br><code>5</code> — return reviews with five-star rating only;<br><code>4</code> — return reviews with four-star rating only;<br><code>3</code> — return reviews with three-star rating only;<br><code>2</code> — return reviews with two-star rating only;<br><code>1</code> — return reviews with one-star rating only;<br>by default, the API returns all reviews regardless of the number of stars'
          nullable: true
        sort_by:
          type: string
          description: '<em>results sorting parameters</em><br>optional field<br>you can use this field to sort the results;<br>possible types of sorting:<br><code>newest</code> — sort by the most recent reviews;<br><code>most_relevant</code> — sort by the most relevant reviews;<br>default rule: <code>most_relevant</code>'
          nullable: true
        tag:
          type: string
          description: <em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response
          nullable: true
        postback_url:
          type: string
          description: '<em>URL for sending task results</em><br>optional field<br>once the task is completed, we will send a POST request with its results compressed in the <code>gzip</code> format to the <code>postback_url</code> you specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/postbackscript?id=$id</code><br><code>http://your-server.com/postbackscript?id=$id&amp;tag=$tag</code><br><strong>Note:</strong> special characters in <code>postback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code>'
          nullable: true
        postback_data:
          type: string
          description: '<em>postback_url datatype</em><br><strong>required field if you specify <code>postback_url</code></strong><br>corresponds to the datatype that will be sent to your server<br>possible values:<br><code>advanced</code>, <code>html</code>'
        pingback_url:
          type: string
          description: '<em>notification URL of a completed task</em><br>optional field<br>when a task is completed we will notify you by GET request sent to the URL you have specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/pingscript?id=$id</code><br><code>http://your-server.com/pingscript?id=$id&amp;tag=$tag</code><br><strong>Note:</strong> special characters in <code>pingback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code>'
          nullable: true
      example:
        - app_id: org.telegram.messenger
          location_code: 2840
          language_code: en
          depth: 150
    AppDataGoogleAppReviewsTaskPostTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: object
              description: '<em>array of results</em><br>in this case, the value will be <code>null</code>'
              nullable: true
    AppDataGoogleAppReviewsTaskPostResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AppDataGoogleAppReviewsTaskPostTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    AppDataGoogleAppReviewsTasksReadyResultInfo:
      type: object
      properties:
        id:
          type: string
          description: <em>task identifier of the completed task</em><br><strong>unique task identifier in our system in the <a href="https://en.wikipedia.org/wiki/Universally_unique_identifier">UUID</a> format</strong>
          nullable: true
        se:
          type: string
          description: <em>search engine specified when setting the task</em>
          nullable: true
        se_type:
          type: string
          description: <em>search engine type</em>
          nullable: true
        date_posted:
          type: string
          description: <em>date when the task was posted (in the UTC format)</em>
          nullable: true
        tag:
          type: string
          nullable: true
        endpoint_advanced:
          type: string
          description: '<em>URL for collecting the results of the {{up_se_name}} {{normal_se_type}} task</em>'
          nullable: true
        endpoint_html:
          type: string
          description: '<em>URL for collecting the results of the {{up_se_name}} {{normal_se_type}} HTML task</em><br>if HTML tasks are not supported in the specified endpoint, the value will be <code>null</code>'
          nullable: true
    AppDataGoogleAppReviewsTasksReadyTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AppDataGoogleAppReviewsTasksReadyResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    AppDataGoogleAppReviewsTasksReadyResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AppDataGoogleAppReviewsTasksReadyTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    AppUserProfileInfo:
      type: object
      properties:
        profile_name:
          type: string
          description: <em>profile name of the reviewer</em>
          nullable: true
        profile_image_url:
          type: string
          description: <em>URL to the reviewer's profile image</em>
          nullable: true
    ResponseDataInfo:
      type: object
      properties:
        author:
          type: string
          description: <em>author of the response</em>
          nullable: true
        title:
          type: string
          description: '<em>title of the response</em><br>in this case, will equal <code>null</code>'
          nullable: true
        text:
          type: string
          description: <em>content of the response</em>
          nullable: true
        timestamp:
          type: string
          description: '<em>date and time when the response was published</em><br>in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”;<br>example:<br><code>2019-11-15 12:57:46 +00:00</code>'
          nullable: true
    GooglePlayReviewsSearch:
      type: object
      properties:
        type:
          type: string
          description: type of element
          nullable: true
        rank_group:
          type: integer
          description: <em>position within a group of elements with identical <code>type</code> values</em><br>positions of elements with different <code>type</code> values are omitted from <code>rank_group</code>
          nullable: true
        rank_absolute:
          type: integer
          description: <em>absolute rank among all the listed reviews</em><br>absolute position among all reviews on the list
          nullable: true
        position:
          type: string
          description: '<em>the alignment of the review in SERP</em><br>can take the following values: <code>left</code>'
          nullable: true
        version:
          type: string
          description: <em>version of the app</em><br>version of the app for which the review is submitted
          nullable: true
        rating:
          type: object
          oneOf:
            - $ref: '#/components/schemas/RatingInfo'
          description: <em>the rating score submitted by the reviewer</em>
          nullable: true
        timestamp:
          type: string
          description: '<em>date and time when the review was published</em><br>in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”;<br>example:<br><code>2019-11-15 12:57:46 +00:00</code>'
          nullable: true
        id:
          type: string
          description: <em>id of the review</em>
          nullable: true
        helpful_count:
          type: integer
          description: <em>number of helpful votes</em><br>indicates how many users considered the review helpful and voted with the thumbs up icon
          format: int64
          nullable: true
        title:
          type: string
          description: '<em>title of the review</em><br>Google Play doesn''t provide an option to title reviews, so this parameter will always equal <code>null</code>'
          nullable: true
        review_text:
          type: string
          description: <em>content of the review</em>
          nullable: true
        user_profile:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppUserProfileInfo'
          description: <em>user profile of the reviewer</em>
          nullable: true
        responses:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/ResponseDataInfo'
            nullable: true
          description: <em>response from the developer</em>
          nullable: true
    AppDataGoogleAppReviewsTaskGetAdvancedResultInfo:
      type: object
      properties:
        app_id:
          type: string
          description: <em>application id received in a POST array</em>
          nullable: true
        type:
          type: string
          description: type of element
          nullable: true
        se_domain:
          type: string
          description: <em>search engine domain in a POST array</em>
          nullable: true
        location_code:
          type: integer
          description: <em>location code in a POST array</em>
          nullable: true
        language_code:
          type: string
          description: <em>language code in a POST array</em>
          nullable: true
        check_url:
          type: string
          description: <em>direct URL to search engine results</em><br>you can use it to make sure that we provided accurate results
          nullable: true
        datetime:
          type: string
          description: '<em>date and time when the result was received</em><br>in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”<br>example:<br><code class="long-string">2019-11-15 12:57:46 +00:00</code>'
          nullable: true
        title:
          type: string
          description: <em>title of the app</em><br>title of the application for which the reviews are collected
          nullable: true
        rating:
          type: object
          oneOf:
            - $ref: '#/components/schemas/RatingInfo'
          description: <em>rating of the app</em><br>rating of the application for which the reviews are collected
          nullable: true
        reviews_count:
          type: integer
          description: <em>the total number of reviews</em>
          format: int64
          nullable: true
        items_count:
          type: integer
          description: <em>the number of reviews items in the results array</em><br>you can get more results by using the <code>depth</code> parameter when setting a task
          format: int64
          nullable: true
        items:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/GooglePlayReviewsSearch'
            nullable: true
          description: <em>found reviews</em><br>you can get more results by using the <code>depth</code> parameter when setting a task
          nullable: true
    AppDataGoogleAppReviewsTaskGetAdvancedTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AppDataGoogleAppReviewsTaskGetAdvancedResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    AppDataGoogleAppReviewsTaskGetAdvancedResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AppDataGoogleAppReviewsTaskGetAdvancedTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    AppDataGoogleAppReviewsTaskGetHtmlResultInfo:
      type: object
      properties:
        app_id:
          type: string
          description: <em>app id received in a POST array</em>
          nullable: true
        type:
          type: string
          description: type of element
          nullable: true
        se_domain:
          type: string
          description: <em>search engine domain in a POST array</em>
          nullable: true
        location_code:
          type: integer
          description: <em>location code in a POST array</em>
          nullable: true
        language_code:
          type: string
          description: <em>language code in a POST array</em>
          nullable: true
        datetime:
          type: string
          description: '<em>date and time when the result was received</em><br>in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”<br>example:<br><code class="long-string">2019-11-15 12:57:46 +00:00</code>'
          nullable: true
        items_count:
          type: integer
          description: <em>the number of results returned in the <strong><code>items</code></strong> array</em>
          format: int64
          nullable: true
        items:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/HtmlItemInfo'
            nullable: true
          description: <em>HTML pages and related data</em>
          nullable: true
    AppDataGoogleAppReviewsTaskGetHtmlTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AppDataGoogleAppReviewsTaskGetHtmlResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    AppDataGoogleAppReviewsTaskGetHtmlResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AppDataGoogleAppReviewsTaskGetHtmlTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    AppDataGoogleAppListingsCategoriesResultInfo:
      type: object
      properties:
        category:
          type: string
          description: <em>name of the supported app category</em>
          nullable: true
        count:
          type: integer
          description: <em>number of app listings that make up the supported app category</em>
          format: int64
          nullable: true
    AppDataGoogleAppListingsCategoriesTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AppDataGoogleAppListingsCategoriesResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    AppDataGoogleAppListingsCategoriesResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AppDataGoogleAppListingsCategoriesTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    AppDataGoogleAppListingsSearchLiveRequestInfo:
      type: object
      properties:
        categories:
          type: array
          items:
            type: string
          description: <em>app categories</em><br>optional field<br>the categories you specify are used to search for app listings;<br>you can get the full list of available app listing categories by <a href="http://docs.dataforseo.com/v3/app_data/google/app_listings/categories" rel="noopener noreferrer" target="_blank">this link</a><br>you can specify <strong>up to 10 categories</strong>
          nullable: true
        description:
          type: string
          description: <em>keyword in the app's description</em><br>optional field<br>keywords that occur in the description of the app;<br>can contain up to 200 characters
          nullable: true
        title:
          type: string
          description: <em>keyword in the app's title</em><br>optional field<br>keywords that occur in the title of the app;<br>can contain up to 200 characters
          nullable: true
        filters:
          type: array
          items:
            type: object
            nullable: true
          description: '<em>array of results filtering parameters</em><br>optional field<br><strong>you can add several filters at once (8 filters maximum)</strong><br>you should set a logical operator <code>and</code>, <code>or</code> between the conditions<br>the following operators are supported:<br><code>regex</code>, <code>not_regex</code>, <code>&lt;</code>, <code>&lt;=</code>, <code>&gt;</code>, <code>&gt;=</code>, <code>=</code>, <code>&lt;&gt;</code>, <code>in</code>, <code>not_in</code>, <code>like</code>, <code>not_like</code><br>you can use the <code>%</code> operator with <code>like</code> and <code>not_like</code> to match any string of zero or more characters<br>example:<br><code>["item.rating.value",">",3]</code><p>you can receive the list of available filters_by making a separate request to <code>https://api.dataforseo.com/v3/app_data/google/app_listings/available_filters</code>'
          nullable: true
        order_by:
          type: array
          items:
            type: string
          description: '<em>results sorting rules</em><br>optional field<br>you can use the same values as in the <code>filters</code> array to sort the results<br>possible sorting types:<br><code>asc</code> - results will be sorted in the ascending order<br><code>desc</code> - results will be sorted in the descending order<br>you should use a comma to set up a sorting parameter<br>example:<br><code>["item.installs_count,asc"]</code><p><strong>note that you can set no more than three sorting rules in a single request</strong><br>you should use a comma to separate several sorting rules<br>example:<br><code>["item.rating.value,desc","item.installs_count,asc"]</code>'
          nullable: true
        limit:
          type: integer
          description: '<em>the maximum number of returned apps</em><br>optional field<br>default value: <code>100</code><br>maximum value: <code>1000</code>'
          nullable: true
        offset:
          type: integer
          description: '<em>offset in the results array of returned apps</em><br>optional field<br>default value: <code>0</code><br>if you specify the <code>10</code> value, the first ten entities in the results array will be omitted and the data will be provided for the successive entities<br><strong>Note:</strong> we recommend using this parameter only when retrieving up to 10,000 results<br>for retrieving over 10,000 results, use the <code>offset_token</code> instead.'
          nullable: true
        offset_token:
          type: string
          description: '<em>token for subsequent requests</em><br>optional field<br>provided in the identical filed of the response to each request;<br>use this parameter to avoid timeouts while trying to obtain over 100,000 results in a single request;<br>by specifying the unique <code>offset_token</code> value from the response array, you will get the subsequent results of the initial task;<br><code>offset_token</code> values are unique for each subsequent task <br><strong>Note:</strong> if the <code>offset_token</code> is specified in the request, all other parameters should be identical to the previous request<br>learn more about this parameter on our <a href="https://dataforseo.com/help-center/what-is-the-difference-between-the-offset-and-offset_token-parameters#offset_token" target="_blank">Help Center</a>'
          nullable: true
        tag:
          type: string
          description: <em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response
          nullable: true
      example:
        - title: vpn
          description: vpn
          categories:
            - Tools
          order_by:
            - 'item.installs_count,asc'
          filters:
            - 
              - item.rating.value
              - '>'
              - 4.5
          limit: 10
    AppDataGoogleAppListingsSearchLiveItem:
      type: object
      properties:
        app_id:
          type: string
          description: <em>ID of the returned app</em>
          nullable: true
        se_domain:
          type: string
          description: <em>search engine domain in a POST array</em>
          nullable: true
        location_code:
          type: integer
          description: <em>location code in a POST array</em>
          nullable: true
        language_code:
          type: string
          description: <em>language code in a POST array</em>
          nullable: true
        check_url:
          type: string
          description: <em>direct URL to search engine results</em><br>you can use it to make sure that we provided accurate results
          nullable: true
        time_update:
          type: string
          description: '<em>date and time when SERP data was last updated</em><br>in the <a href="https://en.wikipedia.org/wiki/ISO_8601">ISO 8601</a> format: “YYYY-MM-DDThh:mm:ss.sssssssZ”<br>example:<br><code class="long-string">2023-05-23 10:16:19 +00:00</code>'
          nullable: true
        item:
          type: object
          oneOf:
            - $ref: '#/components/schemas/GooglePlayInfoOrganic'
          description: <em>detailed information about the app</em>
          nullable: true
    AppDataGoogleAppListingsSearchLiveResultInfo:
      type: object
      properties:
        total_count:
          type: integer
          description: <em>the total number of relevant results in the database</em>
          format: int64
          nullable: true
        count:
          type: integer
          description: <em>the number of items in the results array</em>
          format: int64
          nullable: true
        offset:
          type: integer
          description: <em>offset in the results array of returned apps</em>
          nullable: true
        offset_token:
          type: string
          description: '<em>token for subsequent requests</em><br>you can use this parameter in the POST request to avoid timeouts while trying to obtain over 100,000 results in a single request'
          nullable: true
        items:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/AppDataGoogleAppListingsSearchLiveItem'
            nullable: true
          description: <em>array of apps and related data</em>
          nullable: true
    AppDataGoogleAppListingsSearchLiveTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AppDataGoogleAppListingsSearchLiveResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    AppDataGoogleAppListingsSearchLiveResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AppDataGoogleAppListingsSearchLiveTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    AppDataAppleCategoriesResultInfo:
      type: object
      properties:
        categories:
          type: array
          items:
            type: string
            nullable: true
          description: <em>contains full list of supported app categories</em>
          nullable: true
    AppDataAppleCategoriesTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AppDataAppleCategoriesResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    AppDataAppleCategoriesResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AppDataAppleCategoriesTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    AppDataAppleLocationsResultInfo:
      type: object
      properties:
        location_code:
          type: integer
          description: location code
          nullable: true
        location_name:
          type: string
          description: full name of the location
          nullable: true
        location_name_parent:
          type: string
          description: "the name of the superordinate location\nexample:\n\"location_code\": 1006473,\n\"location_name\": \"Altrincham,England,United Kingdom\",\n\"location_name_parent\": \"England,United Kingdom\", where location_name_parent corresponds to:\n\"location_code\": 20339,\n\"location_name\": \"England,United Kingdom\"\nnote: Apple App Data API currently supports countries only, that is why this value will always be null"
          nullable: true
        country_iso_code:
          type: string
          description: ISO country code of the location
          nullable: true
        location_type:
          type: string
          description: location type
          nullable: true
    AppDataAppleLocationsTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AppDataAppleLocationsResultInfo'
                nullable: true
              description: array of results
              nullable: true
    AppDataAppleLocationsResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AppDataAppleLocationsTaskInfo'
                nullable: true
              description: array of tasks
              nullable: true
    AppDataAppleLanguagesResultInfo:
      type: object
      properties:
        language_name:
          type: string
          description: <em>language name</em>
          nullable: true
        language_code:
          type: string
          description: <em>language code according to <a href="https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes" target="_blank" rel="noopener noreferrer">ISO 639-1</a></em>
          nullable: true
    AppDataAppleLanguagesTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AppDataAppleLanguagesResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    AppDataAppleLanguagesResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AppDataAppleLanguagesTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    AppDataAppleAppSearchesTaskPostRequestInfo:
      type: object
      properties:
        keyword:
          type: string
          description: '<em>keyword</em><br><strong>required field</strong><br>you can specify <strong>up to 700 characters</strong> in the <code>keyword</code> field;<br>all %## will be decoded (plus character ‘+’ will be decoded to a space character);<br>if you need to use the “%” character for your <code>keyword</code>, please specify it as “%25”;<br>if you need to use the “+” character for your <code>keyword</code>, please specify it as “%2B”<p>learn more about rules and limitations of <code>keyword</code> and <code>keywords</code> fields in DataForSEO APIs in this <a href="https://dataforseo.com/help-center/rules-and-limitations-of-keyword-and-keywords-fields-in-dataforseo-apis" rel="noopener noreferrer" target="_blank">Help Center article</a>'
        location_name:
          type: string
          description: '<em>full name of search engine location</em><br><strong>required field if you don''t specify <code>location_code</code></strong><br><strong>if you use this field, you don''t need to specify <code>location_code</code></strong><br>you can receive the list of available locations of the search engine with their <code>location_name</code> by making a separate request to <code>https://api.dataforseo.com/v3/app_data/apple/locations</code><br>example:<br><code class="long-string">West Los Angeles,California,United States</code>'
        location_code:
          type: integer
          description: '<em>search engine location code</em><br><strong>required field if you don''t specify <code>location_name</code></strong><br><strong>if you use this field, you don''t need to specify <code>location_name</code></strong><br>you can receive the list of available locations of the search engine with their <code>location_code</code> by making a separate request to <code>https://api.dataforseo.com/v3/app_data/apple/locations</code><br>example:<br><code class="long-string">9061121</code>'
        language_name:
          type: string
          description: '<em>full name of search engine language</em><br><strong>required field if <code>language_code</code> is not specified</strong><br>if you use this field, you don''t need to specify <code>language_code</code><br>you can receive the list of available languages with <code>language_name</code> by making a separate request to <code>https://api.dataforseo.com/v3/app_data/apple/languages</code><br>example:<br><code class="long-string">English</code>'
        language_code:
          type: string
          description: '<em>search engine language code</em><br><strong>required field if <code>language_name</code> is not specified</strong><br>if you use this field, you don''t need to specify <code>language_name</code><br>you can receive the list of available languages with their <code>language_code</code>_by making a separate request to <code>https://api.dataforseo.com/v3/app_data/apple/languages</code><em><br></em>example:<em><br></em><code class="long-string">en</code>n'
        priority:
          type: integer
          description: <em>task priority</em><br>optional field<br>can take the following values:<br>1 – normal execution priority (set by default)<br>2 – high execution priorityYou will be additionally charged for the tasks with high execution priority.<br>The cost can be calculated on the <a title="Pricing" href="https://dataforseo.com/pricing/api/app-store" target="_blank" rel="noopener noreferrer">Pricing</a> page.
          nullable: true
        depth:
          type: integer
          description: '<em>parsing depth</em><br>optional field<br>number of results to be returned from the App Store SERP;<br>we strongly recommend setting the parsing depth in the multiples of 100, because our system processes 100 results in a row;<br>default value: <code>100</code><br>maximum value: <code>700</code><br><strong>Your account will be billed per each SERP containing up to 100 results;</strong> <br>Setting depth above 100 may result in additional charges if the search engine returns more than 100 results</a>;<br>The cost can be calculated on the <a title="Pricing" href="https://dataforseo.com/pricing/app-data/app-store" target="_blank" rel="noopener noreferrer">Pricing</a> page.'
          nullable: true
        tag:
          type: string
          description: <em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response
          nullable: true
        postback_url:
          type: string
          description: '<em>URL for sending task results</em><br>optional field<br>once the task is completed, we will send a POST request with its results compressed in the <code>gzip</code> format to the <code>postback_url</code> you specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/postbackscript?id=$id</code><br><code>http://your-server.com/postbackscript?id=$id&amp;tag=$tag</code><br><strong>Note:</strong> special characters in <code>postback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href="https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api" target="_blank" rel="noopener noreferrer">Help Center</a>'
          nullable: true
        postback_data:
          type: string
          description: <em>postback_url datatype</em><br><strong>required field if you specify <code>postback_url</code></strong><br>corresponds to the datatype that will be sent to your server<br>possible values:<br><code>advanced</code>
        pingback_url:
          type: string
          description: '<em>notification URL of a completed task</em><br>optional field<br>when a task is completed we will notify you by GET request sent to the URL you have specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/pingscript?id=$id</code><br><code>http://your-server.com/pingscript?id=$id&amp;tag=$tag</code><br><strong>Note:</strong> special characters in <code>pingback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href="https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api" target="_blank" rel="noopener noreferrer">Help Center</a>'
          nullable: true
      example:
        - keyword: vpn
          location_code: 2840
          language_code: en
          depth: 200
    AppDataAppleAppSearchesTaskPostTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: object
              description: '<em>array of results</em><br>in this case, the value will be <code>null</code>'
              nullable: true
    AppDataAppleAppSearchesTaskPostResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AppDataAppleAppSearchesTaskPostTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    AppDataAppleAppSearchesTasksReadyResultInfo:
      type: object
      properties:
        id:
          type: string
          description: <em>task identifier of the completed task</em><br><strong>unique task identifier in our system in the <a href="https://en.wikipedia.org/wiki/Universally_unique_identifier">UUID</a> format</strong>
          nullable: true
        se:
          type: string
          description: <em>search engine specified when setting the task</em>
          nullable: true
        se_type:
          type: string
          description: <em>search engine type</em>
          nullable: true
        date_posted:
          type: string
          description: <em>date when the task was posted (in the UTC format)</em>
          nullable: true
        tag:
          type: string
          nullable: true
        endpoint_advanced:
          type: string
          description: '<em>URL for collecting the results of the {{up_se_name}} {{normal_se_type}} task</em>'
          nullable: true
        endpoint_html:
          type: string
          description: '<em>URL for collecting the results of the {{up_se_name}} {{normal_se_type}} HTML task</em><br>if HTML tasks are not supported in the specified endpoint, the value will be <code>null</code>'
          nullable: true
    AppDataAppleAppSearchesTasksReadyTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AppDataAppleAppSearchesTasksReadyResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    AppDataAppleAppSearchesTasksReadyResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AppDataAppleAppSearchesTasksReadyTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    AppDataAppleAppSearchesTaskGetAdvancedResultInfo:
      type: object
      properties:
        keyword:
          type: string
          description: <em>keyword received in a POST request</em>
          nullable: true
        se_domain:
          type: string
          description: <em>search engine domain in a POST array</em>
          nullable: true
        location_code:
          type: integer
          description: <em>location code in a POST array</em>
          nullable: true
        language_code:
          type: string
          description: <em>language code in a POST array</em>
          nullable: true
        check_url:
          type: string
          description: '<em>direct URL to search engine results</em><br>in this case, the value will be <code>null</code>'
          nullable: true
        datetime:
          type: string
          description: '<em>date and time when the result was received</em><br>in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”<br>example:<br><code class="long-string">2019-11-15 12:57:46 +00:00</code>'
          nullable: true
        se_results_count:
          type: integer
          description: <em>the total number of results</em>
          format: int64
          nullable: true
        items_count:
          type: integer
          description: <em>the number of items in the results array</em>
          format: int64
          nullable: true
        items:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/AppStoreSearchOrganic'
            nullable: true
          description: <em>found apps</em>
          nullable: true
    AppDataAppleAppSearchesTaskGetAdvancedTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AppDataAppleAppSearchesTaskGetAdvancedResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    AppDataAppleAppSearchesTaskGetAdvancedResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AppDataAppleAppSearchesTaskGetAdvancedTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    AppDataAppleAppInfoTaskPostRequestInfo:
      type: object
      properties:
        app_id:
          type: string
          description: <em>id of the app</em><br><strong>required field</strong><br>ID of the mobile application on App Store;<br>you can find the ID in the URL of every app listed on App Store;<br>example:<br>in the URL `https://apps.apple.com/us/app/id<strong>835599320</strong>`<br>the id is `835599320`
        location_name:
          type: string
          description: '<em>full name of search engine location</em><br><strong>required field if you don''t specify <code>location_code</code></strong><br><strong>if you use this field, you don''t need to specify <code>location_code</code></strong><br>you can receive the list of available locations of the search engine with their <code>location_name</code> by making a separate request to `https://api.dataforseo.com/v3/app_data/apple/locations`<br>example:<br><code class="long-string">West Los Angeles,California,United States</code>'
        location_code:
          type: integer
          description: '<em>search engine location code</em><br><strong>required field if you don''t specify <code>location_name</code></strong><br><strong>if you use this field, you don''t need to specify <code>location_name</code></strong><br>you can receive the list of available locations of the search engine with their <code>location_code</code> by making a separate request to `https://api.dataforseo.com/v3/app_data/apple/locations`<br>example:<br><code class="long-string">9061121</code>'
        language_name:
          type: string
          description: '<em>full name of search engine language</em><br><strong>required field if you don''t specify <code>language_code</code></strong><br>if you use this field, you don''t need to specify <code>language_code</code><br>you can receive the list of available languages with <code>language_name</code> by making a separate request to `https://api.dataforseo.com/v3/app_data/apple/languages`<br>example:<br><code class="long-string">English</code>'
        language_code:
          type: string
          description: '<em>search engine language code</em><br><strong>required field if you don''t specify <code>language_name</code></strong><br>if you use this field, you don''t need to specify <code>language_name</code><br>you can receive the list of available languages with their <code>language_code</code>_by making a separate request to `https://api.dataforseo.com/v3/app_data/apple/languages`<em><br></em>example:<em><br></em><code class="long-string">en</code>'
        priority:
          type: integer
          description: <em>task priority</em><br>optional field<br>can take the following values:<br>1 – normal execution priority (set by default)<br>2 – high execution priority You will be additionally charged for the tasks with high execution priority.<br>The cost can be calculated on the <a title="Pricing" href="https://dataforseo.com/pricing/api/app-store" target="_blank" rel="noopener noreferrer">Pricing</a> page.
          nullable: true
        tag:
          type: string
          description: <em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response
          nullable: true
        postback_url:
          type: string
          description: '<em>URL for sending task results</em><br>optional field<br>once the task is completed, we will send a POST request with its results compressed in the <code>gzip</code> format to the <code>postback_url</code> you specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br>`http://your-server.com/postbackscript?id=$id`<br>`http://your-server.com/postbackscript?id=$id&amp;tag=$tag`<br><strong>Note:</strong> special characters in <code>postback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href="https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api" target="_blank" rel="noopener noreferrer">Help Center</a>'
          nullable: true
        postback_data:
          type: string
          description: <em>postback_url datatype</em><br><strong>required field if you specify <code>postback_url</code></strong><br>corresponds to the datatype that will be sent to your server<br>possible values:<br><code>advanced</code>
        pingback_url:
          type: string
          description: '<em>notification URL of a completed task</em><br>optional field<br>when a task is completed we will notify you by GET request sent to the URL you have specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br>`http://your-server.com/pingscript?id=$id`<br>`http://your-server.com/pingscript?id=$id&amp;tag=$tag`<br><strong>Note:</strong> special characters in <code>pingback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href="https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api" target="_blank" rel="noopener noreferrer">Help Center</a>'
          nullable: true
      example:
        - app_id: '835599320'
          location_code: 2840
          language_code: en
    AppDataAppleAppInfoTaskPostTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: object
              description: '<em>array of results</em><br>in this case, the value will be <code>null</code>'
              nullable: true
    AppDataAppleAppInfoTaskPostResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AppDataAppleAppInfoTaskPostTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    AppDataAppleAppInfoTasksReadyResultInfo:
      type: object
      properties:
        id:
          type: string
          description: <em>task identifier of the completed task</em><br><strong>unique task identifier in our system in the <a href="https://en.wikipedia.org/wiki/Universally_unique_identifier">UUID</a> format</strong>
          nullable: true
        se:
          type: string
          description: <em>search engine specified when setting the task</em>
          nullable: true
        se_type:
          type: string
          description: <em>search engine type</em>
          nullable: true
        date_posted:
          type: string
          description: <em>date when the task was posted (in the UTC format)</em>
          nullable: true
        tag:
          type: string
          nullable: true
        endpoint_advanced:
          type: string
          description: '<em>URL for collecting the results of the {{up_se_name}} {{normal_se_type}} task</em>'
          nullable: true
        endpoint_html:
          type: string
          description: '<em>URL for collecting the results of the {{up_se_name}} {{normal_se_type}} HTML task</em><br>if HTML tasks are not supported in the specified endpoint, the value will be <code>null</code>'
          nullable: true
    AppDataAppleAppInfoTasksReadyTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AppDataAppleAppInfoTasksReadyResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    AppDataAppleAppInfoTasksReadyResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AppDataAppleAppInfoTasksReadyTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    AppStoreInfoOrganic:
      type: object
      properties:
        type:
          type: string
          description: type of element
          nullable: true
        rank_group:
          type: integer
          description: <em>position within a group of elements with identical <code>type</code> values</em><br>positions of elements with different <code>type</code> values are omitted from <code>rank_group</code>
          nullable: true
        rank_absolute:
          type: integer
          description: <em>absolute rank among all the listed apps</em><br>absolute position among all apps on the list
          nullable: true
        position:
          type: string
          description: '<em>the alignment of the element in SERP</em><br>can take the following values: <code>left</code>'
          nullable: true
        app_id:
          type: string
          description: <em>ID of the app</em>
          nullable: true
        title:
          type: string
          description: <em>title of the app</em>
          nullable: true
        subtitle:
          type: string
          description: <em>subtitle of the app</em>
          nullable: true
        url:
          type: string
          description: <em>URL to the app page on App Store</em>
          nullable: true
        icon:
          type: string
          description: <em>URL to the app icon</em>
          nullable: true
        description:
          type: string
          description: <em>description of the app</em>
          nullable: true
        reviews_count:
          type: integer
          description: <em>the total number of reviews of the app</em>
          format: int64
          nullable: true
        rating:
          type: object
          oneOf:
            - $ref: '#/components/schemas/RatingInfo'
          description: <em>average rating of the app</em>
          nullable: true
        price:
          type: object
          oneOf:
            - $ref: '#/components/schemas/PriceInfo'
          description: <em>price of the app</em>
          nullable: true
        is_free:
          type: boolean
          description: <em>indicates whether the app is free</em>
          nullable: true
        main_category:
          type: string
          description: <em>main category/genre of the app</em>
          nullable: true
        categories:
          type: array
          items:
            type: string
            nullable: true
          description: <em>all relevant categories/genres of the app</em><br><strong>Note:</strong> this field returns only one relevant category in the array
          nullable: true
        languages:
          type: array
          items:
            type: string
            nullable: true
          description: <em>languages supported in the app</em><br><strong>Note:</strong> this field returns only one supported language in the array
          nullable: true
        advisories:
          type: array
          items:
            type: string
            nullable: true
          description: <em>age rating and age-based content advisories</em>
          nullable: true
        developer:
          type: string
          description: <em>name of the app developer</em>
          nullable: true
        developer_id:
          type: string
          description: <em>ID of the app developer</em>
          nullable: true
        developer_url:
          type: string
          description: <em>URL to the developer page on App Store</em>
          nullable: true
        version:
          type: string
          description: <em>current version of the app</em>
          nullable: true
        minimum_os_version:
          type: string
          description: <em>minimum OS version required to install the app</em>
          nullable: true
        size:
          type: string
          description: <em>size of the app</em>
          nullable: true
        released_date:
          type: string
          description: '<em>date and time when the app was released</em><br>in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”;<br>example:<br><code>2019-11-15 12:57:46 +00:00</code><br><strong>Note:</strong> this field is deprecated and always returns <code>null</code>'
          nullable: true
        last_update_date:
          type: string
          description: '<em>date and time when the app was last updated</em><br>in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”;<br>example:<br><code>2019-11-15 12:57:46 +00:00</code>'
          nullable: true
        update_notes:
          type: string
          description: <em>update notes</em><br>contains the latest update notes from the developer
          nullable: true
        images:
          type: array
          items:
            type: string
            nullable: true
          description: <em>app images</em><br>contains URLs to the images used on the app page on App Store
          nullable: true
        similar_apps:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/AppsInfo'
            nullable: true
          description: <em>similar apps</em><br>displays apps similar to the app in a POST request
          nullable: true
        more_apps_by_developer:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/AppsInfo'
            nullable: true
          description: <em>similar apps</em><br>information about apps built by the same developer
          nullable: true
    AppDataAppleAppInfoTaskGetAdvancedResultInfo:
      type: object
      properties:
        app_id:
          type: string
          description: <em>application id received in a POST request</em>
          nullable: true
        se_domain:
          type: string
          description: <em>search engine domain in a POST array</em>
          nullable: true
        location_code:
          type: integer
          description: <em>location code in a POST array</em>
          nullable: true
        language_code:
          type: string
          description: <em>language code in a POST array</em>
          nullable: true
        check_url:
          type: string
          description: <em>direct URL to search engine results</em><br>you can use it to make sure that we provided accurate results
          nullable: true
        datetime:
          type: string
          description: '<em>date and time when the result was received</em><br>in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”<br>example:<br><code class="long-string">2019-11-15 12:57:46 +00:00</code>'
          nullable: true
        se_results_count:
          type: integer
          description: <em>the total number of results</em>
          format: int64
          nullable: true
        items_count:
          type: integer
          description: <em>the number of items in the results array</em>
          format: int64
          nullable: true
        items:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/AppStoreInfoOrganic'
            nullable: true
          description: <em>found app info</em>
          nullable: true
    AppDataAppleAppInfoTaskGetAdvancedTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AppDataAppleAppInfoTaskGetAdvancedResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    AppDataAppleAppInfoTaskGetAdvancedResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AppDataAppleAppInfoTaskGetAdvancedTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    AppDataAppleAppListTaskPostRequestInfo:
      type: object
      properties:
        app_collection:
          type: string
          description: 'app collectionrequired fieldapp collection on App Store from which apps will be collected;you can specify the following values:top_free_ios, top_paid_ios, top_grossing_ios, new_ios, new_free_ios, new_paid_ios'
        location_name:
          type: string
          description: 'full name of search engine locationrequired field if you don''t specify location_codeif you use this field, you don''t need to specify location_codeyou can receive the list of available locations of the search engine with their location_name by making a separate request to https://api.dataforseo.com/v3/app_data/apple/locationsexample:West Los Angeles,California,United States'
          nullable: true
        location_code:
          type: integer
          description: 'search engine location coderequired field if you don''t specify location_nameif 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 https://api.dataforseo.com/v3/app_data/apple/locationsexample:9061121'
          nullable: true
        language_name:
          type: string
          description: 'full name of search engine languagerequired field if you don''t specify language_codeif you use this field, you don''t need to specify language_codeyou can receive the list of available languages with language_name by making a separate request to https://api.dataforseo.com/v3/app_data/apple/languagesexample:English'
          nullable: true
        language_code:
          type: string
          description: '"search engine language coderequired field if you don''t specify language_nameif 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 https://api.dataforseo.com/v3/app_data/apple/languagesexample:en'
          nullable: true
        priority:
          type: integer
          description: task priorityoptional fieldcan take the following values:1 – normal execution priority (set by default)2 – high execution priorityYou will be additionally charged for the tasks with high execution priority.The cost can be calculated on the Pricing page.
          nullable: true
        depth:
          type: integer
          description: 'parsing depthoptional fieldnumber of apps to be returned from the App Store SERP;default value: 100maximum value: 100Your account will be billed per each SERP containing up to 100 results; The cost can be calculated on the Pricing page.'
          nullable: true
        app_category:
          type: string
          description: application category on the App Storeoptional fieldyou can filter the results by app category;example:lifestyle;you can review the full list of available categories here or by making a separate request to https://api.dataforseo.com/v3/app_data/apple/categories
          nullable: true
        tag:
          type: string
          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
          nullable: true
        postback_url:
          type: string
          description: 'URL for sending task resultsoptional fieldonce the task is completed, we will send a POST request with its results compressed in the gzip format to the postback_url you specifiedyou can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request.example:http://your-server.com/postbackscript?id=$idhttp://your-server.com/postbackscript?id=$id&tag=$tagNote: special characters in postback_url will be urlencoded; i.a., the # character will be encoded into %23learn more on our Help Center'
          nullable: true
        postback_data:
          type: string
          description: postback_url datatyperequired field if you specify postback_urlcorresponds to the datatype that will be sent to your serverpossible values:advanced
          nullable: true
        pingback_url:
          type: string
          description: 'notification URL of a completed taskoptional fieldwhen a task is completed we will notify you by GET request sent to the URL you have specifiedyou can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request.example:http://your-server.com/pingscript?id=$idhttp://your-server.com/pingscript?id=$id&tag=$tagNote: special characters in pingback_url will be urlencoded; i.a., the # character will be encoded into %23learn more on our Help Center'
          nullable: true
      example:
        - app_collection: top_free_ios
          location_code: 2840
          language_code: en
          app_category: games
    AppDataAppleAppListTaskPostTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: object
              description: 'array of resultsin this case, the value will be null'
              nullable: true
    AppDataAppleAppListTaskPostResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AppDataAppleAppListTaskPostTaskInfo'
                nullable: true
              description: array of tasks
              nullable: true
    AppDataAppleAppListTasksReadyResultInfo:
      type: object
      properties:
        id:
          type: string
          description: <em>task identifier of the completed task</em><br><strong>unique task identifier in our system in the <a href="https://en.wikipedia.org/wiki/Universally_unique_identifier">UUID</a> format</strong>
          nullable: true
        se:
          type: string
          description: <em>search engine specified when setting the task</em>
          nullable: true
        se_type:
          type: string
          description: <em>search engine type</em>
          nullable: true
        date_posted:
          type: string
          description: <em>date when the task was posted (in the UTC format)</em>
          nullable: true
        tag:
          type: string
          nullable: true
        endpoint_advanced:
          type: string
          description: '<em>URL for collecting the results of the {{up_se_name}} {{normal_se_type}} task</em>'
          nullable: true
        endpoint_html:
          type: string
          description: '<em>URL for collecting the results of the {{up_se_name}} {{normal_se_type}} HTML task</em><br>if HTML tasks are not supported in the specified endpoint, the value will be <code>null</code>'
          nullable: true
    AppDataAppleAppListTasksReadyTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AppDataAppleAppListTasksReadyResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    AppDataAppleAppListTasksReadyResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AppDataAppleAppListTasksReadyTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    AppDataAppleAppListTaskGetAdvancedResultInfo:
      type: object
      properties:
        keyword:
          type: string
          description: <em>app collection received in a POST array</em>
          nullable: true
        se_domain:
          type: string
          description: <em>search engine domain in a POST array</em>
          nullable: true
        location_code:
          type: integer
          description: <em>location code in a POST array</em>
          nullable: true
        language_code:
          type: string
          description: <em>language code in a POST array</em>
          nullable: true
        check_url:
          type: string
          description: '<em>direct URL to search engine results</em><br>in this case, the value will be <code>null</code>'
          nullable: true
        datetime:
          type: string
          description: '<em>date and time when the result was received</em><br>in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”<br>example:<br><code class="long-string">2019-11-15 12:57:46 +00:00</code>'
          nullable: true
        se_results_count:
          type: integer
          description: <em>the total number of results</em>
          format: int64
          nullable: true
        items_count:
          type: integer
          description: <em>the number of app items in the results array</em><br>you can get more results by using the <code>depth</code> parameter when setting a task
          format: int64
          nullable: true
        items:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/AppStoreSearchOrganic'
            nullable: true
          description: <em>found apps</em><br>you can get more results by using the <code>depth</code> parameter when setting a task
          nullable: true
    AppDataAppleAppListTaskGetAdvancedTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AppDataAppleAppListTaskGetAdvancedResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    AppDataAppleAppListTaskGetAdvancedResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AppDataAppleAppListTaskGetAdvancedTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    AppDataAppleAppReviewsTaskPostRequestInfo:
      type: object
      properties:
        app_id:
          type: string
          description: <em>id of the app</em><br><strong>required field</strong><br>ID of the mobile application on App Store;<br>you can find the ID in the URL of every app listed on App Store;<br>example:<br>in the URL <code>https://apps.apple.com/us/app/id<strong>835599320</strong></code><br>the id is <code>835599320</code>
        location_name:
          type: string
          description: '<em>full name of search engine location</em><br><strong>required field if you don''t specify <code>location_code</code></strong><br><strong>if you use this field, you don''t need to specify <code>location_code</code></strong><br>you can receive the list of available locations of the search engine with their <code>location_name</code> by making a separate request to <code>https://api.dataforseo.com/v3/app_data/apple/locations</code><br>example:<br><code class="long-string">West Los Angeles,California,United States</code>'
        location_code:
          type: integer
          description: '<em>search engine location code</em><br><strong>required field if you don''t specify <code>location_name</code></strong><br><strong>if you use this field, you don''t need to specify <code>location_name</code></strong><br>you can receive the list of available locations of the search engine with their <code>location_code</code> by making a separate request to <code>https://api.dataforseo.com/v3/app_data/apple/locations</code><br>example:<br><code class="long-string">9061121</code>'
        language_name:
          type: string
          description: '<em>full name of search engine language</em><br><strong>required field if you don''t specify <code>language_code</code></strong><br>if you use this field, you don''t need to specify <code>language_code</code><br>you can receive the list of available languages with <code>language_name</code> by making a separate request to <code>https://api.dataforseo.com/v3/app_data/apple/languages</code><br>example:<br><code class="long-string">English</code>'
        language_code:
          type: string
          description: '<em>search engine language code</em><br><strong>required field if you don''t specify <code>language_name</code></strong><br>if you use this field, you don''t need to specify <code>language_name</code><br>you can receive the list of available languages with their <code>language_code</code>_by making a separate request to <code>https://api.dataforseo.com/v3/app_data/apple/languages</code><em><br></em>example:<em><br></em><code class="long-string">en</code>n'
        priority:
          type: integer
          description: <em>task priority</em><br>optional field<br>can take the following values:<br>1 – normal execution priority (set by default)<br>2 – high execution priorityYou will be additionally charged for the tasks with high execution priority.<br>The cost can be calculated on the <a title="Pricing" href="https://dataforseo.com/pricing/api/app-store" target="_blank" rel="noopener noreferrer">Pricing</a> page.
          nullable: true
        depth:
          type: integer
          description: '<em>parsing depth</em><br>optional field<br>number of reviews to be returned in the API response;<br>we strongly recommend setting the parsing depth in the multiples of 25, because our system processes 25 reviews in a row;<br>default value: <code>25</code>;<br>maximum value: <code>500</code>;<p><strong>Your account will be billed per each SERP containing up to 25 results;</strong> <br>Setting depth above 25 may result in additional charges if the search engine returns more than 25 results</a>;<br>The cost can be calculated on the <a title="Pricing" href="https://dataforseo.com/pricing/app-data/app-store" target="_blank" rel="noopener noreferrer">Pricing</a> page.'
          nullable: true
        sort_by:
          type: string
          description: '<em>results sorting parameters</em><br>optional field<br>you can use this field to sort the results;<br>possible types of sorting:<br><code>most_recent</code> — sort by the most recent reviews;<br><code>most_helpful</code> — sort by the most relevant reviews;<br>default rule: <code>most_helpful</code>'
          nullable: true
        tag:
          type: string
          description: <em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response
          nullable: true
        postback_url:
          type: string
          description: '<em>URL for sending task results</em><br>optional field<br>once the task is completed, we will send a POST request with its results compressed in the <code>gzip</code> format to the <code>postback_url</code> you specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/postbackscript?id=$id</code><br><code>http://your-server.com/postbackscript?id=$id&amp;tag=$tag</code><br><strong>Note:</strong> special characters in <code>postback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href="https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api" target="_blank" rel="noopener noreferrer">Help Center</a>'
          nullable: true
        postback_data:
          type: string
          description: <em>postback_url datatype</em><br><strong>required field if you specify <code>postback_url</code></strong><br>corresponds to the datatype that will be sent to your server<br>possible values:<br><code>advanced</code>
        pingback_url:
          type: string
          description: '<em>notification URL of a completed task</em><br>optional field<br>when a task is completed we will notify you by GET request sent to the URL you have specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/pingscript?id=$id</code><br><code>http://your-server.com/pingscript?id=$id&amp;tag=$tag</code><br><strong>Note:</strong> special characters in <code>pingback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href="https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api" target="_blank" rel="noopener noreferrer">Help Center</a>'
          nullable: true
      example:
        - app_id: '835599320'
          location_code: 2840
          language_code: en
          depth: 200
    AppDataAppleAppReviewsTaskPostTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: object
              description: '<em>array of results</em><br>in this case, the value will be <code>null</code>'
              nullable: true
    AppDataAppleAppReviewsTaskPostResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AppDataAppleAppReviewsTaskPostTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    AppDataAppleAppReviewsTasksReadyResultInfo:
      type: object
      properties:
        id:
          type: string
          description: <em>task identifier of the completed task</em><br><strong>unique task identifier in our system in the <a href="https://en.wikipedia.org/wiki/Universally_unique_identifier">UUID</a> format</strong>
          nullable: true
        se:
          type: string
          description: <em>search engine specified when setting the task</em>
          nullable: true
        se_type:
          type: string
          description: <em>search engine type</em>
          nullable: true
        date_posted:
          type: string
          description: <em>date when the task was posted (in the UTC format)</em>
          nullable: true
        tag:
          type: string
          nullable: true
        endpoint_advanced:
          type: string
          description: '<em>URL for collecting the results of the {{up_se_name}} {{normal_se_type}} task</em>'
          nullable: true
        endpoint_html:
          type: string
          description: '<em>URL for collecting the results of the {{up_se_name}} {{normal_se_type}} HTML task</em><br>if HTML tasks are not supported in the specified endpoint, the value will be <code>null</code>'
          nullable: true
    AppDataAppleAppReviewsTasksReadyTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AppDataAppleAppReviewsTasksReadyResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    AppDataAppleAppReviewsTasksReadyResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AppDataAppleAppReviewsTasksReadyTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    AppStoreReviewsSearch:
      type: object
      properties:
        type:
          type: string
          description: type of element
          nullable: true
        rank_group:
          type: integer
          description: <em>position within a group of elements with identical <code>type</code> values</em><br>positions of elements with different <code>type</code> values are omitted from <code>rank_group</code>
          nullable: true
        rank_absolute:
          type: integer
          description: <em>absolute rank among all the listed reviews</em><br>absolute position among all reviews on the list
          nullable: true
        position:
          type: string
          description: '<em>the alignment of the review in SERP</em><br>can take the following values: <code>left</code>'
          nullable: true
        version:
          type: string
          description: <em>version of the app</em><br>version of the app for which the review is submitted
          nullable: true
        rating:
          type: object
          oneOf:
            - $ref: '#/components/schemas/RatingInfo'
          description: <em>the rating score submitted by the reviewer</em>
          nullable: true
        timestamp:
          type: string
          description: '<em>date and time when the review was published</em><br>in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”;<br>example:<br><code>2019-11-15 12:57:46 +00:00</code>'
          nullable: true
        id:
          type: string
          description: <em>id of the review</em>
          nullable: true
        title:
          type: string
          description: <em>title of the review</em>
          nullable: true
        review_text:
          type: string
          description: <em>content of the review</em>
          nullable: true
        user_profile:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppUserProfileInfo'
          description: <em>user profile of the reviewer</em>
          nullable: true
    AppDataAppleAppReviewsTaskGetAdvancedResultInfo:
      type: object
      properties:
        app_id:
          type: string
          description: <em>application id received in a POST array</em>
          nullable: true
        type:
          type: string
          description: type of element
          nullable: true
        se_domain:
          type: string
          description: <em>search engine domain in a POST array</em>
          nullable: true
        location_code:
          type: integer
          description: <em>location code in a POST array</em>
          nullable: true
        language_code:
          type: string
          description: <em>language code in a POST array</em>
          nullable: true
        check_url:
          type: string
          description: <em>direct URL to search engine results</em><br>you can use it to make sure that we provided accurate results
          nullable: true
        datetime:
          type: string
          description: '<em>date and time when the result was received</em><br>in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”<br>example:<br><code class="long-string">2019-11-15 12:57:46 +00:00</code>'
          nullable: true
        title:
          type: string
          description: <em>title of the app</em><br>title of the application for which the reviews are collected
          nullable: true
        rating:
          type: object
          oneOf:
            - $ref: '#/components/schemas/RatingInfo'
          description: <em>rating of the app</em><br>rating of the application for which the reviews are collected
          nullable: true
        reviews_count:
          type: integer
          description: '<em>the total number of reviews</em><br>in this case, the value will be <code>null</code> as App Store does not indicate the total number of app reviews'
          format: int64
          nullable: true
        items_count:
          type: integer
          description: <em>the number of reviews items in the results array</em><br>you can get more results by using the <code>depth</code> parameter when setting a task
          format: int64
          nullable: true
        items:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/AppStoreReviewsSearch'
            nullable: true
          description: <em>found reviews</em>
          nullable: true
    AppDataAppleAppReviewsTaskGetAdvancedTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AppDataAppleAppReviewsTaskGetAdvancedResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    AppDataAppleAppReviewsTaskGetAdvancedResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AppDataAppleAppReviewsTaskGetAdvancedTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    AppDataAppleAppListingsCategoriesResultInfo:
      type: object
      properties:
        category:
          type: string
          description: <em>name of the supported app category</em>
          nullable: true
        count:
          type: integer
          description: <em>number of app listings that make up the supported app category</em>
          format: int64
          nullable: true
    AppDataAppleAppListingsCategoriesTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AppDataAppleAppListingsCategoriesResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    AppDataAppleAppListingsCategoriesResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AppDataAppleAppListingsCategoriesTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    AppDataAppleAppListingsSearchLiveRequestInfo:
      type: object
      properties:
        categories:
          type: array
          items:
            type: string
          description: <em>app categories</em><br>optional field<br>the categories you specify are used to search for app listings;<br>you can get the full list of available app listing categories by <a href="http://docs.dataforseo.com/v3/app_data/apple/app_listings/categories" rel="noopener noreferrer" target="_blank">this link</a><br>you can specify <strong>up to 10 categories</strong>
          nullable: true
        description:
          type: string
          description: <em>keyword in the app's description</em><br>optional field<br>keywords that occur in the description of the app;<br>can contain up to 200 characters
          nullable: true
        title:
          type: string
          description: <em>keyword in the app's title</em><br>optional field<br>keywords that occur in the title of the app;<br>can contain up to 200 characters
          nullable: true
        filters:
          type: array
          items:
            type: object
            nullable: true
          description: '<em>array of results filtering parameters</em><br>optional field<br><strong>you can add several filters at once (8 filters maximum)</strong><br>you should set a logical operator <code>and</code>, <code>or</code> between the conditions<br>the following operators are supported:<br><code>regex</code>, <code>not_regex</code>, <code>&lt;</code>, <code>&lt;=</code>, <code>&gt;</code>, <code>&gt;=</code>, <code>=</code>, <code>&lt;&gt;</code>, <code>in</code>, <code>not_in</code>, <code>like</code>, <code>not_like</code><br>you can use the <code>%</code> operator with <code>like</code> and <code>not_like</code> to match any string of zero or more characters<br>example:<br><code>["rating.value",">",3]</code><p>you can receive the list of available filters_by making a separate request to <code>https://api.dataforseo.com/v3/app_data/apple/app_listings/available_filters</code>n'
          nullable: true
        order_by:
          type: array
          items:
            type: string
          description: '<em>results sorting rules</em><br>optional field<br>you can use the same values as in the <code>filters</code> array to sort the results<br>possible sorting types:<br><code>asc</code> - results will be sorted in the ascending order<br><code>desc</code> - results will be sorted in the descending order<br>you should use a comma to set up a sorting parameter<br>example:<br><code>["item.rating.value,desc"]</code><p><strong>note that you can set no more than three sorting rules in a single request</strong><br>you should use a comma to separate several sorting rules<br>example:<br><code>["item.rating.value,desc","item.rating.value,desc"]</code>'
          nullable: true
        limit:
          type: integer
          description: '<em>the maximum number of returned apps</em><br>optional field<br>default value: <code>100</code><br>maximum value: <code>1000</code>'
          nullable: true
        offset:
          type: integer
          description: '<em>offset in the results array of returned apps</em><br>optional field<br>default value: <code>0</code><br>if you specify the <code>10</code> value, the first ten entities in the results array will be omitted and the data will be provided for the successive entities<br><strong>Note:</strong> we recommend using this parameter only when retrieving up to 10,000 results<br>for retrieving over 10,000 results, use the <code>offset_token</code> instead.'
          nullable: true
        offset_token:
          type: string
          description: '<em>token for subsequent requests</em><br>optional field<br>provided in the identical filed of the response to each request;<br>use this parameter to avoid timeouts while trying to obtain over 100,000 results in a single request;<br>by specifying the unique <code>offset_token</code> value from the response array, you will get the subsequent results of the initial task;<br><code>offset_token</code> values are unique for each subsequent task <br><strong>Note:</strong> if the <code>offset_token</code> is specified in the request, all other parameters should be identical to the previous request<br>learn more about this parameter on our <a href="https://dataforseo.com/help-center/what-is-the-difference-between-the-offset-and-offset_token-parameters#offset_token" target="_blank">Help Center</a>'
          nullable: true
        tag:
          type: string
          description: <em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response
          nullable: true
      example:
        - title: vpn
          description: vpn
          categories:
            - Utilities
          order_by:
            - 'item.rating.value,desc'
          filters:
            - 
              - item.rating.value
              - '>'
              - 4.5
          limit: 10
    AppDataAppleAppListingsSearchLiveItem:
      type: object
      properties:
        app_id:
          type: string
          description: <em>ID of the returned app</em>
          nullable: true
        se_domain:
          type: string
          description: <em>search engine domain in a POST array</em>
          nullable: true
        location_code:
          type: integer
          description: <em>location code in a POST array</em>
          nullable: true
        language_code:
          type: string
          description: <em>language code in a POST array</em>
          nullable: true
        check_url:
          type: string
          description: <em>direct URL to search engine results</em><br>you can use it to make sure that we provided accurate results
          nullable: true
        time_update:
          type: string
          description: '<em>date and time when SERP data was last updated</em><br>in the <a href="https://en.wikipedia.org/wiki/ISO_8601">ISO 8601</a> format: “YYYY-MM-DDThh:mm:ss.sssssssZ”<br>example:<br><code class="long-string">2023-05-23 10:16:19 +00:00</code>'
          nullable: true
        item:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppStoreInfoOrganic'
          description: <em>detailed information about the app</em>
          nullable: true
    AppDataAppleAppListingsSearchLiveResultInfo:
      type: object
      properties:
        total_count:
          type: integer
          description: <em>the total number of relevant results in the database</em>
          format: int64
          nullable: true
        count:
          type: integer
          description: <em>the number of items in the results array</em>
          format: int64
          nullable: true
        offset:
          type: integer
          description: <em>offset in the results array of returned apps</em>
          nullable: true
        offset_token:
          type: string
          description: '<em>token for subsequent requests</em><br>you can use this parameter in the POST request to avoid timeouts while trying to obtain over 100,000 results in a single request'
          nullable: true
        items:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/AppDataAppleAppListingsSearchLiveItem'
            nullable: true
          description: <em>array of apps and related data</em>
          nullable: true
    AppDataAppleAppListingsSearchLiveTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AppDataAppleAppListingsSearchLiveResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    AppDataAppleAppListingsSearchLiveResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AppDataAppleAppListingsSearchLiveTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    BusinessDataIdListRequestInfo:
      type: object
      properties:
        datetime_from:
          type: string
          description: '<em>start time for filtering results</em><br><strong>required field</strong><br>if <code>include_metadata</code> is set to <code>true</code>, maximum value: a month from current datetime;<br>if <code>include_metadata</code> is set to <code>false</code>, maximum value: six months from current datetime;<br>must be specified in the UTC format: "yyyy-mm-dd hh-mm-ss +00:00"<br>example:<br><code>2023-01-15 12:57:46 +00:00</code>'
        datetime_to:
          type: string
          description: '<em>finish time for filtering results</em><br><strong>required field</strong><br>maximum value: current datetime;<br>must be specified in the UTC format: "yyyy-mm-dd hh-mm-ss +00:00"<br>example:<br><code>2023-01-31 13:57:46 +00:00</code>'
        limit:
          type: integer
          description: '<em>the maximum number of returned task IDs</em><br>optional field<br>default value: <code>1000</code><br>maximum value: <code>1000</code>'
          nullable: true
        offset:
          type: integer
          description: '<em>offset in the results array of returned task IDs</em><br>optional field<br>default value: <code>0</code><br>if you specify the <code>10</code> value, the first ten tasks in the results array will be omitted'
          nullable: true
        sort:
          type: string
          description: '<em>sorting by task execution time</em><br>optional field<br>possible values: <code>"asc"</code>, <code>"desc"</code><br>default value: <code>"asc"</code>'
          nullable: true
        include_metadata:
          type: boolean
          description: '<em>include task metadata in the respond</em><br>optional field<br>default value: <code>false</code>'
          nullable: true
      example:
        - datetime_from: '2026-09-10 11:12:35'
          datetime_to: '2026-09-20 11:12:35'
          limit: 10
          include_metadata: true
    BusinessDataIdListResultInfo:
      type: object
      properties:
        id:
          type: string
          description: <em>task identifier</em><br><strong>unique task identifier in our system in the <a href="https://en.wikipedia.org/wiki/Universally_unique_identifier">UUID</a> format</strong>
          nullable: true
        url:
          type: string
          description: <em>URL of the task</em><br>URL you used for making an API call
          nullable: true
        datetime_posted:
          type: string
          description: '<em>date and time when the task was made</em><br>in the UTC format: "yyyy-mm-dd hh-mm-ss +00:00"<br>example:<br><code>2023-01-15 12:57:46 +00:00</code>'
          nullable: true
        datetime_done:
          type: string
          description: '<em>date and time when the task was completed</em><br>in the UTC format: "yyyy-mm-dd hh-mm-ss +00:00"<br>example:<br><code>2023-01-15 12:57:46 +00:00</code>'
          nullable: true
        status:
          type: string
          description: <em>informational message of the task</em><br>you can find the full list of general informational messages <a href="/v3/appendix-errors/">here</a>
          nullable: true
        cost:
          type: number
          description: '<em>total tasks cost, USD</em>'
          nullable: true
        metadata:
          type: object
          additionalProperties:
            type: object
            nullable: true
          description: <em>contains parameters you specified in the POST request</em>
          nullable: true
    BusinessDataIdListTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/BusinessDataIdListResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    BusinessDataIdListResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/BusinessDataIdListTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    BusinessDataErrorsRequestInfo:
      type: object
      properties:
        limit:
          type: integer
          description: '<em>the maximum number of returned tasks that responded with an error</em><br>optional field<br>default value: <code>1000</code><br>maximum value: <code>1000</code>'
          nullable: true
        offset:
          type: integer
          description: '<em>offset in the results array of returned tasks</em><br>optional field<br>default value: <code>0</code><br>if you specify the <code>10</code> value, the first ten tasks in the results array will be omitted and the data will be provided for the successive tasks'
          nullable: true
        filtered_function:
          type: string
          description: '<em>return tasks with a certain function</em><br>use this field to obtain a list of tasks that returned an error filtered by a certain function<br>you can filter the results by the values you receive in the <code>function</code> fields of the API response<br>i.e., once you receive unfiltered results, you can call this API again to filter them by <code>function</code> <br>example: <code>hotel_searches/task_post</code>, <code>postback_url</code>, <code>pingback_url</code>'
          nullable: true
        datetime_from:
          type: string
          description: '<em>start time for filtering results</em><br>optional field<br>allows filtering results by the <code>datetime</code> parameter within the range of the last 7 days;<br>must be specified in the UTC format: "yyyy-mm-dd hh-mm-ss +00:00"<br>example:<br><code>2021-11-15 12:57:46 +00:00</code>'
          nullable: true
        datetime_to:
          type: string
          description: '<em>finish time for filtering results</em><br>optional field<br>allows filtering results by the <code>datetime</code> parameter within the range of the last 7 days;<br>must be specified in the UTC format: "yyyy-mm-dd hh-mm-ss +00:00"<br>example:<br><code>2021-11-15 13:57:46 +00:00</code>'
          nullable: true
      example:
        - limit: 10
    BusinessDataErrorsResultInfo:
      type: object
      properties:
        id:
          type: string
          description: <em>task identifier</em><br><strong>unique task identifier in our system in the <a href="https://en.wikipedia.org/wiki/Universally_unique_identifier">UUID</a> format</strong>
          nullable: true
        datetime:
          type: string
          description: '<em>date and time when an error occurred</em><br>in the UTC format: "yyyy-mm-dd hh-mm-ss +00:00"<br>example:<br><code>2019-11-15 12:57:46 +00:00</code>'
          nullable: true
        function:
          type: string
          description: <em>corresponding API function</em>
          nullable: true
        error_code:
          type: integer
          description: <em>error code</em>
          nullable: true
        error_message:
          type: string
          description: <em>error message or error URL</em><br>error message <a href="https://docs.dataforseo.com/v3/appendix/errors/" rel="noopener noreferrer" target="_blank">(see full list)</a> or URL that caused an error
          nullable: true
        http_url:
          type: string
          description: <em>URL that caused an error</em><br>URL you used for making an API call or pingback/postback URL
          nullable: true
        http_method:
          type: string
          description: <em>HTTP method</em>
          nullable: true
        http_code:
          type: integer
          description: <em>HTTP status code</em>
          nullable: true
        http_time:
          type: number
          description: '<em>time taken by HTTP request</em><br>for tasks set with a pingback/postback, this field will show the time it took your server to respond'
          nullable: true
        http_response:
          type: string
          description: <em>HTTP response</em><br>server response
          nullable: true
    BusinessDataErrorsTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/BusinessDataErrorsResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    BusinessDataErrorsResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/BusinessDataErrorsTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    BusinessDataBusinessListingsLocationsResultInfo:
      type: object
      properties:
        location_name:
          type: string
          description: <em>full name of the location</em>
          nullable: true
        country_iso_code:
          type: string
          description: <em>ISO country code of the location</em>
          nullable: true
        business_count:
          type: integer
          description: <em>number of businesses in this location in our database</em>
          format: int64
          nullable: true
    BusinessDataBusinessListingsLocationsTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/BusinessDataBusinessListingsLocationsResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    BusinessDataBusinessListingsLocationsResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/BusinessDataBusinessListingsLocationsTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    BusinessDataBusinessListingsCategoriesResultInfo:
      type: object
      properties:
        category_name:
          type: string
          description: <em>full name of the category</em>
          nullable: true
        business_count:
          type: integer
          description: <em>number of businesses in the category</em>
          format: int64
          nullable: true
    BusinessDataBusinessListingsCategoriesTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/BusinessDataBusinessListingsCategoriesResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    BusinessDataBusinessListingsCategoriesResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/BusinessDataBusinessListingsCategoriesTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    BusinessDataBusinessListingsAvailableFiltersResultInfo:
      type: object
      properties:
        search:
          type: object
          additionalProperties:
            type: string
            nullable: true
          nullable: true
        categories_aggregation:
          type: object
          additionalProperties:
            type: string
            nullable: true
          nullable: true
    BusinessDataBusinessListingsAvailableFiltersTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/BusinessDataBusinessListingsAvailableFiltersResultInfo'
                nullable: true
              description: <em>array of results</em><br>contains the full list of available parameters that can be used for data filtration<br>the parameters are grouped by the endpoint they can be used with
              nullable: true
    BusinessDataBusinessListingsAvailableFiltersResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/BusinessDataBusinessListingsAvailableFiltersTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    BusinessDataBusinessListingsSearchLiveRequestInfo:
      type: object
      properties:
        categories:
          type: array
          items:
            type: string
          description: '<em>business categories</em><br>optional field<br>the categories you specify are used to search for business listings;<br>if you don''t use this field, we will return business listings found in the specified location;<br>you can specify <strong>up to 10 categories</strong>'
          nullable: true
        description:
          type: string
          description: <em>description of the element in SERP</em><br>optional field<br>the description of the business entity for which the results are collected;<br>can contain up to 200 characters
          nullable: true
        title:
          type: string
          description: <em>title of the element in SERP</em><br>optional field<br>the name of the business entity for which the results are collected;<br>can contain up to 200 characters
          nullable: true
        is_claimed:
          type: boolean
          description: <em>indicates whether the business is verified by its owner on Google Maps</em><br>optional field
          nullable: true
        location_coordinate:
          type: string
          description: '<em>GPS coordinates of a location</em><br>optional field<br><code>location_coordinate</code> parameter should be specified in the <em>"latitude,longitude,radius"</em> format<br>the maximum number of decimal digits for <em>"latitude"</em> and <em>"longitude"</em>: 7<br>the value of <em>"radius"</em> is specified in kilometres (km)<br>the minimum value for <em>"radius"</em>: <code>1</code><br>the maximum value for <em>"radius"</em>: <code>100000</code><br>example:<br><code class="long-string">53.476225,-2.243572,200</code><br>learn more about how to set location parameters in this API on our <a href="https://dataforseo.com/help-center/how-to-specify-location-settings-in-business-listings-api" target="_blank">Help Center</a>'
          nullable: true
        filters:
          type: array
          items:
            type: object
            nullable: true
          description: '<em>array of results filtering parameters</em><br>optional field<br><strong>you can add several filters at once (8 filters maximum)</strong><br>you should set a logical operator <code>and</code>, <code>or</code> between the conditions<br>the following operators are supported:<br><code>regex</code>, <code>not_regex</code>, <code>&lt;</code>, <code>&lt;=</code>, <code>&gt;</code>, <code>&gt;=</code>, <code>=</code>, <code>&lt;&gt;</code>, <code>in</code>, <code>not_in</code>, <code>like</code>, <code>not_like</code>, <code>ilike</code>, <code>not_ilike</code>, <code>match</code>, <code>not_match</code><br>you can use the <code>%</code> operator with <code>like</code> and <code>not_like</code> to match any string of zero or more characters<br>example:<br><code>["rating.value","&gt;",3]</code><br>you can receive the list of available filters_by making a separate request to <code>https://api.dataforseo.com/v3/business_data/business_listings/available_filters</code><br>The full list of possible filters is available <a href="/v3/business_data/business_listings/filters" rel="noopener noreferrer" target="_blank">here.</a>n'
          nullable: true
        order_by:
          type: array
          items:
            type: string
          description: '<em>results sorting rules</em><br>optional field<br>you can use the same values as in the <code>filters</code> array to sort the results<br>possible sorting types:<br><code>asc</code> - results will be sorted in the ascending order<br><code>desc</code> - results will be sorted in the descending order<br>you should use a comma to set up a sorting parameter<br>example:<br><code>["rating.value,desc"]</code><strong>note that you can set no more than three sorting rules in a single request</strong><br>you should use a comma to separate several sorting rules<br>example:<br><code>["rating.value,desc","rating.votes_count,desc"]</code>'
          nullable: true
        limit:
          type: integer
          description: '<em>the maximum number of returned businesses</em><br>optional field<br>default value: <code>100</code><br>maximum value: <code>1000</code>'
          nullable: true
        offset:
          type: integer
          description: '<em>offset in the results array of returned businesses</em><br>optional field<br>default value: <code>0</code><br>if you specify the <code>10</code> value, the first ten entities in the results array will be omitted and the data will be provided for the successive entities<br><strong>Note:</strong> we recommend using this parameter only when retrieving up to 10,000 results<br>for retrieving over 10,000 results, use the <code>offset_token</code> instead'
          nullable: true
        offset_token:
          type: string
          description: '<em>token for subsequent requests</em><br>optional field<br>provided in the identical filed of the response to each request;<br>use this parameter to avoid timeouts while trying to obtain over 100,000 results in a single request;<br>by specifying the unique <code>offset_token</code> value from the response array, you will get the subsequent results of the initial task;<br><code>offset_token</code> values are unique for each subsequent task<br><strong>Note:</strong> if the <code>offset_token</code> is specified in the request, all other parameters should be identical to the previous request<br>learn more about this parameter on our <a href="https://dataforseo.com/help-center/what-is-the-difference-between-the-offset-and-offset_token-parameters#offset_token" target="_blank">Help Center</a>'
          nullable: true
        tag:
          type: string
          description: <em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response
          nullable: true
      example:
        - categories:
            - pizza_restaurant
          description: pizza
          title: pizza
          is_claimed: true
          location_coordinate: '53.476225,-2.243572,10'
          order_by:
            - 'rating.value,desc'
          filters:
            - 
              - rating.value
              - '>'
              - 3
          limit: 3
    BusinessDataAttributesInfo:
      type: object
      properties:
        available_attributes:
          type: object
          additionalProperties:
            type: array
            items:
              type: string
              nullable: true
            nullable: true
          description: <em>available attributes</em><br>indicates attributes a business entity can offer
          nullable: true
        unavailable_attributes:
          type: object
          additionalProperties:
            type: array
            items:
              type: string
              nullable: true
            nullable: true
          description: <em>unavailable attributes</em><br>indicates attributes a business entity cannot offer
          nullable: true
    PeopleAlsoSearch:
      type: object
      properties:
        cid:
          type: string
          description: <em>google-defined client id</em><br>unique id of a local establishment<br>learn more about the identifier in <a href="https://dataforseo.com/help-center/what-is-cid-place-id-feature-id" target="_blank" rel="noopener noreferrer">this help center article</a>
          nullable: true
        feature_id:
          type: string
          description: <em>the unique identifier of the element in SERP</em><br>learn more about the identifier in <a href="https://dataforseo.com/help-center/what-is-cid-place-id-feature-id" target="_blank" rel="noopener noreferrer">this help center article</a>
          nullable: true
        title:
          type: string
          description: <em>title of the element in SERP</em><br>the name of the business entity for which the results are collected
          nullable: true
        rating:
          type: object
          oneOf:
            - $ref: '#/components/schemas/RatingInfo'
          description: <em>the element's rating </em><br>the popularity rate based on reviews and displayed in SERP
          nullable: true
    BusinessWorkHoursInfo:
      type: object
      properties:
        work_hours:
          type: object
          oneOf:
            - $ref: '#/components/schemas/WorkHours'
          description: <em>open hours</em><br>information about work hours of the local establishment
          nullable: true
    PopularTimes:
      type: object
      properties:
        popular_times_by_days:
          type: object
          additionalProperties:
            type: array
            items:
              type: object
              oneOf:
                - $ref: '#/components/schemas/PopularWorkTimeInfo'
              description: work hours on Sundays
              nullable: true
            nullable: true
          description: <em>popular hours</em><br>information about busy hours of the local establishment on each day of the week
          nullable: true
    BusinessDataContactInfo:
      type: object
      properties:
        type:
          type: string
          description: type of element
          nullable: true
        value:
          type: string
          description: <em>the value of the rating</em>
          nullable: true
        source:
          type: string
          description: <em>data source</em>
          nullable: true
    BusinessDataServiceInfo:
      type: object
      properties:
        category:
          type: string
          description: <em>business category</em><br>Google My Business general category that best describes the services provided by the business entity
          nullable: true
        title:
          type: string
          description: <em>title of the element in SERP</em><br>the name of the business entity for which the results are collected
          nullable: true
        snippet:
          type: string
          description: <em>additional information on the business entity</em>
          nullable: true
        price:
          type: object
          oneOf:
            - $ref: '#/components/schemas/PriceInfo'
          nullable: true
    BusinessDataBusinessListingsSearchLiveItem:
      type: object
      properties:
        type:
          type: string
          description: type of element
          nullable: true
        title:
          type: string
          description: <em>title of the element in SERP</em><br>the name of the business entity for which the results are collected
          nullable: true
        original_title:
          type: string
          description: <em>original title of the element</em><br>original title not translated by Google
          nullable: true
        description:
          type: string
          description: <em>description of the element in SERP</em><br>the description of the business entity for which the results are collected
          nullable: true
        category:
          type: string
          description: <em>business category</em><br>Google My Business general category that best describes the services provided by the business entity
          nullable: true
        category_ids:
          type: array
          items:
            type: string
            nullable: true
          description: <em>global category IDs</em><br>universal category IDs that do not change based on the selected country
          nullable: true
        additional_categories:
          type: array
          items:
            type: string
            nullable: true
          description: <em>additional business categories</em><br>additional Google My Business categories that describe the services provided by the business entity in more detail
          nullable: true
        cid:
          type: string
          description: <em>google-defined client id</em><br>unique id of a local establishment<br>learn more about the identifier in <a href="https://dataforseo.com/help-center/what-is-cid-place-id-feature-id" target="_blank" rel="noopener noreferrer">this help center article</a>
          nullable: true
        feature_id:
          type: string
          description: <em>the unique identifier of the element in SERP</em><br>learn more about the identifier in <a href="https://dataforseo.com/help-center/what-is-cid-place-id-feature-id" target="_blank" rel="noopener noreferrer">this help center article</a>
          nullable: true
        address:
          type: string
          description: <em>address of the business entity</em>
          nullable: true
        address_info:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AddressInfo'
          description: <em>object containing address components of the business entity</em>
          nullable: true
        place_id:
          type: string
          description: <em>unique place identifier</em><br><a href="https://developers.google.com/places/place-id">place id</a> of the local establishment featured in the element<br>learn more about the identifier in <a href="https://dataforseo.com/help-center/what-is-cid-place-id-feature-id" target="_blank" rel="noopener noreferrer">this help center article</a>
          nullable: true
        phone:
          type: string
          description: <em>phone number of the business entity</em>
          nullable: true
        url:
          type: string
          description: <em>absolute url of the business entity</em>
          nullable: true
        domain:
          type: string
          description: <em>domain of the business entity</em>
          nullable: true
        logo:
          type: string
          description: <em>URL of the logo featured in Google My Business profile</em>
          nullable: true
        main_image:
          type: string
          description: <em>URL of the main image featured in Google My Business profile</em>
          nullable: true
        total_photos:
          type: integer
          description: <em>total count of images featured in Google My Business profile</em>
          format: int64
          nullable: true
        snippet:
          type: string
          description: <em>additional information on the business entity</em>
          nullable: true
        latitude:
          type: number
          description: '<i>latitude coordinate of the local establishments in google maps</i><br>example:<br><code>"latitude": 51.584091</code>'
          nullable: true
        longitude:
          type: number
          description: '<i>longitude coordinate of the local establishment in google maps</i><br>example:<br><code>"longitude": -0.31365919999999997</code>'
          nullable: true
        is_claimed:
          type: boolean
          description: <i>shows whether the entity is verified by its owner on Google Maps</i>
          nullable: true
        attributes:
          type: object
          oneOf:
            - $ref: '#/components/schemas/BusinessDataAttributesInfo'
          description: <em>service details in a form of user-reviewed checks;</em><br>service details of a business entity displayed in a form of checks and based on user feedback and business <code>category</code>
          nullable: true
        place_topics:
          type: object
          additionalProperties:
            type: integer
            format: int64
            nullable: true
          description: '<em>keywords mentioned in customer reviews</em><br>contains most popular keywords related to products/services mentioned in customer reviews of a business entity and the number of reviews mentioning each keyword<br>example: <code><br>"place_topics": {<br>"egg roll": 48,<br>"birthday": 33<br>}</code>'
          nullable: true
        rating:
          type: object
          oneOf:
            - $ref: '#/components/schemas/RatingInfo'
          properties:
            rating_type:
              type: string
              description: "the type of rating\nhere you can find the following elements: Max5, Percents, CustomMax"
              nullable: true
            value:
              type: number
              description: the value of the rating
              format: double
              nullable: true
            votes_count:
              type: integer
              description: the amount of feedback
              format: int64
              nullable: true
            rating_max:
              type: number
              description: the maximum value for a rating_type
              format: double
              nullable: true
          description: <em>the element's rating </em><br>the popularity rate based on reviews and displayed in SERP
          nullable: true
        hotel_rating:
          type: integer
          description: '<em>hotel class rating</em><br>class ratings range between 1-5 stars, <a href="https://support.google.com/business/answer/7660515?hl=en" rel="noopener noreferrer" target="_blank">learn more</a><br>if there is no hotel class rating information, the value will be <code>null</code>'
          nullable: true
        price_level:
          type: string
          description: '<em>property price level</em><br>can take values: <code>inexpensive</code>, <code>moderate</code>, <code>expensive</code>, <code>very_expensive</code><br>if there is no price level information, the value will be <code>null</code>'
          nullable: true
        rating_distribution:
          type: object
          additionalProperties:
            type: integer
            format: Int64
            nullable: true
          description: '<em>the distribution of ratings of the business entity</em><br>the object displays the number of 1-star to 5-star ratings, as reviewed by users'
          nullable: true
        people_also_search:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/PeopleAlsoSearch'
            nullable: true
          description: <em>related business entities</em>
          nullable: true
        work_time:
          type: object
          oneOf:
            - $ref: '#/components/schemas/BusinessWorkHoursInfo'
          description: <em>work time details</em><br>information related to operational hours of the business entity
          nullable: true
        popular_times:
          type: object
          oneOf:
            - $ref: '#/components/schemas/PopularTimes'
          description: <em>popular times</em><br>information related to busy hours of the business entity
          nullable: true
        local_business_links:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/BaseLocalBusinessLink'
            nullable: true
          description: <em>available interactions with the business</em><br>list of options to interact with the business directly from search results
          nullable: true
        contact_info:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/BusinessDataContactInfo'
            nullable: true
          description: <em>available contacts of the business</em><br>list of contacts to interact with the business
          nullable: true
        check_url:
          type: string
          description: <em>direct URL to search engine results</em><br>you can use it to make sure that we provided accurate results
          nullable: true
        last_updated_time:
          type: string
          description: '<em>date and time when the data was last updated</em><br>in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”<br>example:<br><code>2023-01-26 09:03:15 +00:00</code>'
          nullable: true
        first_seen:
          type: string
          description: '<em>date and time when our crawler found the business listing element for the first time</em><br>in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”<br>example:<br><code>2023-03-11 10:04:11 +00:00</code>'
          nullable: true
        services:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/BusinessDataServiceInfo'
            nullable: true
          nullable: true
    BusinessDataBusinessListingsSearchLiveResultInfo:
      type: object
      properties:
        total_count:
          type: integer
          description: <em>total number of results in our database relevant to your request</em>
          format: int64
          nullable: true
        count:
          type: integer
          description: <em>item types</em><br>the number of items in the <code>items</code> array
          format: int64
          nullable: true
        offset:
          type: integer
          format: int64
          nullable: true
        offset_token:
          type: string
          nullable: true
        items:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/BusinessDataBusinessListingsSearchLiveItem'
            nullable: true
          description: '<em>encountered item types</em><br>types of search engine results encountered in the <code>items</code> array;<br>possible item types: <code>business_listing</code>'
          nullable: true
    BusinessDataBusinessListingsSearchLiveTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/BusinessDataBusinessListingsSearchLiveResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    BusinessDataBusinessListingsSearchLiveResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/BusinessDataBusinessListingsSearchLiveTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    BusinessDataBusinessListingsCategoriesAggregationLiveRequestInfo:
      type: object
      properties:
        categories:
          type: array
          items:
            type: string
          description: '<em>business categories</em><br>optional field<br>the categories you specify are used to search for business listings;<br>if you don''t use this field, we will return business listings found in the specified location;<br>you can specify <strong>up to 10 categories</strong>'
          nullable: true
        description:
          type: string
          description: <em>description of the element in SERP</em><br>optional field<br>the description of the business entity for which the results are collected;<br>can contain up to 200 characters
          nullable: true
        title:
          type: string
          description: <em>title of the element in SERP</em><br>optional field<br>the name of the business entity for which the results are collected;<br>can contain up to 200 characters
          nullable: true
        is_claimed:
          type: boolean
          description: <em>indicates whether the business is verified by its owner on Google Maps</em><br>optional field
          nullable: true
        location_coordinate:
          type: string
          description: '<em>GPS coordinates of a location</em><br>optional field<br><code>location_coordinate</code> parameter should be specified in the <em>"latitude,longitude,radius"</em> format<br>the maximum number of decimal digits for <em>"latitude"</em> and <em>"longitude"</em>: 7<br>the minimum value for <em>"radius"</em>: <code>1</code><br>the maximum value for <em>"radius"</em>: <code>100000</code><br>example:<br><code class="long-string">53.476225,-2.243572,200</code><br>learn more about how to set location parameters in this API on our <a href="https://dataforseo.com/help-center/how-to-specify-location-settings-in-business-listings-api" target="_blank">Help Center</a>'
          nullable: true
        initial_dataset_filters:
          type: array
          items:
            type: object
            nullable: true
          description: '<em>array of results filtering parameters</em><br>optional field<br><strong>you can add several filters at once (8 filters maximum)</strong><br>you should set a logical operator <code>and</code>, <code>or</code> between the conditions<br>the following operators are supported:<br><code>regex</code>, <code>not_regex</code>, <code>&lt;</code>, <code>&lt;=</code>, <code>&gt;</code>, <code>&gt;=</code>, <code>=</code>, <code>&lt;&gt;</code>, <code>in</code>, <code>not_in</code>, <code>like</code>, <code>not_like</code>, <code>match</code>, <code>not_match</code><br>you can use the <code>%</code> operator with <code>like</code> and <code>not_like</code> to match any string of zero or more characters<br>example:<br><code>["rating.value",">",3]</code><p>you can receive the list of available filters_by making a separate request to <code>https://api.dataforseo.com/v3/business_data/business_listings/available_filters</code><br>the full list of possible filters is available <a href="/v3/business_data/business_listings/filters/?bash" rel="noopener noreferrer" target="_blank">here.</a><br>learn more about the initial dataset filters in <a href="https://dataforseo.com/help-center/what-are-the-initial-dataset-filters-and-how-do-they-work" rel="noopener noreferrer" target="_blank">this help center article.</a>n'
          nullable: true
        internal_list_limit:
          type: integer
          description: '<em>maximum number of elements within internal arrays</em><br>optional field<br>you can use this field to limit the number of elements within the aggregated categories<br>default value: <code>10</code>'
          nullable: true
        limit:
          type: integer
          description: '<em>the maximum number of returned businesses</em><br>optional field<br>default value: <code>100</code><br>maximum value: <code>1000</code>'
          nullable: true
        offset:
          type: integer
          description: <em>the maximum number of returned businesses</em><br>optional field
          nullable: true
        tag:
          type: string
          description: <em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response
          nullable: true
      example:
        - categories:
            - pizza_restaurant
          description: pizza
          title: pizza
          is_claimed: true
          location_coordinate: '53.476225,-2.243572,10'
          initial_dataset_filters:
            - 
              - rating.value
              - '>'
              - 3
          limit: 3
    BusinessListingAggregationInfo:
      type: object
      properties:
        top_categories:
          type: object
          additionalProperties:
            type: integer
            format: int64
            nullable: true
          description: <em>the most mentioned related categories</em><br>top categories displayed with the number of businesses in each category
          nullable: true
        top_countries:
          type: object
          additionalProperties:
            type: integer
            format: int64
            nullable: true
          description: <em>the most mentioned counties</em><br>country codes with the biggest number of businesses in the category
          nullable: true
        websites_count:
          type: integer
          description: <em>number of unique websites</em>
          format: int64
          nullable: true
        count:
          type: integer
          description: <em>item types</em><br>the number of items in the <code>items</code> array
          format: int64
          nullable: true
        top_attributes:
          type: object
          additionalProperties:
            type: integer
            format: int64
            nullable: true
          description: <em>the most mentioned service details</em><br>service details of a business entity displayed in a form of checks and the number of entities mentioning each attribute
          nullable: true
        top_place_topics:
          type: object
          additionalProperties:
            type: integer
            format: int64
            nullable: true
          description: <em>top keywords mentioned in customer reviews</em><br>contains most popular keywords related to products/services mentioned in customer reviews of a business entity and the number of reviews mentioning each keyword
          nullable: true
    BusinessDataBusinessListingsCategoriesAggregationLiveItem:
      type: object
      properties:
        type:
          type: string
          description: type of element
          nullable: true
        categories:
          type: array
          items:
            type: string
            nullable: true
          description: <em>business categories</em><br>Google My Business general category that best describes the cluster of related categories
          nullable: true
        aggregation:
          type: object
          oneOf:
            - $ref: '#/components/schemas/BusinessListingAggregationInfo'
          properties:
            top_categories:
              type: object
              additionalProperties:
                type: integer
                format: int64
                nullable: true
              nullable: true
            top_countries:
              type: object
              additionalProperties:
                type: integer
                format: int64
                nullable: true
              nullable: true
            top_attributes:
              type: object
              additionalProperties:
                type: integer
                format: int64
                nullable: true
              nullable: true
            top_place_topics:
              type: object
              additionalProperties:
                type: integer
                format: int64
                nullable: true
              nullable: true
          description: <em>aggregation of the category</em>
          nullable: true
    BusinessDataBusinessListingsCategoriesAggregationLiveResultInfo:
      type: object
      properties:
        total_count:
          type: integer
          description: <em>total number of results in our database relevant to your request</em>
          format: int64
          nullable: true
        count:
          type: integer
          description: <em>item types</em><br>the number of items in the <code>items</code> array
          format: int64
          nullable: true
        offset:
          type: string
          description: <em>offset in the results array of returned categories</em>
          nullable: true
        offset_token:
          type: object
          description: '<em>token for subsequent requests</em><br>by specifying the unique <code>offset_token</code> when setting a new task, you will get the subsequent results of the initial task;<br><code>offset_token</code> values are unique for each subsequent task'
          nullable: true
        items:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/BusinessDataBusinessListingsCategoriesAggregationLiveItem'
            nullable: true
          description: '<em>encountered item types</em><br>types of search engine results encountered in the <code>items</code> array;<br>possible item types: <code>business_category</code>'
          nullable: true
    BusinessDataBusinessListingsCategoriesAggregationLiveTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/BusinessDataBusinessListingsCategoriesAggregationLiveResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    BusinessDataBusinessListingsCategoriesAggregationLiveResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/BusinessDataBusinessListingsCategoriesAggregationLiveTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    BusinessDataGoogleLocationsResultInfo:
      type: object
      properties:
        location_code:
          type: integer
          description: <em>location code</em>
          nullable: true
        location_name:
          type: string
          description: <em>full name of the location</em>
          nullable: true
        location_name_parent:
          type: string
          description: '<em>the name of the superordinate location</em><br>example:<br><code>"location_code": 9041134,<br>"location_name": "Vienna International Airport,Lower Austria,Austria",<br>"location_name_parent": "Lower Austria,Austria"</code>'
          nullable: true
        country_iso_code:
          type: string
          description: <em>ISO country code of the location</em>
          nullable: true
        location_type:
          type: string
          description: <em>location type</em>
          nullable: true
    BusinessDataGoogleLocationsTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/BusinessDataGoogleLocationsResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    BusinessDataGoogleLocationsResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/BusinessDataGoogleLocationsTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    BusinessDataGoogleLocationsCountryResultInfo:
      type: object
      properties:
        location_code:
          type: integer
          description: <em>location code</em>
          nullable: true
        location_name:
          type: string
          description: <em>full name of the location</em>
          nullable: true
        location_name_parent:
          type: string
          description: '<em>the name of the superordinate location</em><br>example:<br><code>"location_code": 9041134,<br>"location_name": "Vienna International Airport,Lower Austria,Austria",<br>"location_name_parent": "Lower Austria,Austria"</code>'
          nullable: true
        country_iso_code:
          type: string
          description: <em>ISO country code of the location</em>
          nullable: true
        location_type:
          type: string
          description: <em>location type</em>
          nullable: true
    BusinessDataGoogleLocationsCountryTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/BusinessDataGoogleLocationsCountryResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    BusinessDataGoogleLocationsCountryResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/BusinessDataGoogleLocationsCountryTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    BusinessDataGoogleLanguagesResultInfo:
      type: object
      properties:
        language_name:
          type: string
          description: <em>language name</em>
          nullable: true
        language_code:
          type: string
          description: <em>language code according to <a href="https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes" target="_blank" rel="noopener noreferrer">ISO 639-1</a></em>
          nullable: true
    BusinessDataGoogleLanguagesTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/BusinessDataGoogleLanguagesResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    BusinessDataGoogleLanguagesResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/BusinessDataGoogleLanguagesTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    BusinessDataGoogleMyBusinessInfoTaskPostRequestInfo:
      type: object
      properties:
        keyword:
          type: string
          description: '<em>keyword</em><br><strong>required field</strong><br>the keyword you specify should indicate the name of the local establishment<br>you can specify <strong>up to 700 characters</strong> in the <code>keyword</code> filed<br><strong>all %## will be decoded (plus character ‘+’ will be decoded to a space character)</strong><br>if you need to use the “%” character for your <code>keyword</code>, please specify it as “%25”; <p>this field can also be used to pass the following parameters:<br><code>cid</code> - a unique, google-defined id of the business entity;<br><code>place_id</code> - an identifier of the business entity in Google Maps;<p>example:<br><code>cid:194604053573767737</code><br><code>place_id:GhIJQWDl0CIeQUARxks3icF8U8A</code><p>learn more about the <code>cid</code> and <code>place_id</code> identifiers in <a href="https://dataforseo.com/help-center/what-is-cid-place-id-feature-id" rel="noopener noreferrer" target="_blank">this help center article</a><p>learn more about rules and limitations of <code>keyword</code> and <code>keywords</code> fields in DataForSEO APIs in this <a href="https://dataforseo.com/help-center/rules-and-limitations-of-keyword-and-keywords-fields-in-dataforseo-apis" rel="noopener noreferrer" target="_blank">Help Center article</a>'
        priority:
          type: integer
          description: <em>task priority</em><br>optional field<br>can take the following values:<br>1 – normal execution priority (set by default)<br>2 – high execution priorityYou will be additionally charged for the tasks with high execution priority.<br>The cost can be calculated on the <a title="Pricing" href="https://dataforseo.com/pricing/business-data/business-data-api" target="_blank" rel="noopener noreferrer">Pricing</a> page.
          nullable: true
        location_name:
          type: string
          description: '<em>full name of search engine location</em><br><strong>required field if you don''t specify</strong> <code>location_code</code> or <code>location_coordinate</code><br><strong>if you use this field, you don''t need to specify <code>location_code</code> or <code>location_coordinate</code></strong><br>you can receive the list of available locations with <code>location_name</code> by making a separate request to <code>https://api.dataforseo.com/v3/business_data/google/locations</code><br>example:<br><code class="long-string">London,England,United Kingdom</code>'
        location_code:
          type: integer
          description: '<em>search engine location code</em><br><strong>required field if you don''t specify</strong> <code>location_name</code>_or <code>location_coordinate</code><br><strong>if you use this field, you don''t need to specify <code>location_name</code> or <code>location_coordinate</code></strong><br>you can receive the list of available locations with <code>location_code</code> by making a separate request to the <code>https://api.dataforseo.com/v3/business_data/google/locations</code><br>example:<br><code class="long-string">2840</code>n'
        location_coordinate:
          type: string
          description: '<em>GPS coordinates of a location</em><br><strong>required field if you don''t specify</strong> <code>location_name</code>_or <code>location_code</code><br><strong>if you use this field, you don''t need to specify <code>location_name</code> or <code>location_code</code></strong><br><code>location_coordinate</code> parameter should be specified in the <em>"latitude,longitude,radius"</em> format<br>the maximum number of decimal digits for <em>"latitude"</em> and <em>"longitude"</em>: 7<br>the minimum value for <em>"radius"</em>: 199.9 (mm)<br>the maximum value for <em>"radius"</em>: 199999 (mm)<br>example:<br><code class="long-string">53.476225,-2.243572,200</code>n'
        language_name:
          type: string
          description: '<em>full name of search engine language</em><br><strong>required field if you don''t specify</strong> <code>language_code</code><br><strong>if you use this field, you don''t need to specify <code>language_code</code></strong><br>you can receive the list of available languages with <code>language_name</code> by making a separate request to <code>https://api.dataforseo.com/v3/business_data/google/languages</code><br>example:<br><code class="long-string">English</code>'
        language_code:
          type: string
          description: '<em>search engine language code</em><br><strong>required field if you don''t specify</strong> <code>language_name</code><br><strong>if you use this field, you don''t need to specify <code>language_name</code></strong><br>you can receive the list of available languages with their <code>language_code</code>_by making a separate request to <code>https://api.dataforseo.com/v3/business_data/google/languages</code><em><br></em>example:<em><br></em><code class="long-string">en</code>n'
        tag:
          type: string
          description: <em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response
          nullable: true
        postback_url:
          type: string
          description: '<em>URL for sending task results</em><br>optional field<br>once the task is completed, we will send a POST request with its results compressed in the <code>gzip</code> format to the <code>postback_url</code> you specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/postbackscript?id=$id</code><br><code>http://your-server.com/postbackscript?id=$id&amp;tag=$tag</code><br><strong>Note:</strong> special characters in <code>postback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href="https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api" target="_blank" rel="noopener noreferrer">Help Center</a>'
          nullable: true
        pingback_url:
          type: string
          description: '<em>notification URL of a completed task</em><br>optional field<br>when a task is completed we will notify you by GET request sent to the URL you have specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/pingscript?id=$id</code><br><code>http://your-server.com/pingscript?id=$id&amp;tag=$tag</code><br><strong>Note:</strong> special characters in <code>pingback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href="https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api" target="_blank" rel="noopener noreferrer">Help Center</a>'
          nullable: true
      example:
        - language_code: en
          location_name: 'New York,New York,United States'
          keyword: 'RustyBrick, Inc.'
    BusinessDataGoogleMyBusinessInfoTaskPostTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: object
              description: '<em>array of results</em><br>in this case, the value will be <code>null</code>'
              nullable: true
    BusinessDataGoogleMyBusinessInfoTaskPostResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/BusinessDataGoogleMyBusinessInfoTaskPostTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    BusinessDataGoogleMyBusinessInfoTasksReadyResultInfo:
      type: object
      properties:
        id:
          type: string
          description: <em>task identifier of the completed task</em><br><strong>unique task identifier in our system in the <a href="https://en.wikipedia.org/wiki/Universally_unique_identifier">UUID</a> format</strong>
          nullable: true
        se:
          type: string
          description: '<em>search engine specified when setting the task</em><br>can take the following values: <code>google</code>'
          nullable: true
        se_type:
          type: string
          description: <em>search engine specified when setting the task</em>
          nullable: true
        date_posted:
          type: string
          description: <em>date when the task was posted (in the UTC format)</em>
          nullable: true
        tag:
          type: string
          description: <em>user-defined task identifier</em>
          nullable: true
        endpoint:
          type: string
          description: <em>URL for collecting the results of the task</em>
          nullable: true
    BusinessDataGoogleMyBusinessInfoTasksReadyTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/BusinessDataGoogleMyBusinessInfoTasksReadyResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    BusinessDataGoogleMyBusinessInfoTasksReadyResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/BusinessDataGoogleMyBusinessInfoTasksReadyTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    BusinessDataTasksReadyResultInfo:
      type: object
      properties:
        id:
          type: string
          description: <em>task identifier of the completed task</em><br><strong>unique task identifier in our system in the <a href="https://en.wikipedia.org/wiki/Universally_unique_identifier">UUID</a> format</strong>
          nullable: true
        se:
          type: string
          description: '<em>search engine specified when setting the task</em><br>can take the following values: <code>tripadvisor</code>'
          nullable: true
        se_type:
          type: string
          description: <em>search engine type</em>
          nullable: true
        date_posted:
          type: string
          description: <em>date when the task was posted (in the UTC format)</em>
          nullable: true
        tag:
          type: string
          description: <em>user-defined task identifier</em>
          nullable: true
        endpoint:
          type: string
          description: <em>URL for collecting the results of the task</em>
          nullable: true
    BusinessDataTasksReadyTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/BusinessDataTasksReadyResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    BusinessDataTasksReadyResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/BusinessDataTasksReadyTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    MapsSearch:
      type: object
      properties:
        type:
          type: string
          description: type of element
          nullable: true
        rank_group:
          type: integer
          description: <em>position within a group of elements with identical <code>type</code> values</em><br>positions of elements with different <code>type</code> values are omitted from the <code>rank_group</code>
          nullable: true
        rank_absolute:
          type: integer
          description: <em>absolute rank among all the elements</em>
          nullable: true
        domain:
          type: string
          description: <em>domain of the business entity</em>
          nullable: true
        title:
          type: string
          description: '<em>directory title</em><br>can take the following values: <code>At this place</code>, <code>Directory</code>'
          nullable: true
        url:
          type: string
          description: <em>URL to view the menu</em>
          nullable: true
        rating:
          type: object
          oneOf:
            - $ref: '#/components/schemas/RatingInfo'
          description: <em>the element's rating </em><br>the popularity rate based on reviews and displayed in SERP
          nullable: true
        rating_distribution:
          type: object
          additionalProperties:
            type: integer
            format: Int64
            nullable: true
          description: "the distribution of ratings of the business entity\nthe object displays the number of 1-star to 5-star ratings, as reviewed by users"
          nullable: true
        snippet:
          type: string
          description: <em>additional information about the business entity</em>
          nullable: true
        address:
          type: string
          description: <em>address of the business entity</em>
          nullable: true
        address_info:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AddressInfo'
          description: <em>object containing address components of the business entity</em>
          nullable: true
        place_id:
          type: string
          description: <em>unique place identifier</em><br><a href="https://developers.google.com/places/place-id">place id</a> of the local establishment featured in the element<br>learn more about the identifier in <a href="https://dataforseo.com/help-center/what-is-cid-place-id-feature-id" target="_blank" rel="noopener noreferrer">this help center article</a>
          nullable: true
        phone:
          type: string
          description: <em>phone number of the business entity</em>
          nullable: true
        main_image:
          type: string
          description: <em>URL of the main image featured in Google My Business profile</em>
          nullable: true
        total_photos:
          type: string
          description: <em>total count of images featured in Google My Business profile</em>
          format: int64
          nullable: true
        category:
          type: string
          description: <em>business category</em><br>Google My Business general category that best describes the services provided by the business entity
          nullable: true
        additional_categories:
          type: array
          items:
            type: string
          description: <em>additional business categories</em><br>additional Google My Business categories that describe the services provided by the business entity in more detail
          nullable: true
        price_level:
          type: string
          description: '<em>property price level</em><br>can take values: <code>inexpensive</code>, <code>moderate</code>, <code>expensive</code>, <code>very_expensive</code><br>if there is no price level information, the value will be <code>null</code>'
          nullable: true
        hotel_rating:
          type: string
          description: '<em>hotel class rating</em><br>class ratings range between 1-5 stars, <a href="https://support.google.com/business/answer/7660515?hl=en" rel="noopener noreferrer" target="_blank">learn more</a><br>if there is no hotel class rating information, the value will be <code>null</code>'
          nullable: true
        category_ids:
          type: array
          items:
            type: string
          description: <em>global category IDs</em><br>universal category IDs that do not change based on the selected country
          nullable: true
        work_hours:
          type: object
          oneOf:
            - $ref: '#/components/schemas/BusinessWorkHoursInfo'
          description: <em>open hours</em><br>information about work hours of the local establishment
          nullable: true
        feature_id:
          type: string
          description: <em>the unique identifier of the element in SERP</em><br>learn more about the identifier in <a href="https://dataforseo.com/help-center/what-is-cid-place-id-feature-id" target="_blank" rel="noopener noreferrer">this help center article</a>
          nullable: true
        cid:
          type: string
          description: <em>google-defined client id</em><br>unique id of a local establishment;<br>can be used with <a href="/v3/reviews/google/overview/?php" target="_blank" rel="noopener noreferrer">Google Reviews API</a> to get a full list of reviews<br>learn more about the identifier in <a href="https://dataforseo.com/help-center/what-is-cid-place-id-feature-id" target="_blank" rel="noopener noreferrer">this help center article</a>
          nullable: true
        latitude:
          type: number
          description: '<i>latitude coordinate of the local establishments in google maps</i><br>example:<br><code>"latitude": 51.584091</code>'
          nullable: true
        longitude:
          type: number
          description: '<i>longitude coordinate of the local establishment in google maps</i><br>example:<br><code>"longitude": -0.31365919999999997</code>'
          nullable: true
        is_claimed:
          type: boolean
          description: <i>shows whether the entity is verified by its owner on Google Maps</i>
          nullable: true
        local_justifications:
          type: array
          items:
            type: string
          description: <em>Google local justifications</em><br>snippets of text that “justify” why the business is showing up for search query
          nullable: true
        is_directory_item:
          type: boolean
          description: '<em>business establishment is a part of the directory</em><br>indicates whether the business establishment is a part of the directory;<br>if <code>true</code>, the item is a part of the larger directory of businesses with the same address (e.g., a mall or a business centre);<br><strong>note:</strong> if the business establishment is a parent item in the directory, the value will be <code>null</code>'
          nullable: true
    BusinessDirectoryInfo:
      type: object
      properties:
        title:
          type: string
          description: <em>title of the element</em><br>domain of the online menu system
          nullable: true
        items:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/MapsSearch'
            nullable: true
          description: '<em>encountered item types</em><br>types of search engine results encountered in the <code>items</code> array;<br>possible item types: <code>google_business_info</code>'
          nullable: true
    GoogleBusinessInfo:
      type: object
      properties:
        type:
          type: string
          description: type of element
          nullable: true
        rank_group:
          type: integer
          description: <em>position within a group of elements with identical <code>type</code> values</em><br>positions of elements with different <code>type</code> values are omitted from <code>rank_group</code>
          nullable: true
        rank_absolute:
          type: integer
          description: <em>absolute rank among all the elements</em>
          nullable: true
        position:
          type: string
          description: <em>the alignment in SERP</em>
          nullable: true
        title:
          type: string
          description: <em>title of the element in SERP</em><br>the name of the business entity for which the results are collected
          nullable: true
        original_title:
          type: string
          description: <em>original title of the element</em><br>original title not translated by Google
          nullable: true
        description:
          type: string
          description: <em>description of the element in SERP</em><br>the description of the business entity for which the results are collected
          nullable: true
        category:
          type: string
          description: <em>business category</em><br>Google My Business general category that best describes the services provided by the business entity
          nullable: true
        category_ids:
          type: array
          items:
            type: string
          description: <em>global category IDs</em><br>universal category IDs that do not change based on the selected country
          nullable: true
        additional_categories:
          type: array
          items:
            type: string
          description: <em>additional business categories</em><br>additional Google My Business categories that describe the services provided by the business entity in more detail
          nullable: true
        cid:
          type: string
          description: <em>google-defined client id</em><br>unique id of a local establishment;<br>can be used with <a href="/v3/reviews/google/overview/?php" target="_blank" rel="noopener noreferrer">Google Reviews API</a> to get a full list of reviews<br>learn more about the identifier in <a href="https://dataforseo.com/help-center/what-is-cid-place-id-feature-id" target="_blank" rel="noopener noreferrer">this help center article</a>
          nullable: true
        feature_id:
          type: string
          description: <em>the unique identifier of the element in SERP</em><br>learn more about the identifier in <a href="https://dataforseo.com/help-center/what-is-cid-place-id-feature-id" target="_blank" rel="noopener noreferrer">this help center article</a>
          nullable: true
        address:
          type: string
          description: <em>address of the business entity</em>
          nullable: true
        address_info:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AddressInfo'
          description: <em>object containing address components of the business entity</em>
          nullable: true
        place_id:
          type: string
          description: <em>unique place identifier</em><br><a href="https://developers.google.com/places/place-id">place id</a> of the local establishment featured in the element<br>learn more about the identifier in <a href="https://dataforseo.com/help-center/what-is-cid-place-id-feature-id" target="_blank" rel="noopener noreferrer">this help center article</a>
          nullable: true
        phone:
          type: string
          description: <em>phone number of the business entity</em>
          nullable: true
        url:
          type: string
          description: <em>absolute url of the business entity</em>
          nullable: true
        contact_url:
          type: string
          description: <em>URL of the preferred contact page</em>
          nullable: true
        contributor_url:
          type: string
          description: '<em>URL of the user''s or entity''s Local Guides profile, if available</em>'
          nullable: true
        book_online_url:
          type: string
          description: <em>URL in the 'book online' button of the element</em><br>URL directing users to the online booking or order page of the business entity
          nullable: true
        domain:
          type: string
          description: <em>domain of the business entity</em>
          nullable: true
        logo:
          type: string
          description: <em>URL of the logo featured in Google My Business profile</em>
          nullable: true
        main_image:
          type: string
          description: <em>URL of the main image featured in Google My Business profile</em>
          nullable: true
        total_photos:
          type: integer
          description: <em>total count of images featured in Google My Business profile</em>
          format: int64
          nullable: true
        snippet:
          type: string
          description: <em>additional information on the business entity</em>
          nullable: true
        latitude:
          type: number
          description: '<i>latitude coordinate of the local establishments in google maps</i><br>example:<br><code>"latitude": 51.584091</code>'
          nullable: true
        longitude:
          type: number
          description: '<i>longitude coordinate of the local establishment in google maps</i><br>example:<br><code>"longitude": -0.31365919999999997</code>'
          nullable: true
        is_claimed:
          type: boolean
          description: <i>shows whether the entity is verified by its owner on Google Maps</i>
          nullable: true
        questions_and_answers_count:
          type: integer
          nullable: true
        attributes:
          type: object
          oneOf:
            - $ref: '#/components/schemas/BusinessDataAttributesInfo'
          description: <em>service details in a form of user-reviewed checks;</em><br>service details of a business entity displayed in a form of checks and based on user feedback and business <code>category</code>
          nullable: true
        place_topics:
          type: object
          additionalProperties:
            type: integer
            format: int64
            nullable: true
          description: '<em>keywords mentioned in customer reviews</em><br>contains most popular keywords related to products/services mentioned in customer reviews of a business entity and the number of reviews mentioning each keyword<br>example: <code><br>"place_topics": {<br>"egg roll": 48,<br>"birthday": 33<br>}</code>'
          nullable: true
        rating:
          type: object
          oneOf:
            - $ref: '#/components/schemas/RatingInfo'
          description: <em>the element's rating </em><br>the popularity rate based on reviews and displayed in SERP
          nullable: true
        hotel_rating:
          type: number
          description: '<em>hotel class rating</em><br>class ratings range between 1-5 stars, <a href="https://support.google.com/business/answer/7660515?hl=en" rel="noopener noreferrer" target="_blank">learn more</a><br>if there is no hotel class rating information, the value will be <code>null</code>'
          nullable: true
        price_level:
          type: string
          description: '<em>property price level</em><br>can take values: <code>inexpensive</code>, <code>moderate</code>, <code>expensive</code>, <code>very_expensive</code><br>if there is no price level information, the value will be <code>null</code>'
          nullable: true
        rating_distribution:
          type: object
          additionalProperties:
            type: integer
            format: Int64
            nullable: true
          description: '<em>the distribution of ratings of the business entity</em><br>the object displays the number of 1-star to 5-star ratings, as reviewed by users'
          nullable: true
        people_also_search:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/PeopleAlsoSearch'
            nullable: true
          description: <em>related business entities</em>
          nullable: true
        work_time:
          type: object
          oneOf:
            - $ref: '#/components/schemas/BusinessWorkHoursInfo'
          description: <em>work time details</em><br>information related to operational hours of the business entity
          nullable: true
        popular_times:
          type: object
          oneOf:
            - $ref: '#/components/schemas/PopularTimes'
          description: <em>popular times</em><br>information related to busy hours of the business entity
          nullable: true
        local_business_links:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/BaseLocalBusinessLink'
            nullable: true
          description: <em>available interactions with the business</em><br>list of options to interact with the business directly from search results
          nullable: true
        is_directory_item:
          type: boolean
          description: '<em>business establishment is a part of the directory</em><br>indicates whether the business establishment is a part of the directory;<br>if <code>true</code>, the item is a part of the larger directory of businesses with the same address (e.g., a mall or a business centre);<br><strong>note:</strong> if the business establishment is a parent item in the directory, the value will be <code>null</code>'
          nullable: true
        directory:
          type: object
          oneOf:
            - $ref: '#/components/schemas/BusinessDirectoryInfo'
          description: <em>items of the directory</em><br>includes information about businesses that are located within the target business establishment and have the same address
          nullable: true
        services:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/BusinessDataServiceInfo'
            nullable: true
          description: <em>list of services offered by the business</em>
          nullable: true
    BusinessDataGoogleMyBusinessInfoTaskGetResultInfo:
      type: object
      properties:
        keyword:
          type: string
          description: <em>keyword received in a POST array</em><br><strong>keyword is returned with decoded %## (plus character '+' will be decoded to a space character)</strong><br>this field will contain the <code>cid</code> parameter if you specified it in the <code>keyword</code> field when setting a task;<br>example:<br><code>cid:2946633002421908862</code><br>learn more about the parameter in <a href="https://dataforseo.com/help-center/what-is-cid-place-id-feature-id" target="_blank" rel="noopener noreferrer">this help center article</a>
          nullable: true
        se_domain:
          type: string
          description: <em>search engine domain as specified in a POST array</em>
          nullable: true
        location_code:
          type: integer
          description: <em>location code in a POST array</em>
          nullable: true
        language_code:
          type: string
          description: <em>language code in a POST array</em>
          nullable: true
        check_url:
          type: string
          description: <em>direct URL to search engine results</em><br>you can use it to make sure that we provided accurate results
          nullable: true
        datetime:
          type: string
          description: '<em>date and time when the result was received</em><br>in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”<br>example:<br><code class="long-string">2019-11-15 12:57:46 +00:00</code>'
          nullable: true
        item_types:
          type: array
          items:
            type: string
            nullable: true
          description: '<em>item types</em><br>types of search engine results encountered in the <code>items</code> array;<br>possible item types: <code>google_business_info</code>'
          nullable: true
        items_count:
          type: integer
          description: <em>item types</em><br>the number of items in the <code>items</code> array
          format: int64
          nullable: true
        items:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/GoogleBusinessInfo'
            nullable: true
          description: <em><strong>array of directory items</strong></em>
          nullable: true
    BusinessDataGoogleMyBusinessInfoTaskGetTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/BusinessDataGoogleMyBusinessInfoTaskGetResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    BusinessDataGoogleMyBusinessInfoTaskGetResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/BusinessDataGoogleMyBusinessInfoTaskGetTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    BusinessDataGoogleMyBusinessInfoLiveRequestInfo:
      type: object
      properties:
        keyword:
          type: string
          description: '<em>keyword</em><br><strong>required field</strong><br>the keyword you specify should indicate the name of the local establishment<br>you can specify <strong>up to 700 characters</strong> in the <code>keyword</code> filed<br><strong>all %## will be decoded (plus character ‘+’ will be decoded to a space character)</strong><br>if you need to use the “%” character for your <code>keyword</code>, please specify it as “%25”; <p>this field can also be used to pass the following parameters:<br><code>cid</code> - a unique, google-defined id of the business entity;<br><code>place_id</code> - an identifier of the business entity in Google Maps;<p>example:<br><code>cid:194604053573767737</code><br><code>place_id:GhIJQWDl0CIeQUARxks3icF8U8A</code><p>learn more about the <code>cid</code> and <code>place_id</code> identifiers in <a href="https://dataforseo.com/help-center/what-is-cid-place-id-feature-id" rel="noopener noreferrer" target="_blank">this help center article</a><p>learn more about rules and limitations of <code>keyword</code> and <code>keywords</code> fields in DataForSEO APIs in this <a href="https://dataforseo.com/help-center/rules-and-limitations-of-keyword-and-keywords-fields-in-dataforseo-apis" rel="noopener noreferrer" target="_blank">Help Center article</a>'
        location_name:
          type: string
          description: '<em>full name of search engine location</em><br><strong>required field if you don''t specify</strong> <code>location_code</code> or <code>location_coordinate</code><br><strong>if you use this field, you don''t need to specify <code>location_code</code> or <code>location_coordinate</code></strong><br>you can receive the list of available locations with <code>location_name</code> by making a separate request to <code>https://api.dataforseo.com/v3/business_data/google/locations</code><br>example:<br><code class="long-string">London,England,United Kingdom</code>'
        location_code:
          type: integer
          description: '<em>search engine location code</em><br><strong>required field if you don''t specify</strong> <code>location_name</code>_or <code>location_coordinate</code><br><strong>if you use this field, you don''t need to specify <code>location_name</code> or <code>location_coordinate</code></strong><br>you can receive the list of available locations with <code>location_code</code> by making a separate request to the <code>https://api.dataforseo.com/v3/business_data/google/locations</code><br>example:<br><code class="long-string">2840</code>n'
        location_coordinate:
          type: string
          description: '<em>GPS coordinates of a location</em><br><strong>required field if you don''t specify</strong> <code>location_name</code>_or <code>location_code</code><br><strong>if you use this field, you don''t need to specify <code>location_name</code> or <code>location_code</code></strong><br><code>location_coordinate</code> parameter should be specified in the <em>"latitude,longitude,radius"</em> format<br>the maximum number of decimal digits for <em>"latitude"</em> and <em>"longitude"</em>: 7<br>the minimum value for <em>"radius"</em>: 199.9 (mm)<br>the maximum value for <em>"radius"</em>: 199999 (mm)<br>example:<br><code class="long-string">53.476225,-2.243572,200</code>n'
        language_name:
          type: string
          description: '<em>full name of search engine language</em><br><strong>required field if you don''t specify</strong> <code>language_code</code><br><strong>if you use this field, you don''t need to specify <code>language_code</code></strong><br>you can receive the list of available languages with <code>language_name</code> by making a separate request to <code>https://api.dataforseo.com/v3/business_data/google/languages</code><br>example:<br><code class="long-string">English</code>'
        language_code:
          type: string
          description: '<em>search engine language code</em><br><strong>required field if you don''t specify</strong> <code>language_name</code><br><strong>if you use this field, you don''t need to specify <code>language_name</code></strong><br>you can receive the list of available languages with their <code>language_code</code>_by making a separate request to <code>https://api.dataforseo.com/v3/business_data/google/languages</code><em><br></em>example:<em><br></em><code class="long-string">en</code>n'
        tag:
          type: string
          description: <em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response
          nullable: true
      example:
        - language_code: en
          location_name: 'New York,New York,United States'
          keyword: 'RustyBrick, Inc.'
    MentionCarouselElement:
      type: object
      properties:
        type:
          type: string
          description: type of element
          nullable: true
        title:
          type: string
          description: title of the row
          nullable: true
        price:
          type: object
          oneOf:
            - $ref: '#/components/schemas/PriceInfo'
          description: price of the app element
          nullable: true
        rating:
          type: object
          oneOf:
            - $ref: '#/components/schemas/RatingInfo'
          description: "the element’s rating \nthe popularity rate based on reviews and displayed in SERP"
          nullable: true
        mentioned_in:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/LinkElement'
            nullable: true
          description: additional elements in the mention_carousel item
          nullable: true
    BusinessDataGoogleMyBusinessInfoLiveResultInfo:
      type: object
      properties:
        keyword:
          type: string
          description: <em>keyword received in a POST array</em><br><strong>keyword is returned with decoded %## (plus character '+' will be decoded to a space character)</strong><br>this field will contain the <code>cid</code> parameter if you specified it in the <code>keyword</code> field when setting a task;<br>example:<br><code>cid:2946633002421908862</code><br>learn more about the parameter in <a href="https://dataforseo.com/help-center/what-is-cid-place-id-feature-id" target="_blank" rel="noopener noreferrer">this help center article</a>
          nullable: true
        se_domain:
          type: string
          description: <em>search engine domain as specified in a POST array</em>
          nullable: true
        location_code:
          type: integer
          description: <em>location code in a POST array</em>
          nullable: true
        language_code:
          type: string
          description: <em>language code in a POST array</em>
          nullable: true
        check_url:
          type: string
          description: <em>direct URL to search engine results</em><br>you can use it to make sure that we provided accurate results
          nullable: true
        datetime:
          type: string
          description: '<em>date and time when the result was received</em><br>in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”<br>example:<br><code class="long-string">2019-11-15 12:57:46 +00:00</code>'
          nullable: true
        item_types:
          type: array
          items:
            type: string
            nullable: true
          description: '<em>item types</em><br>types of search engine results encountered in the <code>items</code> array;<br>possible item types: <code>google_business_info</code>'
          nullable: true
        items_count:
          type: integer
          description: <em>item types</em><br>the number of items in the <code>items</code> array
          format: int64
          nullable: true
        items:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/GoogleBusinessInfo'
            nullable: true
          description: '<em>encountered item types</em><br>types of search engine results encountered in the <code>items</code> array;<br>possible item types: <code>google_business_info</code>'
          nullable: true
    BusinessDataGoogleMyBusinessInfoLiveTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/BusinessDataGoogleMyBusinessInfoLiveResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    BusinessDataGoogleMyBusinessInfoLiveResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/BusinessDataGoogleMyBusinessInfoLiveTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    BusinessDataGoogleMyBusinessUpdatesTaskPostRequestInfo:
      type: object
      properties:
        keyword:
          type: string
          description: '<em>keyword</em><br><strong>required field</strong><br>the keyword you specify should indicate the name of the local establishment<br>you can specify <strong>up to 700 characters</strong> in the <code>keyword</code> filed<br><strong>all %## will be decoded (plus character ‘+’ will be decoded to a space character)</strong><br>if you need to use the “%” character for your <code>keyword</code>, please specify it as “%25”;this field can also be used to pass <code>cid</code> (unique, google-defined id of the business entity) or <code>place_id</code> (identifier of the business entity in Google Maps) parameters<br>example:<br><code>cid:194604053573767737</code><br><code>place_id:GhIJQWDl0CIeQUARxks3icF8U8A</code><p>learn more about the <code>cid</code> and <code>place_id</code> identifiers in <a href="https://dataforseo.com/help-center/what-is-cid-place-id-feature-id" rel="noopener noreferrer" target="_blank">this help center article</a>'
        priority:
          type: integer
          description: <em>task priority</em><br>optional field<br>can take the following values:<br>1 – normal execution priority (set by default)<br>2 – high execution priorityYou will be additionally charged for the tasks with high execution priority.<br>The cost can be calculated on the <a title="Pricing" href="https://dataforseo.com/pricing/business-data/business-data-api" target="_blank" rel="noopener noreferrer">Pricing</a> page.
          nullable: true
        location_name:
          type: string
          description: '<em>full name of search engine location</em><br><strong>required field if you don''t specify</strong> <code>location_code</code> or <code>location_coordinate</code><br><strong>if you use this field, you don''t need to specify <code>location_code</code> or <code>location_coordinate</code></strong><br>you can receive the list of available locations with <code>location_name</code> by making a separate request to the <code>https://api.dataforseo.com/v3/business_data/google/locations</code><br>example:<br><code class="long-string">London,England,United Kingdom</code>'
        location_code:
          type: integer
          description: '<em>search engine location code</em><br><strong>required field if you don''t specify</strong> <code>location_name</code>_or <code>location_coordinate</code><br><strong>if you use this field, you don''t need to specify <code>location_name</code> or <code>location_coordinate</code></strong><br>you can receive the list of available locations with <code>location_code</code> by making a separate request to the <code>https://api.dataforseo.com/v3/business_data/google/locations</code><br>example:<br><code class="long-string">2840</code>n'
        location_coordinate:
          type: string
          description: '<em>GPS coordinates of a location</em><br><strong>required field if you don''t specify</strong> <code>location_name</code>_or <code>location_code</code><br><strong>if you use this field, you don''t need to specify <code>location_name</code> or <code>location_code</code></strong><br><code>location_coordinate</code> parameter should be specified in the <em>"latitude,longitude,radius"</em> format<br>the maximum number of decimal digits for <em>"latitude"</em> and <em>"longitude"</em>: 7<br>the minimum value for <em>"radius"</em>: 199.9<br>example:<br><code class="long-string">53.476225,-2.243572,200</code>n'
        language_name:
          type: string
          description: '<em>full name of search engine language</em><br><strong>required field if you don''t specify</strong> <code>language_code</code><br><strong>if you use this field, you don''t need to specify <code>language_code</code></strong><br>you can receive the list of available languages with <code>language_name</code> by making a separate request to the <code>https://api.dataforseo.com/v3/business_data/google/languages</code><br>example:<br><code class="long-string">English</code>'
        language_code:
          type: string
          description: '<em>search engine language code</em><br><strong>required field if you don''t specify</strong> <code>language_name</code><br><strong>if you use this field, you don''t need to specify <code>language_name</code></strong><br>you can receive the list of available languages with their <code>language_code</code>_by making a separate request to the <code>https://api.dataforseo.com/v3/business_data/google/languages</code><em><br></em>example:<em><br></em><code class="long-string">en</code>n'
        depth:
          type: integer
          description: '<em>parsing depth</em><br>optional field<br>number of updates in SERP<br>we strongly recommend setting the parsing depth in the multiples of ten, because our systems processes ten updates in a row<br><strong>please note that Google returns 4490 updates maximum</strong><br>default value: <code>10</code>'
          nullable: true
        tag:
          type: string
          description: <em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response
          nullable: true
        postback_url:
          type: string
          description: '<em>URL for sending task results</em><br>optional field<br>once the task is completed, we will send a POST request with its results compressed in the <code>gzip</code> format to the <code>postback_url</code> you specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/postbackscript?id=$id</code><br><code>http://your-server.com/postbackscript?id=$id&amp;tag=$tag</code><br><strong>Note:</strong> special characters in <code>postback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href="https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api" target="_blank" rel="noopener noreferrer">Help Center</a>'
          nullable: true
        pingback_url:
          type: string
          description: '<em>notification URL of a completed task</em><br>optional field<br>when a task is completed we will notify you by GET request sent to the URL you have specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/pingscript?id=$id</code><br><code>http://your-server.com/pingscript?id=$id&amp;tag=$tag</code><br><strong>Note:</strong> special characters in <code>pingback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href="https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api" target="_blank" rel="noopener noreferrer">Help Center</a>'
          nullable: true
      example:
        - language_code: en
          location_name: 'New York,New York,United States'
          keyword: 'RustyBrick, Inc.'
    BusinessDataGoogleMyBusinessUpdatesTaskPostTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: object
              description: '<em>array of results</em><br>in this case, the value will be <code>null</code>'
              nullable: true
    BusinessDataGoogleMyBusinessUpdatesTaskPostResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/BusinessDataGoogleMyBusinessUpdatesTaskPostTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    BusinessDataGoogleMyBusinessUpdatesTasksReadyResultInfo:
      type: object
      properties:
        id:
          type: string
          description: <em>task identifier of the completed task</em><br><strong>unique task identifier in our system in the <a href="https://en.wikipedia.org/wiki/Universally_unique_identifier">UUID</a> format</strong>
          nullable: true
        se:
          type: string
          description: '<em>search engine specified when setting the task</em><br>can take the following values: <code>google</code>'
          nullable: true
        se_type:
          type: string
          description: <em>search engine type</em>
          nullable: true
        date_posted:
          type: string
          description: <em>date when the task was posted (in the UTC format)</em>
          nullable: true
        tag:
          type: string
          description: <em>user-defined task identifier</em>
          nullable: true
        endpoint:
          type: string
          description: <em>URL for collecting the results of the task</em>
          nullable: true
    BusinessDataGoogleMyBusinessUpdatesTasksReadyTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/BusinessDataGoogleMyBusinessUpdatesTasksReadyResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    BusinessDataGoogleMyBusinessUpdatesTasksReadyResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/BusinessDataGoogleMyBusinessUpdatesTasksReadyTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    GoogleBusinessPost:
      type: object
      properties:
        type:
          type: string
          description: type of element
          nullable: true
        rank_group:
          type: integer
          description: <em>position within a group of elements with identical <code>type</code> values</em><br>positions of elements with different <code>type</code> values are omitted from <code>rank_group</code>
          nullable: true
        rank_absolute:
          type: integer
          description: <em>absolute rank among all the listed updates</em><br>absolute position among all present elements
          nullable: true
        position:
          type: string
          description: '<em>the alignment of the element in SERP</em><br>can take the following values: <code>right</code>'
          nullable: true
        xpath:
          type: string
          description: <em>the <a href="https://en.wikipedia.org/wiki/XPath">XPath</a> of the element</em>
          nullable: true
        author:
          type: string
          description: <em>author of the post</em>
          nullable: true
        snippet:
          type: string
          description: <em>additional content of a post</em>
          nullable: true
        post_text:
          type: string
          description: <em>main content of a post</em>
          nullable: true
        url:
          type: string
          description: <em>url of a post</em>
          nullable: true
        images_url:
          type: string
          description: <em>url of an image included in the post</em>
          nullable: true
        post_date:
          type: string
          description: <em>date when a post was published</em><br>in the following format:<br><code>"mm/dd/yyyy hh:mm:ss"</code>
          nullable: true
        timestamp:
          type: string
          description: '<em>time when a post was published</em><br>in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”<br>example:<br>2019-11-15 12:57:46 +00:00'
          nullable: true
        links:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/LinkElement'
            nullable: true
          description: <em>links included in the post</em>
          nullable: true
    BusinessDataGoogleMyBusinessUpdatesTaskGetResultInfo:
      type: object
      properties:
        keyword:
          type: string
          description: <em>keyword received in a POST array</em><br><strong>keyword is returned with decoded %## (plus character '+' will be decoded to a space character)</strong><br>this field will contain the <code>cid</code> parameter if you specified it in the <code>keyword</code> field when setting a task;<br>example:<br><code>cid:2946633002421908862</code><br>learn more about the parameter in <a href="https://dataforseo.com/help-center/what-is-cid-place-id-feature-id" rel="noopener noreferrer" target="_blank">this help center article</a>
          nullable: true
        se_domain:
          type: string
          description: <em>search engine domain as specified in a POST array</em>
          nullable: true
        location_code:
          type: integer
          description: <em>location code in a POST array</em>
          nullable: true
        language_code:
          type: string
          description: <em>language code in a POST array</em>
          nullable: true
        check_url:
          type: string
          description: <em>direct URL to search engine results</em><br>you can use it to make sure that we provided accurate results
          nullable: true
        datetime:
          type: string
          description: '<em>date and time when the result was received</em><br>in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”<br>example:<br><code class="long-string">2019-11-15 12:57:46 +00:00</code>'
          nullable: true
        business_updates_id:
          type: string
          description: <em>identifier of the business updates element in SERP</em>
          nullable: true
        cid:
          type: string
          description: <em>google-defined client id</em><br>unique id of a local establishment<br>learn more about the <code>cid</code> identifier in <a href="https://dataforseo.com/help-center/what-is-cid-place-id-feature-id" rel="noopener noreferrer" target="_blank">this help center article</a>
          nullable: true
        feature_id:
          type: string
          description: <em>the unique identifier of the element in SERP</em><br>learn more about the identifier in <a href="https://dataforseo.com/help-center/what-is-cid-place-id-feature-id" rel="noopener noreferrer" target="_blank">this help center article</a>
          nullable: true
        item_types:
          type: array
          items:
            type: string
            nullable: true
          description: '<em>item types</em><br>types of search engine results encountered in the <code>items</code> array;<br>possible item types: <code>google_business_post</code>'
          nullable: true
        items_count:
          type: integer
          description: <em>item types</em><br>the number of items in the <code>items</code> array
          format: int64
          nullable: true
        items:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/GoogleBusinessPost'
            nullable: true
          description: '<em>encountered item types</em><br>types of search engine results encountered in the <code>items</code> array;<br>possible item types: <code>google_business_post</code>'
          nullable: true
    BusinessDataGoogleMyBusinessUpdatesTaskGetTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/BusinessDataGoogleMyBusinessUpdatesTaskGetResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    BusinessDataGoogleMyBusinessUpdatesTaskGetResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/BusinessDataGoogleMyBusinessUpdatesTaskGetTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    BusinessDataGoogleHotelSearchesTaskPostRequestInfo:
      type: object
      properties:
        keyword:
          type: string
          description: '<em>keyword</em><br>optional field<br>the keyword you specify is used to search for the list of hotels;<br>if you don''t use this field, we will return the list of hotels found in a specified location;<br>you can specify <strong>up to 700 characters</strong> in the <code>keyword</code> filed<br><strong>all %## will be decoded (plus character ‘+’ will be decoded to a space character)</strong><br>if you need to use the “%” character for your <code>keyword</code>, please specify it as “%25”; <br><strong>Note:</strong> in order to obtain accurate search results, the location name is appended to the keyword automatically<p>learn more about rules and limitations of <code>keyword</code> and <code>keywords</code> fields in DataForSEO APIs in this <a href="https://dataforseo.com/help-center/rules-and-limitations-of-keyword-and-keywords-fields-in-dataforseo-apis" rel="noopener noreferrer" target="_blank">Help Center article</a>'
          nullable: true
        priority:
          type: integer
          description: <em>task priority</em><br>optional field<br>can take the following values:<br>1 – normal execution priority (set by default)<br>2 – high execution priorityYou will be additionally charged for the tasks with high execution priority.<br>The cost can be calculated on the <a title="Pricing" href="https://dataforseo.com/pricing/business-data/google-hotels-api" target="_blank" rel="noopener noreferrer">Pricing</a> page.
          nullable: true
        location_name:
          type: string
          description: '<em>full name of search engine location</em><br><strong>required field if you don''t specify <code>location_code</code> or <code>location_coordinate</code></strong><br><strong>if you use this field, you don''t need to specify <code>location_code</code> or <code>location_coordinate</code></strong><br>you can receive the list of available locations with <code>location_name</code> by making a separate request to <code>https://api.dataforseo.com/v3/business_data/google/locations</code><br>example:<br><code class="long-string">London,England,United Kingdom</code><br><strong>Note:</strong> in order to obtain accurate search results, the <code>location_name</code> you specify will be automatically appended to the keyword'
        location_code:
          type: integer
          description: '<em>search engine location code</em><br><strong>required field if you don''t specify <code>location_name</code>_or <code>location_coordinate</code></strong><br><strong>if you use this field, you don''t need to specify <code>location_name</code> or <code>location_coordinate</code></strong><br>you can receive the list of available locations with <code>location_code</code> by making a separate request to the <code>https://api.dataforseo.com/v3/business_data/google/locations</code><br>example:<br><code class="long-string">2840</code>n'
        location_coordinate:
          type: string
          description: '<em>GPS coordinates of a location</em><br><strong>required field if you don''t specify <code>location_name</code>_or <code>location_code</code></strong><br><strong>if you use this field, you don''t need to specify <code>location_name</code> or <code>location_code</code></strong><br><code>location_coordinate</code> parameter should be specified in the <em>"latitude,longitude"</em> format<br>the maximum number of decimal digits for <em>"latitude"</em> and <em>"longitude"</em>: 7<br><strong>Note</strong>: if the coordinates are used to set a location, the search will occur in the nearest settlement;<br>example:<br><code class="long-string">53.476225,-2.243572</code>'
        search_this_area:
          type: boolean
          description: '<em>show hotels from the displayed area</em><br>optional field<br>can take the values: <code>true</code>, <code>false</code><br>default value: <code>true</code><br>if set to <code>false</code> the <code>search_this_area</code> mode will be turned off<br><strong>Note:</strong> if the <code>search_this_area</code> mode is turned off, the <code>location_name</code> won''t be appended to the <code>keyword</code> during search<br>learn more about this parameter <a href="https://dataforseo.com/help-center/how-to-use-search_this_area-parameter-in-google-hotel-searches" target="_blank">on our Help Center</a>'
          nullable: true
        language_name:
          type: string
          description: '<em>full name of search engine language</em><br><strong>required field if you don''t specify <code>language_code</code></strong><br><strong>if you use this field, you don''t need to specify <code>language_code</code></strong><br>you can receive the list of available languages with <code>language_name</code> by making a separate request to <code>https://api.dataforseo.com/v3/business_data/google/languages</code><br>example:<br><code class="long-string">English</code>'
        language_code:
          type: string
          description: '<em>search engine language code</em><br><strong>required field if you don''t specify <code>language_name</code></strong><br><strong>if you use this field, you don''t need to specify <code>language_name</code></strong><br>you can receive the list of available languages with their <code>language_code</code>_by making a separate request to <code>https://api.dataforseo.com/v3/business_data/google/languages</code><em><br></em>example:<em><br></em><code class="long-string">en</code>'
        depth:
          type: integer
          description: '<em>parsing depth</em><br>optional field<br>number of results in Google Hotels<br>default value: <code>18</code> organic results<br>max value: <code>140</code><br><strong>Note:</strong> your account will be billed per each 18 organic results regardless of paid listings in the response;<br>thus, setting a depth above <code>18</code> may result in additional charges if Google Hotels return more than 18 results;<br>if the specified depth is higher than the number of results in the response, the difference will be refunded automatically to your account balance'
          nullable: true
        check_in:
          type: string
          description: '<em>check-in date</em><br>optional field<br>if you don''t specify this field, tomorrow''s date will be used by default;<br>date format: <code>"yyyy-mm-dd"</code><br>example:<br><code>"2019-01-15"</code><br><strong>Note:</strong> the value cannot precede the today''s date'
          nullable: true
        check_out:
          type: string
          description: '<em>check-out date</em><br>optional field<br>if you don''t specify this field, our system will apply the date of two days from now by default;<br>date format: <code>"yyyy-mm-dd"</code><br>example:<br><code>"2019-01-15"</code><br><strong>Note:</strong> the value cannot be less than or equal to <code>check_in</code>;<br>the range between <code>check_in</code> and <code>check_out</code> values cannot exceed 30 days'
          nullable: true
        currency:
          type: string
          description: <em>currency</em><br>optional field<br>example:<br><code>"USD"</code>
          nullable: true
        adults:
          type: integer
          description: '<em>number of adults</em><br>optional field<br>if you don''t specify this field, the default value of <code>2</code> will be applied;<br><strong>note</strong> that you can specify up to 6 persons including both adults and children<br>example:<br><code>1</code>'
          nullable: true
        children:
          type: array
          items:
            type: string
          description: '<em>number and age of children</em><br>optional field<br>if you don''t specify this field, no children will be included in the search;<br>age of child can be from <code>0</code> to <code>17</code>;<br><strong>note</strong> that you can specify up to 6 persons including both adults and children<br>set the following value if you want to include one 14-year-old child:<br><code>[14]</code><br>set the following value if you want to include one 13-year-old child and one 8-year-old child:<br><code>[13,8]</code>'
          nullable: true
        stars:
          type: array
          items:
            type: string
          description: '<em>hotel stars</em><br>optional field<br>set this field to <code>[5]</code> if you want to get the list of 5-star hotels only<br>example:<br><code>[3,4,5]</code>'
          nullable: true
        min_rating:
          type: number
          description: <em>minimum rating</em><br>optional field<br>you can use this field to specify guest rating higher than a certain value<br>example:<br><code>2.5</code>
          nullable: true
        sort_by:
          type: string
          description: '<em>results sorting parameters</em><br>optional field<br>you can use this field to sort the results<br>possible types of sorting:<br><code>relevance</code> – sort by most relevant<br><code>lowest_price</code> – sort by the lowest price<br><code>highest_rating</code> – sort by highest rating<br><code>most_reviewed</code> – sort by most reviewed<br>default value: <code>relevance</code>'
          nullable: true
        min_price:
          type: integer
          description: <em>minimum price per night</em><br>optional field<br>the currency of this value depends on the <code>currency</code> field<br>example:<br><code>100</code>
          nullable: true
        max_price:
          type: integer
          description: <em>maximum price per night</em><br>optional field<br>the currency of this value depends on the <code>currency</code> field<br>example:<br><code>600</code>
          nullable: true
        free_cancellation:
          type: boolean
          description: '<em>hotels with a free cancellation</em><br>optional field<br>set this field to <code>true</code> if you want to get the list of hotels with free cancellation of reservations<br>default value: <code>false</code>'
          nullable: true
        is_vacation_rentals:
          type: boolean
          description: '<em>search for vacation rentals</em><br>optional field<br>set this field to <code>true</code> if you want to get the list of vacation rentals instead of hotels<br>default value: <code>false</code>'
          nullable: true
        amenities:
          type: array
          items:
            type: string
          description: '<em>hotel amenities</em><br>optional field<br>you can use this field to specify different hotel amenities<br>example:<br><code>  [<br>            "free_parking",<br>            "pets_allowed"<br>        ]<br></code><br>possible values:<br><code>"air_conditioning",<br>"all_inclusive_available",<br>"bar",<br>"free_breakfast",<br>"fitness_center",<br>"kid_friendly",<br>"free_parking",<br>"pets_allowed",<br>"pool",<br>"restaurant",<br>"room_service",<br>"spa",<br>"free_wifi",<br>"parking",<br>"indoor_pool",<br>"outdoor_pool",<br>"wheelchair_accessible",<br>"beach_access"</code>'
          nullable: true
        tag:
          type: string
          description: <em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response
          nullable: true
        postback_url:
          type: string
          description: '<em>URL for sending task results</em><br>optional field<br>once the task is completed, we will send a POST request with its results compressed in the <code>gzip</code> format to the <code>postback_url</code> you specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/postbackscript?id=$id</code><br><code>http://your-server.com/postbackscript?id=$id&amp;tag=$tag</code><br><strong>Note:</strong> special characters in <code>postback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href="https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api" target="_blank" rel="noopener noreferrer">Help Center</a>'
          nullable: true
        pingback_url:
          type: string
          description: '<em>notification URL of a completed task</em><br>optional field<br>when a task is completed we will notify you by GET request sent to the URL you have specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/pingscript?id=$id</code><br><code>http://your-server.com/pingscript?id=$id&amp;tag=$tag</code><br><strong>Note:</strong> special characters in <code>pingback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href="https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api" target="_blank" rel="noopener noreferrer">Help Center</a>'
          nullable: true
      example:
        - language_code: en
          location_name: 'New York,New York,United States'
          keyword: cheap hotel
          check_in: '2023-06-01'
          check_out: '2023-06-30'
          currency: USD
          adults: 2
          children:
            - '14'
          sort_by: highest_rating
          priority: 2
          tag: example
    BusinessDataGoogleHotelSearchesTaskPostTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: object
              description: '<em>array of results</em><br>in this case, the value will be <code>null</code>'
              nullable: true
    BusinessDataGoogleHotelSearchesTaskPostResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/BusinessDataGoogleHotelSearchesTaskPostTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    BusinessDataGoogleHotelSearchesTasksReadyResultInfo:
      type: object
      properties:
        id:
          type: string
          description: "<em>task identifier of the completed task</em><br><strong>unique task identifier in our system in the <a href=\"https://en.wikipedia.org/wiki/Universally_unique_identifier\">UUID</a> \nformat</strong>"
          nullable: true
        se:
          type: string
          description: '<em>search engine specified when setting the task</em><br>can take the following values: <code>google</code>'
          nullable: true
        se_type:
          type: string
          description: <em>search engine type</em>
          nullable: true
        date_posted:
          type: string
          description: <em>date when the task was posted (in the UTC format)</em>
          nullable: true
        tag:
          type: string
          description: <em>user-defined task identifier</em>
          nullable: true
        endpoint:
          type: string
          description: <em>URL for collecting the results of the task</em>
          nullable: true
    BusinessDataGoogleHotelSearchesTasksReadyTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/BusinessDataGoogleHotelSearchesTasksReadyResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    BusinessDataGoogleHotelSearchesTasksReadyResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/BusinessDataGoogleHotelSearchesTasksReadyTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    GpsCoordinatesLocationInfo:
      type: object
      properties:
        latitude:
          type: number
          description: '<i>latitude coordinate of the hotel in google maps</i><br>example:<br><code>"latitude": 51.584091</code>'
          nullable: true
        longitude:
          type: number
          description: '<i>longitude coordinate of the hotel in google maps</i><br>example:<br><code>"longitude": -0.31365919999999997</code>'
          nullable: true
    HotelInfoPriceOffer:
      type: object
      properties:
        type:
          type: string
          description: type of element
          nullable: true
        title:
          type: string
          description: <em>title of the hotel</em>
          nullable: true
        price:
          type: number
          description: <em>price per night</em>
          nullable: true
        currency:
          type: string
          description: '<em>price currency</em><br><code>USD</code> is applied by default, unless specified in the POST array'
          nullable: true
        url:
          type: string
          description: "url of the price offer\nURL to the page of the website where price offer appears"
          nullable: true
        max_visitors:
          type: integer
          description: "the maximal number of visitors\nthe maximum number of visitors for which the price offer is valid"
          nullable: true
        offer_images:
          type: array
          items:
            type: string
            nullable: true
          description: "price offer images\nURLs of the images featured in the price offer"
          nullable: true
        free_cancellation_until:
          type: string
          description: "date until free cancellation is available\nin the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”\nequals null if free cancellation is not available for the selected dates"
          nullable: true
      description: featured price offers
    HotelPriceItemInfo:
      type: object
      properties:
        type:
          type: string
          description: type of element
          nullable: true
        title:
          type: string
          description: <em>title of the hotel</em>
          nullable: true
        price:
          type: number
          description: <em>price per night</em>
          nullable: true
        currency:
          type: string
          description: '<em>price currency</em><br><code>USD</code> is applied by default, unless specified in the POST array'
          nullable: true
        url:
          type: string
          description: "third-party page url\nURL to the third-party website page with pricing information"
          nullable: true
        domain:
          type: string
          description: "third-party domain\ndomain of the third-party website page with pricing information"
          nullable: true
        is_paid:
          type: boolean
          description: '<em>indicates a paid hotel listing</strong></em><br>if <code>true</code>, related <code>hotel_search_item</code> is a paid ad<br>if <code>false</code>, related <code>hotel_search_item</code> is an organic hotel listing'
          nullable: true
        official_site:
          type: boolean
          nullable: true
        free_cancellation_until:
          type: string
          description: "date until which free cancellation is available\nin the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”\nequals null if free cancellation is not available for the selected dates"
          nullable: true
        offers:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/HotelInfoPriceOffer'
            nullable: true
          nullable: true
    PricesByDates:
      type: object
      properties:
        price:
          type: number
          description: <em>price per night</em>
          nullable: true
        currency:
          type: string
          description: '<em>price currency</em><br><code>USD</code> is applied by default, unless specified in the POST array'
          nullable: true
        check_in_date:
          type: string
          nullable: true
        check_out_date:
          type: string
          nullable: true
    HotelPriceInfo:
      type: object
      properties:
        price:
          type: number
          description: <em>price per night</em>
          nullable: true
        price_without_discount:
          type: number
          description: <em>full price per night without a discount applied</em>
          format: int64
          nullable: true
        currency:
          type: string
          description: '<em>price currency</em><br><code>USD</code> is applied by default, unless specified in the POST array'
          nullable: true
        discount_text:
          type: string
          description: <em>text about a discount applied</em>
          nullable: true
        check_in:
          type: string
          description: '<em>check-in date and time</em><br>in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”<br>example:<br><code>2019-11-15 12:57:46 +00:00</code>'
          nullable: true
        check_out:
          type: string
          description: '<em>check-out date and time</em><br>in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”<br>example:<br><code>2019-11-15 12:57:46 +00:00</code>'
          nullable: true
        visitors:
          type: integer
          description: <em>number of hotel visitors for this price</em>
          nullable: true
        items:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/HotelPriceItemInfo'
            nullable: true
          description: '<em>encountered item types</em><br>types of search engine results encountered in the <code>items</code> array;<br>possible item types: <code>hotel_search_item</code>'
          nullable: true
        prices_by_dates:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/PricesByDates'
            nullable: true
          nullable: true
    BusinessDataGoogleHotelSearchesItem:
      type: object
      properties:
        type:
          type: string
          description: type of element
          nullable: true
        hotel_identifier:
          type: string
          description: <em>unique identifier of a hotel entity in Google search</em><br>example:<br><code>CgoI-KWyzenM_MV3EAE</code>
          nullable: true
        title:
          type: string
          description: <em>title of the hotel</em>
          nullable: true
        stars:
          type: integer
          description: <em>hotel class rating</em><br>class rating that ranges between 1-5 stars
          nullable: true
        is_paid:
          type: boolean
          description: '<em>indicates a paid hotel listing</strong></em><br>if <code>true</code>, related <code>hotel_search_item</code> is a paid ad<br>if <code>false</code>, related <code>hotel_search_item</code> is an organic hotel listing'
          nullable: true
        location:
          type: object
          oneOf:
            - $ref: '#/components/schemas/GpsCoordinatesLocationInfo'
          description: <em>GPS coordinates of the hotel's location</em>
          nullable: true
        reviews:
          type: object
          oneOf:
            - $ref: '#/components/schemas/HotelReviewInfo'
          description: <em>hotel reviews and rating information</em>
          nullable: true
        overview_images:
          type: array
          items:
            type: string
            nullable: true
          description: <em>featured images for a hotel</em>
          nullable: true
        prices:
          type: object
          oneOf:
            - $ref: '#/components/schemas/HotelPriceInfo'
          description: <em>hotel price</em>
          nullable: true
    BusinessDataGoogleHotelSearchesTaskGetResultInfo:
      type: object
      properties:
        keyword:
          type: string
          description: '<em>keyword received in a POST array</em><br>keyword is returned with decoded %## (plus character ''+'' will be decoded to a space character);<br>in order to obtain accurate search results, the location name is appended to the keyword automatically'
          nullable: true
        location_code:
          type: integer
          description: <em>location code in a POST array</em>
          nullable: true
        language_code:
          type: string
          description: <em>language code in a POST array</em>
          nullable: true
        check_url:
          type: string
          description: <em>direct URL to search engine results</em><br>you can use it to make sure that we provided accurate results
          nullable: true
        datetime:
          type: string
          description: '<em>date and time when the result was received</em><br>in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”<br>example:<br><code class="long-string">2019-11-15 12:57:46 +00:00</code>'
          nullable: true
        items_count:
          type: integer
          description: <em>item types</em><br>the number of items in the <code>items</code> array
          format: int64
          nullable: true
        items:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/BusinessDataGoogleHotelSearchesItem'
            nullable: true
          description: <em>array of items</em><br><strong>note:</strong> this field always equals <code>null</code>; use it to facilitate integration and ensure interoperability with the <a href="/v3/business_data/google/hotel_info/live/advanced/">Hotel Info</a> endpoint
          nullable: true
    BusinessDataGoogleHotelSearchesTaskGetTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/BusinessDataGoogleHotelSearchesTaskGetResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    BusinessDataGoogleHotelSearchesTaskGetResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/BusinessDataGoogleHotelSearchesTaskGetTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    BusinessDataGoogleHotelSearchesLiveRequestInfo:
      type: object
      properties:
        keyword:
          type: string
          description: '<em>keyword</em><br>optional field<br>the keyword you specify is used to search for the list of hotels;<br>if you don''t use this field, we will return the list of hotels found in a specified location;<br>you can specify <strong>up to 700 characters</strong> in the <code>keyword</code> filed<br><strong>all %## will be decoded (plus character ‘+’ will be decoded to a space character)</strong><br>if you need to use the “%” character for your <code>keyword</code>, please specify it as “%25”; <br><strong>Note:</strong> in order to obtain accurate search results, the location name is appended to the keyword automatically<p>learn more about rules and limitations of <code>keyword</code> and <code>keywords</code> fields in DataForSEO APIs in this <a href="https://dataforseo.com/help-center/rules-and-limitations-of-keyword-and-keywords-fields-in-dataforseo-apis" rel="noopener noreferrer" target="_blank">Help Center article</a>'
          nullable: true
        location_name:
          type: string
          description: '<em>full name of search engine location</em><br><strong>required field if you don''t specify <code>location_code</code> or <code>location_coordinate</code></strong><br><strong>if you use this field, you don''t need to specify <code>location_code</code> or <code>location_coordinate</code></strong><br>you can receive the list of available locations with <code>location_name</code> by making a separate request to <code>https://api.dataforseo.com/v3/business_data/google/locations</code><br>example:<br><code class="long-string">London,England,United Kingdom</code><br><strong>Note:</strong> in order to obtain accurate search results, the <code>location_name</code> you specify will be automatically appended to the keyword'
        location_code:
          type: integer
          description: '<em>search engine location code</em><br><strong>required field if you don''t specify <code>location_name</code>_or <code>location_coordinate</code></strong><br><strong>if you use this field, you don''t need to specify <code>location_name</code> or <code>location_coordinate</code></strong><br>you can receive the list of available locations with <code>location_code</code> by making a separate request to the <code>https://api.dataforseo.com/v3/business_data/google/locations</code><br>example:<br><code class="long-string">2840</code>n'
        location_coordinate:
          type: string
          description: '<em>GPS coordinates of a location</em><br><strong>required field if you don''t specify <code>location_name</code>_or <code>location_code</code></strong><br><strong>if you use this field, you don''t need to specify <code>location_name</code> or <code>location_code</code></strong><br><code>location_coordinate</code> parameter should be specified in the <em>"latitude,longitude"</em> format<br>the maximum number of decimal digits for <em>"latitude"</em> and <em>"longitude"</em>: 7<br><strong>Note</strong>: if the coordinates are used to set a location, the search will occur in the nearest settlement<br>example:<br><code class="long-string">53.476225,-2.243572</code>n'
        search_this_area:
          type: boolean
          description: '<em>show hotels from the displayed area</em><br>optional field<br>can take the values: <code>true</code>, <code>false</code><br>default value: <code>true</code><br>if set to <code>false</code> the <code>search_this_area</code> mode will be turned off<br><strong>Note:</strong> if the <code>search_this_area</code> mode is turned off, the <code>location_name</code> won''t be appended to the <code>keyword</code> during search<br>learn more about this parameter <a href="https://dataforseo.com/help-center/how-to-use-search_this_area-parameter-in-google-hotel-searches" target="_blank">on our Help Center</a>'
          nullable: true
        language_name:
          type: string
          description: '<em>full name of search engine language</em><br><strong>required field if you don''t specify <code>language_code</code></strong><br><strong>if you use this field, you don''t need to specify <code>language_code</code></strong><br>you can receive the list of available languages with <code>language_name</code> by making a separate request to <code>https://api.dataforseo.com/v3/business_data/google/languages</code><br>example:<br><code class="long-string">English</code>'
        language_code:
          type: string
          description: '<em>search engine language code</em><br><strong>required field if you don''t specify <code>language_name</code></strong><br><strong>if you use this field, you don''t need to specify <code>language_name</code></strong><br>you can receive the list of available languages with their <code>language_code</code>_by making a separate request to <code>https://api.dataforseo.com/v3/business_data/google/languages</code><em><br></em>example:<em><br></em><code class="long-string">en</code>n'
        depth:
          type: integer
          description: '<em>parsing depth</em><br>optional field<br>number of results in Google Hotels<br>default value: <code>18</code> organic results<br>max value: <code>140</code><br><strong>Note:</strong> your account will be billed per each 18 organic results regardless of paid listings in the response;<br>thus, setting a depth above <code>18</code> may result in additional charges if Google Hotels return more than 18 results;<br>if the specified depth is higher than the number of results in the response, the difference will be refunded automatically to your account balance'
          nullable: true
        check_in:
          type: string
          description: '<em>check-in date</em><br>optional field<br>if you don''t specify this field, tomorrow''s date will be used by default;<br>date format: <code>"yyyy-mm-dd"</code><br>example:<br><code>"2019-01-15"</code><br><strong>Note:</strong> the value cannot precede the today''s date'
          nullable: true
        check_out:
          type: string
          description: '<em>check-out date</em><br>optional field<br>if you don''t specify this field, our system will apply the date of two days from now by default;<br>date format: <code>"yyyy-mm-dd"</code><br>example:<br><code>"2019-01-15"</code><br><strong>Note:</strong> the value cannot be less than or equal to <code>check_in</code>;<br>the range between <code>check_in</code> and <code>check_out</code> values cannot exceed 30 days'
          nullable: true
        currency:
          type: string
          description: <em>currency</em><br>optional field<br>example:<br><code>"USD"</code>
          nullable: true
        adults:
          type: integer
          description: '<em>number of adults</em><br>optional field<br>if you don''t specify this field, the default value of <code>2</code> will be applied;<br><strong>note</strong> that you can specify up to 6 persons including both adults and children<br>example:<br><code>1</code>'
          nullable: true
        children:
          type: array
          items:
            type: string
          description: '<em>number and age of children</em><br>optional field<br>if you don''t specify this field, no children will be included in the search;<br>age of child can be from <code>0</code> to <code>17</code>;<br><strong>note</strong> that you can specify up to 6 persons including both adults and children<br>set the following value if you want to include one 14-year-old child:<br><code>[14]</code><br>set the following value if you want to include one 13-year-old child and one 8-year-old child:<br><code>[13,8]</code>'
          nullable: true
        stars:
          type: array
          items:
            type: string
          description: '<em>hotel stars</em><br>optional field<br>set this field to <code>[5]</code> if you want to get the list of 5-star hotels only<br>example:<br><code>[3,4,5]</code>'
          nullable: true
        min_rating:
          type: number
          description: <em>minimum rating</em><br>optional field<br>you can use this field to specify guest rating higher than a certain value<br>example:<br><code>2.5</code>
          nullable: true
        sort_by:
          type: string
          description: '<em>results sorting parameters</em><br>optional field<br>you can use this field to sort the results<br>possible types of sorting:<br><code>relevance</code> – sort by most relevant<br><code>lowest_price</code> – sort by the lowest price<br><code>highest_rating</code> – sort by highest rating<br><code>most_reviewed</code> – sort by most reviewed<br>default value: <code>relevance</code>'
          nullable: true
        min_price:
          type: integer
          description: <em>minimum price per night</em><br>optional field<br>the currency of this value depends on the <code>currency</code> field<br>example:<br><code>100</code>
          nullable: true
        max_price:
          type: integer
          description: <em>maximum price per night</em><br>optional field<br>the currency of this value depends on the <code>currency</code> field<br>example:<br><code>600</code>
          nullable: true
        free_cancellation:
          type: boolean
          description: '<em>hotels with a free cancellation</em><br>optional field<br>set this field to <code>true</code> if you want to get the list of hotels with free cancellation of reservations<br>default value: <code>false</code>'
          nullable: true
        is_vacation_rentals:
          type: boolean
          description: '<em>search for vacation rentals</em><br>optional field<br>set this field to <code>true</code> if you want to get the list of vacation rentals instead of hotels<br>default value: <code>false</code>'
          nullable: true
        amenities:
          type: array
          items:
            type: string
          description: '<em>hotel amenities</em><br>optional field<br>you can use this field to specify different hotel amenities<br>example:<br><code>  [<br>            "free_parking",<br>            "pets_allowed"<br>        ]<br></code><br>possible values:<br>`"air_conditioning",<br>"all_inclusive_available",<br>"bar",<br>"free_breakfast",<br>"fitness_center",<br>"kid_friendly",<br>"free_parking",<br>"pets_allowed",<br>"pool",<br>"restaurant",<br>"room_service",<br>"spa",<br>"free_wifi",<br>"parking",<br>"indoor_pool",<br>"outdoor_pool",<br>"wheelchair_accessible",<br>"beach_access"`'
          nullable: true
        tag:
          type: string
          description: <em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response
          nullable: true
      example:
        - language_code: en
          location_name: 'New York,New York,United States'
          keyword: cheap hotel
          check_in: '2023-06-01'
          check_out: '2023-06-30'
          currency: USD
          adults: 2
          children:
            - '14'
          sort_by: highest_rating
          priority: 2
          tag: example
    BusinessDataGoogleHotelSearchesLiveResultInfo:
      type: object
      properties:
        keyword:
          type: string
          description: <em>keyword received in a POST array</em><br><strong>keyword is returned with decoded %## (plus character '+' will be decoded to a space character)</strong>
          nullable: true
        location_code:
          type: integer
          description: <em>location code in a POST array</em>
          nullable: true
        language_code:
          type: string
          description: <em>language code in a POST array</em>
          nullable: true
        check_url:
          type: string
          description: <em>direct URL to search engine results</em><br>you can use it to make sure that we provided accurate results
          nullable: true
        datetime:
          type: string
          description: '<em>date and time when the result was received</em><br>in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”<br>example:<br><code class="long-string">2019-11-15 12:57:46 +00:00</code>'
          nullable: true
        items_count:
          type: integer
          description: <em>item types</em><br>the number of items in the <code>items</code> array
          format: int64
          nullable: true
        items:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/BusinessDataGoogleHotelSearchesItem'
            nullable: true
          description: '<em>encountered item types</em><br>types of search engine results encountered in the <code>items</code> array;<br>possible item types: <code>hotel_search_item</code>'
          nullable: true
    BusinessDataGoogleHotelSearchesLiveTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/BusinessDataGoogleHotelSearchesLiveResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    BusinessDataGoogleHotelSearchesLiveResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/BusinessDataGoogleHotelSearchesLiveTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    BusinessDataGoogleHotelInfoTaskPostRequestInfo:
      type: object
      properties:
        hotel_identifier:
          type: string
          description: '<em>unique hotel identifier</em><br><strong>required field if you don''t specify <code>keyword</code></strong><br><strong>if you use this field, you don''t need to specify <code>keyword</code></strong><br>unique identifier of a hotel entity in Google search;<br>you can obtain the value by making a request to Advanced <a href="/v3/serp/google/organic/overview/" rel="noopener noreferrer" target="_blank">Google SERP API</a> (enclosed in the <code>hotels_pack</code> element of the response), or the <a href="/v3/business_data/google/hotel_searches/task_post/" rel="noopener noreferrer" target="_blank">Hotel Searches endpoint</a> of Business Data API<br>example:<br><code>ChYIq6SB--i6p6cpGgovbS8wN2s5ODZfEAE</code>'
        keyword:
          type: string
          description: '<em>keyword</em><br><strong>required field if you don''t specify <code>hotel_identifier</code></strong><br><strong>if you use this field, you don''t need to specify <code>hotel_identifier</code></strong><br>the keyword you specify should indicate the name of the hotel entity<br>you can specify <strong>up to 700 characters</strong> in the <code>keyword</code> filed<br><strong>all %## will be decoded (plus character ‘+’ will be decoded to a space character)</strong><br>if you need to use the “%” character for your <code>keyword</code>, please specify it as “%25”'
        priority:
          type: integer
          description: <em>task priority</em><br>optional field<br>can take the following values:<br>1 – normal execution priority (set by default)<br>2 – high execution priorityYou will be additionally charged for the tasks with high execution priority.<br>The cost can be calculated on the <a title="Pricing" href="https://dataforseo.com/pricing/business-data/google-hotels-api" target="_blank" rel="noopener noreferrer">Pricing</a> page.
          nullable: true
        location_name:
          type: string
          description: '<em>full name of search engine location</em><br><strong>required field if you don''t specify <code>location_code</code> or <code>location_coordinate</code></strong><br><strong>if you use this field, you don''t need to specify <code>location_code</code> or <code>location_coordinate</code></strong><br>you can receive the list of available locations with <code>location_name</code> by making a separate request to <code>https://api.dataforseo.com/v3/business_data/google/locations</code><br>example:<br><code class="long-string">London,England,United Kingdom</code>'
        location_code:
          type: integer
          description: '<em>search engine location code</em><br><strong>required field if you don''t specify <code>location_name</code>_or <code>location_coordinate</code></strong><br><strong>if you use this field, you don''t need to specify <code>location_name</code> or <code>location_coordinate</code></strong><br>you can receive the list of available locations with <code>location_code</code> by making a separate request to the <code>https://api.dataforseo.com/v3/business_data/google/locations</code><br>example:<br><code class="long-string">2840</code>n'
        location_coordinate:
          type: string
          description: '<em>GPS coordinates of a location</em><br><strong>required field if you don''t specify <code>location_name</code>_or <code>location_code</code></strong><br><strong>if you use this field, you don''t need to specify <code>location_name</code> or <code>location_code</code></strong><br><code>location_coordinate</code> parameter should be specified in the <em>"latitude,longitude"</em> format<br>the maximum number of decimal digits for <em>"latitude"</em> and <em>"longitude"</em>: 7<br><strong>Note</strong>: if the coordinates are used to set a location, the search will occur in the nearest settlement;<br>example:<br><code class="long-string">53.476225,-2.243572</code>n'
        language_name:
          type: string
          description: '<em>full name of search engine language</em><br><strong>required field if you don''t specify <code>language_code</code></strong><br><strong>if you use this field, you don''t need to specify <code>language_code</code></strong><br>you can receive the list of available languages with <code>language_name</code> by making a separate request to <code>https://api.dataforseo.com/v3/business_data/google/languages</code><br>example:<br><code class="long-string">English</code>'
        language_code:
          type: string
          description: '<em>search engine language code</em><br><strong>required field if you don''t specify <code>language_name</code></strong><br><strong>if you use this field, you don''t need to specify <code>language_name</code></strong><br>you can receive the list of available languages with their <code>language_code</code>_by making a separate request to <code>https://api.dataforseo.com/v3/business_data/google/languages</code><em><br></em>example:<em><br></em><code class="long-string">en</code>n'
        check_in:
          type: string
          description: '<em>check-in date</em><br>optional field<br>if you don''t specify this field, tomorrow''s date will be used by default;<br>the value must not be earlier than today''s date<br>date format: <code>"yyyy-mm-dd"</code><br>example:<br><code>"2019-01-15"</code>'
          nullable: true
        check_out:
          type: string
          description: '<em>check-out date</em><br>optional field<br>if you don''t specify this field, our system will apply the date of two days from now by default;<br><strong>Note:</strong> the value cannot be less than or equal to <code>check_in</code>;<br>the range between <code>check_in</code> and <code>check_out</code> values cannot exceed 30 days<br>date format: <code>"yyyy-mm-dd"</code><br>example:<br><code>"2019-01-15"</code>'
          nullable: true
        currency:
          type: string
          description: <em>currency</em><br>optional field<br>example:<br><code>"USD"</code>
          nullable: true
        adults:
          type: integer
          description: '<em>number of adults</em><br>optional field<br>if you don''t specify this field, two adults will be used by default<br>example:<br><code>1</code>'
          nullable: true
        children:
          type: array
          items:
            type: string
          description: '<em>number and age of children</em><br>optional field<br>if you don''t specify this field, no children will be included in the search;<p>set the following value if you want to include one 14-years-old child:<br><code>[14]</code><br>set the following value if you want to include one 13-years-old child and one 8-years-old child:<br><code>[13,8]</code>'
          nullable: true
        load_prices_by_dates:
          type: boolean
          description: '<em>load hotel stay prices by dates</em><br>optional field<br>if you specify this parameter with <code>true</code>, the response will include the <code>prices_by_dates</code> array with hotel stay prices divided by dates<br>if you use this parameter, you will be charged <strong>double the base price for a request</strong>'
          nullable: true
        prices_start_date:
          type: string
          description: '<em>start date to load prices by dates</em><br>optional field<br>to use this parameter, you must specify <code>load_prices_by_dates</code> with <code>true</code><br>if this parameter is not specified, the start date is set to <code>check_in</code> date<br>date format: <code>yyyy-mm-dd</code><br>example:<br><code>2025-05-20</code>'
          nullable: true
        prices_end_date:
          type: string
          description: '<em>end date to load prices by dates</em><br>optional field<br>to use this parameter, you must specify <code>load_prices_by_dates</code> with <code>true</code><br>if this parameter is not specified, you will get prices by date for the month <br>date format: <code>yyyy-mm-dd</code><br>example:<br><code>2025-05-21</code>'
          nullable: true
        prices_date_range:
          type: string
          description: '<em>predefined period for retrieving daily price data</em><br>optional field<br>to use this parameter, you must specify <code>load_prices_by_dates</code> with <code>true</code><br>if the <code>prices_start_date </code>is not specified, the start date is set to <code>check_in</code> date<br>possible values: <code>month</code>, <code>three_months</code>, <code>six_months</code>, <code>year</code><br>default value: <code>month</code>'
          nullable: true
        tag:
          type: string
          description: <em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255;</em><br>you can use this parameter to identify the task and match it with the result;<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response
          nullable: true
        postback_url:
          type: string
          description: '<em>URL for sending task results</em><br>optional field<br>once the task is completed, we will send a POST request with its results compressed in the <code>gzip</code> format to the <code>postback_url</code> you specified;<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request;<br>example:<br><code>http://your-server.com/postbackscript?id=$id</code><br><code>http://your-server.com/postbackscript?id=$id&amp;tag=$tag</code><br><strong>Note:</strong> special characters in <code>postback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href="https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api" target="_blank" rel="noopener noreferrer">Help Center</a>'
          nullable: true
        postback_data:
          type: string
          description: '<em>postback_url datatype</em><br><strong>required field if you specify <code>postback_url</code></strong><br>corresponds to the datatype that will be sent to your server<br>possible values:<br><code>advanced</code>, <code>html</code>'
        pingback_url:
          type: string
          description: '<em>notification URL of a completed task</em><br>optional field<br>when a task is completed we will notify you by GET request sent to the URL you have specified;<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable;<br>we will set the necessary values before sending the request;<br>example:<br><code>http://your-server.com/pingscript?id=$id</code><br><code>http://your-server.com/pingscript?id=$id&amp;tag=$tag</code><br><strong>Note:</strong> special characters in <code>pingback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href="https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api" target="_blank" rel="noopener noreferrer">Help Center</a>'
          nullable: true
      example:
        - language_code: en
          location_name: 'New York,New York,United States'
          hotel_identifier: ChYIq6SB--i6p6cpGgovbS8wN2s5ODZfEAE
          tag: some_string_123
          postback_url: https://your-server.com/postbackscript.php
          postback_data: advanced
    BusinessDataGoogleHotelInfoTaskPostTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: object
              description: '<em>array of results</em><br>in this case, the value will be <code>null</code>'
              nullable: true
    BusinessDataGoogleHotelInfoTaskPostResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/BusinessDataGoogleHotelInfoTaskPostTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    BusinessDataGoogleHotelInfoTasksReadyResultInfo:
      type: object
      properties:
        id:
          type: string
          description: <em>task identifier of the completed task</em><br><strong>unique task identifier in our system in the <a href="https://en.wikipedia.org/wiki/Universally_unique_identifier">UUID</a> format</strong>
          nullable: true
        se:
          type: string
          description: '<em>search engine specified when setting the task</em><br>can take the following values: <code>google</code>'
          nullable: true
        se_type:
          type: string
          description: <em>search engine specified when setting the task</em>
          nullable: true
        date_posted:
          type: string
          description: <em>date when the task was posted (in the UTC format)</em>
          nullable: true
        tag:
          type: string
          description: <em>user-defined task identifier</em>
          nullable: true
        endpoint:
          type: string
          description: <em>URL for collecting the results of the task</em>
          nullable: true
    BusinessDataGoogleHotelInfoTasksReadyTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/BusinessDataGoogleHotelInfoTasksReadyResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    BusinessDataGoogleHotelInfoTasksReadyResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/BusinessDataGoogleHotelInfoTasksReadyTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    HotelAmenityItemInfo:
      type: object
      properties:
        amenity:
          type: string
          description: <em>standardised amenity name</em>
          nullable: true
        amenity_label:
          type: string
          description: <em>displayed amenity name</em>
          nullable: true
        hint:
          type: string
          description: <em>standardised details about the amenity</em>
          nullable: true
        hint_label:
          type: string
          description: <em>displayed details about the amenity</em>
          nullable: true
        is_available:
          type: boolean
          description: <em>indicates whether the <code>amenity</code> is available in the hotel</em>
          nullable: true
    HotelAmenityInfo:
      type: object
      properties:
        category:
          type: string
          description: <em>standardised category of the ammenity</em>
          nullable: true
        category_label:
          type: string
          description: <em>label of the category</em>
          nullable: true
        items:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/HotelAmenityItemInfo'
            nullable: true
          description: <em>specific amenities and details</em>
          nullable: true
    HotelAboutInfo:
      type: object
      properties:
        description:
          type: string
          description: <em>description of the hotel</em><br>the description of the hotel entity for which the results are collected
          nullable: true
        sub_descriptions:
          type: array
          items:
            type: string
            nullable: true
          description: <em>additional description of the hotel</em><br>details about the hotel provided in addition to the description
          nullable: true
        check_in_time:
          type: object
          oneOf:
            - $ref: '#/components/schemas/TimeInfo'
          description: <em>hotel check-in time</em><br>check-in time indicated in the hotel listing
          nullable: true
        check_out_time:
          type: object
          oneOf:
            - $ref: '#/components/schemas/TimeInfo'
          description: <em>hotel check-out time</em><br>check-out time indicated in the hotel listing
          nullable: true
        full_address:
          type: string
          description: <em>full address of the hotel</em><br>address of the hotel indicated in the standardised format
          nullable: true
        domain:
          type: string
          description: <em>hotel domain</em><br>domain of the hotel's website
          nullable: true
        url:
          type: string
          description: <em>hotel url</em><br>URL to the hotel's website indicated in the listing
          nullable: true
        amenities:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/HotelAmenityInfo'
            nullable: true
          description: <em>hotel amenities</em><br>information about hotel amenities
          nullable: true
        popular_amenities:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/HotelAmenityItemInfo'
            nullable: true
          description: <em>hotel amenities</em><br>information about hotel amenities labelled as "popular"
          nullable: true
    LocationChain:
      type: object
      properties:
        card_id:
          type: string
          description: <em>card identifier</em>
          nullable: true
        feature_id:
          type: string
          description: <em>feature identifier</em><br>learn more about the identifier in <a href="https://dataforseo.com/help-center/what-is-cid-place-id-feature-id" target="_blank" rel="noopener noreferrer">this help center article</a>
          nullable: true
        cid:
          type: string
          description: <em>client id</em><br>learn more about the identifier in <a href="https://dataforseo.com/help-center/what-is-cid-place-id-feature-id" target="_blank" rel="noopener noreferrer">this help center article</a>
          nullable: true
        title:
          type: string
          description: <em>title of the element in the location chain</em>
          nullable: true
    HotelLocationInfo:
      type: object
      properties:
        neighborhood:
          type: string
          description: <em>name of the neighborhood where the hotel is located</em>
          nullable: true
        neighborhood_description:
          type: string
          description: <em>description of the neighborhood where the hotel is located</em>
          nullable: true
        maps_url:
          type: string
          description: <em>url to the location of the hotel in google maps</em>
          nullable: true
        overall_score:
          type: number
          description: '<em>overall score of the hotel location</em><br>indicates the overall score of the hotel''s location in the range from 1 to 5;<br>calculated based on data from the hotel''s proximity to nearby things to do and restaurants, transportation, and airports;<br>note that the criteria are not weighted equally in the overall score'
          nullable: true
        score_by_categories:
          type: object
          additionalProperties:
            type: number
            format: double
            nullable: true
          description: '<em>category scores of the hotel location</em><br>the scores of the hotel''s location tied to the categories that indicate the proximity to nearby things to do, restaurants, transportation, and airports;'
          nullable: true
        latitude:
          type: number
          description: <em>hotel latitude</em><br>latitude coordinates of the hotel's location<br>example:<br><code>39.4806397</code>
          nullable: true
        longitude:
          type: number
          description: <em>hotel longitude</em><br>latitude coordinates of the hotel's location<br>example:<br><code>-106.0512973</code>
          nullable: true
        location_chain:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/LocationChain'
            nullable: true
          description: <em>elements of the location chain</em><br>additional parameters of each element of the location chain
          nullable: true
    ReviewMentionInfo:
      type: object
      properties:
        title:
          type: string
          description: <em>title of the evaluated criterion</em>
          nullable: true
        positive_score:
          type: number
          description: <em>positive score by criterion</em>
          nullable: true
        positive_count:
          type: integer
          description: <em>count of positive reviews by criterion</em>
          format: int64
          nullable: true
        negative_count:
          type: integer
          description: <em>count of negative reviews by criterion</em>
          format: int64
          nullable: true
        total_count:
          type: integer
          description: <em>count of all reviews by criterion</em>
          format: int64
          nullable: true
        visible_by_default:
          type: boolean
          description: <em>element is visible by default</em><br>indicates whether the review element is visible by default
          nullable: true
    OtherSitesReviewsInfo:
      type: object
      properties:
        title:
          type: string
          description: <em>review title</em><br>contains a name of the third-party site where review initially appeared
          nullable: true
        url:
          type: string
          description: <em>review url</em><br>URL to the a third-party site where review initially appeared
          nullable: true
        review_text:
          type: string
          description: <em>review text</em><br>text of the review
          nullable: true
        rating:
          type: object
          oneOf:
            - $ref: '#/components/schemas/RatingInfo'
          description: <em>rating in the review</em><br>information about the rating enclosed in the review on a third-party site
          nullable: true
    HotelReviewInfo:
      type: object
      properties:
        value:
          type: number
          description: <em>overall hotel rating based on customer votes</em>
          nullable: true
        votes_count:
          type: integer
          description: <em>number of customer votes</em><br>the number of customer votes included in the calculation of the hotel rating
          format: int64
          nullable: true
        mentions:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/ReviewMentionInfo'
            nullable: true
          description: <em>hotel mentions</em><br>information about hotel reviews by criteria
          nullable: true
        rating_distribution:
          type: object
          additionalProperties:
            type: integer
            format: Int64
            nullable: true
          description: <em>rating distribution by votes</em><br>the distribution of votes across the rating in the range from 1 to 5
          nullable: true
        other_sites_reviews:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/OtherSitesReviewsInfo'
            nullable: true
          description: <em>reviews on third-party sites</em><br>reviews from third-party sites
          nullable: true
    BusinessDataGoogleHotelInfoTaskGetAdvancedResultInfo:
      type: object
      properties:
        hotel_identifier:
          type: string
          description: <em>unique hotel identifier</em><br>this field will contain the <code>hotel_identifier</code> parameter;<br>example:<br><code>CgoI-KWyzenM_MV3EAE</code>
          nullable: true
        location_code:
          type: integer
          description: <em>location code in a POST array</em>
          nullable: true
        language_code:
          type: string
          description: <em>language code in a POST array</em>
          nullable: true
        check_url:
          type: string
          description: <em>direct URL to search engine results</em><br>you can use it to make sure that we provided accurate results
          nullable: true
        datetime:
          type: string
          description: '<em>date and time when the result was received</em><br>in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”<br>example:<br><code class="long-string">2019-11-15 12:57:46 +00:00</code>'
          nullable: true
        title:
          type: string
          description: <em>hotel title</em><br>the title of the hotel entity for which the results are collected
          nullable: true
        stars:
          type: integer
          description: <em>hotel class rating</em><br>class rating that ranges between 1-5 stars and displayed after review ratings in hotel summary
          nullable: true
        stars_description:
          type: string
          description: <em>hotel class rating</em><br>class rating that ranges between 1-5 stars and displayed after review ratings in the hotel summary
          nullable: true
        address:
          type: string
          description: <em>hotel address</em><br>physical address of the hotel
          nullable: true
        phone:
          type: string
          description: <em>hotel phone number</em><br>contact phone number of the hotel
          nullable: true
        about:
          type: object
          oneOf:
            - $ref: '#/components/schemas/HotelAboutInfo'
          description: <em>information about the hotel</em>
          nullable: true
        location:
          type: object
          oneOf:
            - $ref: '#/components/schemas/HotelLocationInfo'
          description: <em>information about the hotel location</em><br>information about the location where the hotel is located
          nullable: true
        reviews:
          type: object
          oneOf:
            - $ref: '#/components/schemas/HotelReviewInfo'
          description: <em>hotel reviews by criteria</em><br>information about reviews of the hotel entity
          nullable: true
        overview_images:
          type: array
          items:
            type: string
            nullable: true
          description: <em>images displayed in the hotel overview</em><br>array containing URLs to images displayed in the hotel overview
          nullable: true
        prices:
          type: object
          oneOf:
            - $ref: '#/components/schemas/HotelPriceInfo'
          description: <em>pricing details of the hotel entity</em><br>contains information about the hotel's prices
          nullable: true
    BusinessDataGoogleHotelInfoTaskGetAdvancedTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/BusinessDataGoogleHotelInfoTaskGetAdvancedResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    BusinessDataGoogleHotelInfoTaskGetAdvancedResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/BusinessDataGoogleHotelInfoTaskGetAdvancedTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    BusinessDataGoogleHotelInfoTaskGetHtmlResultInfo:
      type: object
      properties:
        keyword:
          type: string
          nullable: true
        type:
          type: string
          description: type of element
          nullable: true
        se_domain:
          type: string
          nullable: true
        location_code:
          type: integer
          description: <em>location code in a POST array</em>
          nullable: true
        language_code:
          type: string
          description: <em>language code in a POST array</em>
          nullable: true
        datetime:
          type: string
          description: '<em>date and time when the result was received</em><br>in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”<br>example:<br><code class="long-string">2019-11-15 12:57:46 +00:00</code>'
          nullable: true
        items_count:
          type: integer
          description: <em>the number of results returned in the <strong><code>items</code></strong> array</em>
          format: int64
          nullable: true
        items:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/HtmlItemInfo'
            nullable: true
          description: <em>HTML pages</em>
          nullable: true
    BusinessDataGoogleHotelInfoTaskGetHtmlTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/BusinessDataGoogleHotelInfoTaskGetHtmlResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    BusinessDataGoogleHotelInfoTaskGetHtmlResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/BusinessDataGoogleHotelInfoTaskGetHtmlTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    BusinessDataGoogleHotelInfoLiveAdvancedRequestInfo:
      type: object
      properties:
        hotel_identifier:
          type: string
          description: '<em>unique hotel identifier</em><br><strong>required field</strong><br>unique identifier of a hotel entity in Google search;<br>you can obtain the value by making a request to Advanced <a href="/v3/serp/google/organic/overview/" rel="noopener noreferrer" target="_blank">Google SERP API</a> (enclosed in the <code>hotels</code> element of the response), or the <a href="/v3/business_data/google/hotel_searches/task_post" rel="noopener noreferrer" target="_blank">Hotel Searches endpoint</a> of Business Data API<br>example:<br><code>ChYIq6SB--i6p6cpGgovbS8wN2s5ODZfEAE</code>'
        location_name:
          type: string
          description: '<em>full name of search engine location</em><br><strong>required field if you don''t specify <code>location_code</code> or <code>location_coordinate</code></strong><br><strong>if you use this field, you don''t need to specify <code>location_code</code> or <code>location_coordinate</code></strong><br>you can receive the list of available locations with <code>location_name</code> by making a separate request to <code>https://api.dataforseo.com/v3/business_data/google/locations</code><br>example:<br><code class="long-string">London,England,United Kingdom</code>'
        location_code:
          type: integer
          description: '<em>search engine location code</em><br><strong>required field if you don''t specify <code>location_name</code>_or <code>location_coordinate</code></strong><br><strong>if you use this field, you don''t need to specify <code>location_name</code> or <code>location_coordinate</code></strong><br>you can receive the list of available locations with <code>location_code</code> by making a separate request to the <code>https://api.dataforseo.com/v3/business_data/google/locations</code><br>example:<br><code class="long-string">2840</code>n'
        location_coordinate:
          type: string
          description: '<em>GPS coordinates of a location</em><br><strong>required field if you don''t specify <code>location_name</code>_or <code>location_code</code></strong><br><strong>if you use this field, you don''t need to specify <code>location_name</code> or <code>location_code</code></strong><br><code>location_coordinate</code> parameter should be specified in the <em>"latitude, longitude"</em> format<br>the maximum number of decimal digits for <em>"latitude"</em> and <em>"longitude"</em>: 7<br><strong>Note</strong>: if the coordinates are used to set a location, the search will occur in the nearest settlement;<br>example:<br><code class="long-string">53.476225,-2.243572</code>n'
        language_name:
          type: string
          description: '<em>full name of search engine language</em><br><strong>required field if you don''t specify <code>language_code</code></strong><br><strong>if you use this field, you don''t need to specify <code>language_code</code></strong><br>you can receive the list of available languages with <code>language_name</code> by making a separate request to <code>https://api.dataforseo.com/v3/business_data/google/languages</code><br>example:<br><code class="long-string">English</code>'
        language_code:
          type: string
          description: '<em>search engine language code</em><br><strong>required field if you don''t specify <code>language_name</code></strong><br><strong>if you use this field, you don''t need to specify <code>language_name</code></strong><br>you can receive the list of available languages with their <code>language_code</code>_by making a separate request to <code>https://api.dataforseo.com/v3/business_data/google/languages</code><em><br></em>example:<em><br></em><code class="long-string">en</code>n'
        check_in:
          type: string
          description: '<em>check-in date</em><br>optional field<br>if you don''t specify this field, tomorrow''s date will be used by default;<br>the value must not be earlier than today''s date<br>date format: <code>"yyyy-mm-dd"</code><br>example:<br><code>"2019-01-15"</code>'
          nullable: true
        check_out:
          type: string
          description: '<em>check-out date</em><br>optional field<br>if you don''t specify this field, our system will apply the date of two days from now by default;<br><strong>Note:</strong> the value cannot be less than or equal to <code>check_in</code>;<br>the range between <code>check_in</code> and <code>check_out</code> values cannot exceed 30 days<br>date format: <code>"yyyy-mm-dd"</code><br>example:<br><code>"2019-01-15"</code>'
          nullable: true
        currency:
          type: string
          description: <em>currency</em><br>optional field<br>example:<br><code>"USD"</code>
          nullable: true
        adults:
          type: integer
          description: '<em>number of adults</em><br>optional field<br>if you don''t specify this field, two adults will be used by default<br>example:<br><code>1</code>'
          nullable: true
        children:
          type: array
          items:
            type: string
          description: '<em>number and age of children</em><br>optional field<br>if you don''t specify this field, no children will be included in the search;<p>set the following value if you want to include one 14-years-old child:<br><code>[14]</code><br>set the following value if you want to include one 13-years-old child and one 8-years-old child:<br><code>[13,8]</code>'
          nullable: true
        load_prices_by_dates:
          type: boolean
          description: '<em>load hotel stay prices by dates</em><br>optional field<br>if you specify this parameter with <code>true</code>, the response will include the <code>prices_by_dates</code> array with hotel stay prices divided by dates<br>if you use this parameter, you will be charged <strong>double the base price for a request</strong>'
          nullable: true
        prices_start_date:
          type: string
          description: '<em>start date to load prices by dates</em><br>optional field<br>to use this parameter, you must specify <code>load_prices_by_dates</code> with <code>true</code><br>if this parameter is not specified, the start date is set to <code>check_in</code> date<br>date format: <code>yyyy-mm-dd</code><br>example:<br><code>2025-05-20</code>'
          nullable: true
        prices_end_date:
          type: string
          description: '<em>end date to load prices by dates</em><br>optional field<br>to use this parameter, you must specify <code>load_prices_by_dates</code> with <code>true</code><br>if this parameter is not specified, you will get prices by date for the month <br>date format: <code>yyyy-mm-dd</code><br>example:<br><code>2025-05-21</code>'
          nullable: true
        prices_date_range:
          type: string
          description: '<em>predefined period for retrieving daily price data</em><br>optional field<br>to use this parameter, you must specify <code>load_prices_by_dates</code> with <code>true</code><br>if the <code>prices_start_date </code>is not specified, the start date is set to <code>check_in</code> date<br>possible values: <code>month</code>, <code>three_months</code>, <code>six_months</code>, <code>year</code><br>default value: <code>month</code>'
          nullable: true
        tag:
          type: string
          description: <em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response
          nullable: true
      example:
        - language_code: en
          location_name: 'New York,New York,United States'
          hotel_identifier: CgoI-KWyzenM_MV3EAE
    BusinessDataGoogleHotelInfoLiveAdvancedResultInfo:
      type: object
      properties:
        hotel_identifier:
          type: string
          description: <em>identifier received in a POST array</em><br>this field will contain the <code>hotel_identifier</code> parameter specified when setting a task;<br>example:<br><code>CgoI-KWyzenM_MV3EAE</code>
          nullable: true
        location_code:
          type: integer
          description: <em>location code in a POST array</em>
          nullable: true
        language_code:
          type: string
          description: <em>language code in a POST array</em>
          nullable: true
        check_url:
          type: string
          description: <em>direct URL to search engine results</em><br>you can use it to make sure that we provided accurate results
          nullable: true
        datetime:
          type: string
          description: '<em>date and time when the result was received</em><br>in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”<br>example:<br><code class="long-string">2019-11-15 12:57:46 +00:00</code>'
          nullable: true
        title:
          type: string
          description: <em>hotel title</em><br>the title of the hotel entity for which the results are collected
          nullable: true
        stars:
          type: integer
          description: <em>hotel class rating</em><br>class rating that ranges between 1-5 stars and displayed after review ratings in hotel summary
          nullable: true
        stars_description:
          type: string
          description: <em>hotel class rating</em><br>class rating that ranges between 1-5 stars and displayed after review ratings in the hotel summary
          nullable: true
        address:
          type: string
          description: <em>hotel address</em><br>physical address of the hotel
          nullable: true
        phone:
          type: string
          description: <em>hotel phone number</em><br>contact phone number of the hotel
          nullable: true
        about:
          type: object
          oneOf:
            - $ref: '#/components/schemas/HotelAboutInfo'
          description: <em>information about the hotel</em>
          nullable: true
        location:
          type: object
          oneOf:
            - $ref: '#/components/schemas/HotelLocationInfo'
          description: <em>information about the hotel location</em><br>information about the location where the hotel is located
          nullable: true
        reviews:
          type: object
          oneOf:
            - $ref: '#/components/schemas/HotelReviewInfo'
          description: <em>hotel reviews by criteria</em><br>information about reviews of the hotel entity
          nullable: true
        overview_images:
          type: array
          items:
            type: string
            nullable: true
          description: <em>images displayed in the hotel overview</em><br>array containing URLs to images displayed in the hotel overview
          nullable: true
        prices:
          type: object
          oneOf:
            - $ref: '#/components/schemas/HotelPriceInfo'
          description: <em>pricing details of the hotel entity</em><br>contains information about the hotel's prices
          nullable: true
    BusinessDataGoogleHotelInfoLiveAdvancedTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/BusinessDataGoogleHotelInfoLiveAdvancedResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    BusinessDataGoogleHotelInfoLiveAdvancedResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/BusinessDataGoogleHotelInfoLiveAdvancedTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    BusinessDataGoogleHotelInfoLiveHtmlRequestInfo:
      type: object
      properties:
        hotel_identifier:
          type: string
          description: '<em>unique hotel identifier</em><br><strong>required field</strong><br>unique identifier of a hotel entity in Google search;<br>you can obtain the value by making a request to Advanced <a href="/v3/serp/google/organic/overview/" rel="noopener noreferrer" target="_blank">Google SERP API</a> (enclosed in the <code>hotels</code> element of the response), or the <a href="/v3/business_data/google/hotel_searches/task_post/" rel="noopener noreferrer" target="_blank">Hotel Searches endpoint</a> of Business Data API<br>example:<br><code>ChYIq6SB--i6p6cpGgovbS8wN2s5ODZfEAE</code>'
        priority:
          type: integer
          description: <em>task priority</em><br>optional field<br>can take the following values:<br>1 – normal execution priority (set by default)<br>2 – high execution priorityYou will be additionally charged for the tasks with high execution priority.<br>The cost can be calculated on the <a title="Pricing" href="https://dataforseo.com/pricing/business-data/google-hotels-api" target="_blank" rel="noopener noreferrer">Pricing</a> page.
          nullable: true
        location_name:
          type: string
          description: '<em>full name of search engine location</em><br><strong>required field if you don''t specify <code>location_code</code> or <code>location_coordinate</code></strong><br><strong>if you use this field, you don''t need to specify <code>location_code</code> or <code>location_coordinate</code></strong><br>you can receive the list of available locations with <code>location_name</code> by making a separate request to <code>https://api.dataforseo.com/v3/business_data/google/locations</code><br>example:<br><code class="long-string">London,England,United Kingdom</code>'
        location_code:
          type: integer
          description: '<em>search engine location code</em><br><strong>required field if you don''t specify <code>location_name</code>_or <code>location_coordinate</code></strong><br><strong>if you use this field, you don''t need to specify <code>location_name</code> or <code>location_coordinate</code></strong><br>you can receive the list of available locations with <code>location_code</code> by making a separate request to the <code>https://api.dataforseo.com/v3/business_data/google/locations</code><br>example:<br><code class="long-string">2840</code>n'
        location_coordinate:
          type: string
          description: '<em>GPS coordinates of a location</em><br><strong>required field if you don''t specify <code>location_name</code>_or <code>location_code</code></strong><br><strong>if you use this field, you don''t need to specify <code>location_name</code> or <code>location_code</code></strong><br><code>location_coordinate</code> parameter should be specified in the <em>"latitude,longitude"</em> format<br>the maximum number of decimal digits for <em>"latitude"</em> and <em>"longitude"</em>: 7<br><strong>Note</strong>: if the coordinates are used to set a location, the search will occur in the nearest settlement;<br>example:<br><code class="long-string">53.476225,-2.243572</code>n'
        language_name:
          type: string
          description: '<em>full name of search engine language</em><br><strong>required field if you don''t specify <code>language_code</code></strong><br><strong>if you use this field, you don''t need to specify <code>language_code</code></strong><br>you can receive the list of available languages with <code>language_name</code> by making a separate request to <code>https://api.dataforseo.com/v3/business_data/google/languages</code><br>example:<br><code class="long-string">English</code>'
        language_code:
          type: string
          description: '<em>search engine language code</em><br><strong>required field if you don''t specify <code>language_name</code></strong><br><strong>if you use this field, you don''t need to specify <code>language_name</code></strong><br>you can receive the list of available languages with their <code>language_code</code>_by making a separate request to <code>https://api.dataforseo.com/v3/business_data/google/languages</code><em><br></em>example:<em><br></em><code class="long-string">en</code>n'
        check_in:
          type: string
          description: '<em>check-in date</em><br>optional field<br>if you don''t specify this field, tomorrow''s date will be used by default;<br>date format: <code>"yyyy-mm-dd"</code><br>example:<br><code>"2019-01-15"</code>'
          nullable: true
        check_out:
          type: string
          description: '<em>check-out date</em><br>optional field<br>if you don''t specify this field, our system will apply the date of two days from now by default;<br>date format: <code>"yyyy-mm-dd"</code><br>example:<br><code>"2019-01-15"</code>'
          nullable: true
        currency:
          type: string
          description: <em>currency</em><br>optional field<br>example:<br><code>"USD"</code>
          nullable: true
        adults:
          type: integer
          description: '<em>number of adults</em><br>optional field<br>if you don''t specify this field, two adults will be used by default<br>example:<br><code>1</code>'
          nullable: true
        children:
          type: array
          items:
            type: string
          description: '<em>number and age of children</em><br>optional field<br>if you don''t specify this field, no children will be included in the search;<p>set the following value if you want to include one 14-years-old child:<br><code>[14]</code><br>set the following value if you want to include one 13-years-old child and one 8-years-old child:<br><code>[13,8]</code>'
          nullable: true
        tag:
          type: string
          description: <em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> array of the response
          nullable: true
      example:
        - language_code: en
          location_name: 'New York,New York,United States'
          hotel_identifier: ChYIq6SB--i6p6cpGgovbS8wN2s5ODZfEAE
    BusinessDataGoogleHotelInfoLiveHtmlResultInfo:
      type: object
      properties:
        keyword:
          type: string
          description: <em>unique hotel identifier specified as <code>"hotel_id:$"</code></em>
          nullable: true
        type:
          type: string
          description: type of element
          nullable: true
        se_domain:
          type: string
          nullable: true
        location_code:
          type: integer
          description: <em>location code in a POST array</em>
          nullable: true
        language_code:
          type: string
          description: <em>language code in a POST array</em>
          nullable: true
        datetime:
          type: string
          description: '<em>date and time when the result was received</em><br>in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”<br>example:<br><code class="long-string">2019-11-15 12:57:46 +00:00</code>'
          nullable: true
        items_count:
          type: integer
          description: <em>the number of results returned in the <strong><code>items</code></strong> array</em>
          format: int64
          nullable: true
        items:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/HtmlItemInfo'
            nullable: true
          description: <em>HTML pages</em>
          nullable: true
    BusinessDataGoogleHotelInfoLiveHtmlTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/BusinessDataGoogleHotelInfoLiveHtmlResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    BusinessDataGoogleHotelInfoLiveHtmlResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/BusinessDataGoogleHotelInfoLiveHtmlTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    BusinessDataGoogleReviewsTaskPostRequestInfo:
      type: object
      properties:
        keyword:
          type: string
          description: '<em>keyword</em><br><strong>required field if you don''t specify <code>cid</code> or <code>place_id</code></strong><br>the keyword you specify should indicate the name of the local establishment;<br>you can specify <strong>up to 700 characters</strong> in the <code>keyword</code> filed;<br>all %## will be decoded (plus character ‘+’ will be decoded to a space character)<br>if you need to use the “%” character for your <code>keyword</code>, please specify it as “%25”;<br> <br>if this field contains such parameters as ‘allinanchor:’, ‘allintext:’, ‘allintitle:’, ‘allinurl:’, ‘define:’, ‘filetype:’, ‘id:’, ‘inanchor:’, ‘info:’, ‘intext:’, ‘intitle:’, ‘inurl:’, ‘link:’, ‘related:’, ‘site:’, <strong>the charge per task will be multiplied by 5</strong><br>Note: queries containing the ‘cache:’ parameter are not supported and will return a validation error<p>learn more about rules and limitations of <code>keyword</code> and <code>keywords</code> fields in DataForSEO APIs in this <a href="https://dataforseo.com/help-center/rules-and-limitations-of-keyword-and-keywords-fields-in-dataforseo-apis" rel="noopener noreferrer" target="_blank">Help Center article</a>'
        cid:
          type: string
          description: '<i>unique, google-defined id of the business entity</i><br><strong>required field if you don''t specify <code>keyword</code> or <code>place_id</code></strong><br>example:<br><code>194604053573767737</code><br>learn more about the identifier in <a href="https://dataforseo.com/help-center/what-is-cid-place-id-feature-id" rel="noopener noreferrer" target="_blank">this help center article</a>'
        place_id:
          type: string
          description: <i>identifier of the business entity in Google Maps</i><br><strong>required field if you don't specify <code>keyword</code> or <code>cid</code></strong><br>example:<br><code>GhIJQWDl0CIeQUARxks3icF8U8A</code><br>learn more about the identifier in <a href="https://dataforseo.com/help-center/what-is-cid-place-id-feature-id" rel="noopener noreferrer" target="_blank">this help center article</a>
        priority:
          type: integer
          description: <em>task priority</em><br>optional field<br>can take the following values:<br>1 – normal execution priority (set by default)<br>2 – high execution priorityYou will be additionally charged for the tasks with high execution priority.<br>The cost can be calculated on the <a title="Pricing" href="https://dataforseo.com/pricing/business-data/google-reviews-api" target="_blank" rel="noopener noreferrer">Pricing</a> page.
          nullable: true
        location_name:
          type: string
          description: '<em>full name of search engine location</em><br><strong>required field if you don''t specify</strong> <code>location_code</code> or <code>location_coordinate</code><br><strong>if you use this field, you don''t need to specify <code>location_code</code> or <code>location_coordinate</code></strong><br>you can receive the list of available locations with <code>location_name</code> by making a separate request to the <code>https://api.dataforseo.com/v3/business_data/google/locations</code><br>example:<br><code class="long-string">London,England,United Kingdom</code>'
        location_code:
          type: integer
          description: '<em>search engine location code</em><br><strong>required field if you don''t specify</strong> <code>location_name</code>_or <code>location_coordinate</code><br><strong>if you use this field, you don''t need to specify <code>location_name</code> or <code>location_coordinate</code></strong><br>you can receive the list of available locations with <code>location_code</code> by making a separate request to the <code>https://api.dataforseo.com/v3/business_data/google/locations</code><br>example:<br><code class="long-string">2840</code>'
        location_coordinate:
          type: string
          description: '<em>GPS coordinates of a location</em><br><strong>required field if you don''t specify</strong> <code>location_name</code>_or <code>location_code</code><br><strong>if you use this field, you don''t need to specify <code>location_name</code> or <code>location_code</code></strong><br><code>location_coordinate</code> parameter should be specified in the <em>"latitude,longitude,radius"</em> format<br>the maximum number of decimal digits for <em>"latitude"</em> and <em>"longitude"</em>: 7<br>the minimum value for <em>"radius"</em>: 199.9<br>example:<br><code class="long-string">53.476225,-2.243572,200</code>'
        language_name:
          type: string
          description: '<em>full name of search engine language</em><br><strong>required field if you don''t specify</strong> <code>language_code</code><br><strong>if you use this field, you don''t need to specify <code>language_code</code></strong><br>you can receive the list of available languages with <code>language_name</code> by making a separate request to the <code>https://api.dataforseo.com/v3/business_data/google/languages</code><br>example:<br><code class="long-string">English</code>'
        language_code:
          type: string
          description: '<em>search engine language code</em><br><strong>required field if you don''t specify</strong> <code>language_name</code><br><strong>if you use this field, you don''t need to specify <code>language_name</code></strong><br>you can receive the list of available languages with their <code>language_code</code>_by making a separate request to the <code>https://api.dataforseo.com/v3/business_data/google/languages</code><em><br></em>example:<em><br></em><code class="long-string">en</code>'
        depth:
          type: integer
          description: '<em>parsing depth</em><br>optional field<br>number of reviews in SERP<br>we strongly recommend setting the parsing depth in the multiples of ten, because our systems processes ten reviews in a row<br>default value: <code>10</code><br>maximum value: <code>4490</code><br><strong>Your account will be billed per each SERP containing up to 10 results;</strong> <br>Setting depth above 10 may result in additional charges if the search engine returns more than 10 results</a>;<br>The cost can be calculated on the <a title="Pricing" href="https://dataforseo.com/pricing/business-data/google-reviews-api" target="_blank" rel="noopener noreferrer">Pricing</a> page.'
          nullable: true
        sort_by:
          type: string
          description: '<em>results sorting parameters</em><br>optional field<br>you can use this field to sort the results<br>possible types of sorting:<br><code>newest</code> – sort by newest first<br><code>highest_rating</code> – sort by highest rating<br><code>lowest_rating</code> – sort by lowest rating<br><code>relevant</code> – sort by relevance<br>default value: <code>relevant</code>'
          nullable: true
        tag:
          type: string
          description: <em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response
          nullable: true
        postback_url:
          type: string
          description: '<em>URL for sending task results</em><br>optional field<br>once the task is completed, we will send a POST request with its results compressed in the <code>gzip</code> format to the <code>postback_url</code> you specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/postbackscript?id=$id</code><br><code>http://your-server.com/postbackscript?id=$id&amp;tag=$tag</code><br><strong>Note:</strong> special characters in <code>postback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href="https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api" target="_blank" rel="noopener noreferrer">Help Center</a>'
          nullable: true
        pingback_url:
          type: string
          description: '<em>notification URL of a completed task</em><br>optional field<br>when a task is completed we will notify you by GET request sent to the URL you have specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/pingscript?id=$id</code><br><code>http://your-server.com/pingscript?id=$id&amp;tag=$tag</code><br><strong>Note:</strong> special characters in <code>pingback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href="https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api" target="_blank" rel="noopener noreferrer">Help Center</a>'
          nullable: true
      example:
        - location_name: 'London,England,United Kingdom'
          language_name: English
          keyword: hedonism wines
          depth: 50
          sort_by: highest_rating
    BusinessDataGoogleReviewsTaskPostTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: object
              description: '<em>array of results</em><br>in this case, the value will be <code>null</code>'
              nullable: true
    BusinessDataGoogleReviewsTaskPostResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/BusinessDataGoogleReviewsTaskPostTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    BusinessDataGoogleReviewsTasksReadyResultInfo:
      type: object
      properties:
        id:
          type: string
          description: <em>task identifier of the completed task</em><br><strong>unique task identifier in our system in the <a href="https://en.wikipedia.org/wiki/Universally_unique_identifier">UUID</a> format</strong>
          nullable: true
        se:
          type: string
          description: '<em>search engine specified when setting the task</em><br>can take the following values: <code>google</code>'
          nullable: true
        se_type:
          type: string
          description: <em>type of search engine</em>
          nullable: true
        date_posted:
          type: string
          description: <em>date when the task was posted (in the UTC format)</em>
          nullable: true
        tag:
          type: string
          description: <em>user-defined task identifier</em>
          nullable: true
        endpoint:
          type: string
          description: <em>URL for collecting the results of the task</em>
          nullable: true
    BusinessDataGoogleReviewsTasksReadyTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/BusinessDataGoogleReviewsTasksReadyResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    BusinessDataGoogleReviewsTasksReadyResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/BusinessDataGoogleReviewsTasksReadyTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    ReviewHighlights:
      type: object
      properties:
        feature:
          type: string
          description: <em>reviewed feature</em>
          nullable: true
        assessment:
          type: string
          description: <em>feature assessment</em>
          nullable: true
    GoogleReviewsSearch:
      type: object
      properties:
        type:
          type: string
          description: type of element
          nullable: true
        rank_group:
          type: integer
          description: <em>position within a group of elements with identical <code>type</code> values</em><br>positions of elements with different <code>type</code> values are omitted from <code>rank_group</code>
          nullable: true
        rank_absolute:
          type: integer
          description: <em>absolute rank among all the listed reviews</em><br>absolute position among all reviews on the list
          nullable: true
        position:
          type: string
          description: '<em>the alignment of the review in SERP</em><br>can take the following values: <code>right</code>'
          nullable: true
        xpath:
          type: string
          description: <em>the <a href="https://en.wikipedia.org/wiki/XPath" rel="noopener noreferrer" target="_blank">XPath</a> of the review</em>
          nullable: true
        review_text:
          type: string
          description: <em>the content of the review</em>
          nullable: true
        original_review_text:
          type: string
          description: '<em>original content of the review</em><br>the original content of the review, no auto-translate applied'
          nullable: true
        original_language:
          type: string
          description: <em>original language of the review text</em>
          nullable: true
        time_ago:
          type: string
          description: <em>the time of publication</em><br>indicates the time (in the 'time ago' format) when the review was listed
          nullable: true
        timestamp:
          type: string
          description: '<em>date and time when a review was published</em><br>in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”<br>example:<br><code>2019-11-15 12:57:46 +00:00</code>'
          nullable: true
        rating:
          type: object
          oneOf:
            - $ref: '#/components/schemas/RatingInfo'
          description: <em>the rating score submitted by the reviewer</em>
          nullable: true
        reviews_count:
          type: integer
          description: <em>total number of reviews submitted by the reviewer</em>
          format: int64
          nullable: true
        photos_count:
          type: integer
          description: <em>total number of photos submitted by the reviewer</em>
          format: int64
          nullable: true
        local_guide:
          type: boolean
          description: <em>indicates whether the reviewer has a 'local guide' status</em>
          nullable: true
        profile_name:
          type: string
          description: <em>profile name of the reviewer</em>
          nullable: true
        profile_url:
          type: string
          description: <em>URL of the reviewer's profile</em>
          nullable: true
        review_url:
          type: string
          description: <em>the URL of the review</em>
          nullable: true
        profile_image_url:
          type: string
          description: <em>URL of the reviewer's profile image</em>
          nullable: true
        owner_answer:
          type: string
          description: <em>text of the owner's response</em><br>the owner's response to the review
          nullable: true
        original_owner_answer:
          type: string
          description: '<em>original text of the owner''s response</em><br>the original response to the review, no auto-translate applied'
          nullable: true
        owner_time_ago:
          type: string
          description: <em>publication time</em><br>indicates the time (in the 'time ago' format) when the owner submitted the response to the review
          nullable: true
        owner_timestamp:
          type: string
          description: '<em>date and time of the owner''s reply to the review</em><br>in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”<br>example:<br><code>2019-11-15 12:57:46 +00:00</code>'
          nullable: true
        review_id:
          type: string
          description: <em>the unique identifier of a review on Google</em><br>example:<br><code>ChZDSUhNMG9nS0VJQ0FnSUMxbHFyMFlnEAE</code>
          nullable: true
        images:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/AiModeImagesElementInfo'
            nullable: true
          description: <em>images submitted by the reviewer</em>
          nullable: true
        review_highlights:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/ReviewHighlights'
            nullable: true
          description: <em>review highlights</em><br>contains highlighted review criteria and assessments
          nullable: true
    BusinessDataGoogleReviewsTaskGetResultInfo:
      type: object
      properties:
        keyword:
          type: string
          description: <em>keyword received in a POST array</em><br><strong>keyword is returned with decoded %## (plus character '+' will be decoded to a space character)</strong>
          nullable: true
        type:
          type: string
          description: type of element
          nullable: true
        se_domain:
          type: string
          description: <em>search engine domain in a POST array</em>
          nullable: true
        location_code:
          type: integer
          description: <em>location code in a POST array</em>
          nullable: true
        language_code:
          type: string
          description: <em>language code in a POST array</em>
          nullable: true
        check_url:
          type: string
          description: <em>direct URL to search engine results</em><br>you can use it to make sure that we provided accurate results
          nullable: true
        datetime:
          type: string
          description: '<em>date and time when the result was received</em><br>in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”<br>example:<br><code class="long-string">2019-11-15 12:57:46 +00:00</code>'
          nullable: true
        title:
          type: string
          description: <em>title of the 'reviews' element in SERP</em><br>the name of the local establishment for which the reviews are collected
          nullable: true
        sub_title:
          type: string
          description: '<em>subtitle of the ''reviews'' element in SERP</em><br>additional information (e.g., address) on the ''reviews'' element for which the reviews are collected'
          nullable: true
        rating:
          type: object
          oneOf:
            - $ref: '#/components/schemas/RatingInfo'
          description: <em>rating of the corresponding local establishment</em><br>popularity rate based on reviews and displayed in SERP
          nullable: true
        feature_id:
          type: string
          description: <em>the unique identifier of the 'reviews' element in SERP</em><br>learn more about the identifier in <a href="https://dataforseo.com/help-center/what-is-cid-place-id-feature-id" rel="noopener noreferrer" target="_blank">this help center article</a>
          nullable: true
        place_id:
          type: string
          description: <em>unique identifier of a business location assigned by Google</em><br>learn more about the identifier in <a href="https://dataforseo.com/help-center/what-is-cid-place-id-feature-id" rel="noopener noreferrer" target="_blank">this help center article</a>
          nullable: true
        cid:
          type: string
          description: <i>google-defined client id</i><br>unique id of a local establishment<br>learn more about the identifier in <a href="https://dataforseo.com/help-center/what-is-cid-place-id-feature-id" rel="noopener noreferrer" target="_blank">this help center article</a>
          nullable: true
        reviews_count:
          type: integer
          description: <em>the total number of reviews</em>
          format: int64
          nullable: true
        items_count:
          type: integer
          description: <em>the number of reviews items in the results array</em><br>you can get more results by using the <code>depth</code> parameter when setting a task
          format: int64
          nullable: true
        items:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/GoogleReviewsSearch'
            nullable: true
          description: <em>found reviews</em><br>you can get more results by using the <code>depth</code> parameter when setting a task
          nullable: true
    BusinessDataGoogleReviewsTaskGetTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/BusinessDataGoogleReviewsTaskGetResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    BusinessDataGoogleReviewsTaskGetResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/BusinessDataGoogleReviewsTaskGetTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    BusinessDataGoogleExtendedReviewsTaskPostRequestInfo:
      type: object
      properties:
        keyword:
          type: string
          description: '<em>keyword</em><br><strong>required field if you don''t specify <code>cid</code> or <code>place_id</code></strong><br>the keyword you specify should indicate the name of the local establishment;<br>you can specify <strong>up to 700 characters</strong> in the <code>keyword</code> filed;<br>all %## will be decoded (plus character ‘+’ will be decoded to a space character)<br>if you need to use the “%” character for your <code>keyword</code>, please specify it as “%25”;<br> <br>if this field contains such parameters as ‘allinanchor:’, ‘allintext:’, ‘allintitle:’, ‘allinurl:’, ‘define:’, ‘filetype:’, ‘id:’, ‘inanchor:’, ‘info:’, ‘intext:’, ‘intitle:’, ‘inurl:’, ‘link:’, ‘related:’, ‘site:’, <strong>the charge per task will be multiplied by 5</strong><br>Note: queries containing the ‘cache:’ parameter are not supported and will return a validation error<p>learn more about rules and limitations of <code>keyword</code> and <code>keywords</code> fields in DataForSEO APIs in this <a href="https://dataforseo.com/help-center/rules-and-limitations-of-keyword-and-keywords-fields-in-dataforseo-apis" rel="noopener noreferrer" target="_blank">Help Center article</a><p><strong>Note:</strong> if you use this field, your account will be charged <strong>three times the standard rate</strong> for tasks involving the <a href="https://dataforseo.com/pricing/business-data/google-reviews-api" rel="noopener noreferrer" target="_blank">Google Reviews API</a>'
        cid:
          type: string
          description: '<i>unique, google-defined id of the business entity</i><br><strong>required field if you don''t specify <code>keyword</code> or <code>place_id</code></strong><br>example:<br><code>194604053573767737</code><br>learn more about the identifier in <a href="https://dataforseo.com/help-center/what-is-cid-place-id-feature-id" rel="noopener noreferrer" target="_blank">this help center article</a><p><strong>Note:</strong> if you use this field, your account will be charged <strong>two times the standard rate</strong> for tasks involving the <a href="https://dataforseo.com/pricing/business-data/google-reviews-api" rel="noopener noreferrer" target="_blank">Google Reviews API</a>'
        place_id:
          type: string
          description: '<i>identifier of the business entity in Google Maps</i><br><strong>required field if you don''t specify <code>keyword</code> or <code>cid</code></strong><br>example:<br><code>GhIJQWDl0CIeQUARxks3icF8U8A</code><br>learn more about the identifier in <a href="https://dataforseo.com/help-center/what-is-cid-place-id-feature-id" rel="noopener noreferrer" target="_blank">this help center article</a><p><strong>Note:</strong> if you use this field, your account will be charged <strong>two times the standard rate</strong> for tasks involving the <a href="https://dataforseo.com/pricing/business-data/google-reviews-api" rel="noopener noreferrer" target="_blank">Google Reviews API</a>'
        priority:
          type: integer
          description: <em>task priority</em><br>optional field<br>can take the following values:<br>1 – normal execution priority (set by default)<br>2 – high execution priorityYou will be additionally charged for the tasks with high execution priority.<br>The cost can be calculated on the <a title="Pricing" href="https://dataforseo.com/pricing/business-data/google-reviews-api" target="_blank" rel="noopener noreferrer">Pricing</a> page.
          nullable: true
        location_name:
          type: string
          description: '<em>full name of search engine location</em><br><strong>required field if you don''t specify</strong> <code>location_code</code> or <code>location_coordinate</code><br><strong>if you use this field, you don''t need to specify <code>location_code</code> or <code>location_coordinate</code></strong><br>you can receive the list of available locations with <code>location_name</code> by making a separate request to the <code>https://api.dataforseo.com/v3/business_data/google/locations</code><br>example:<br><code class="long-string">London,England,United Kingdom</code>'
        location_code:
          type: integer
          description: '<em>search engine location code</em><br><strong>required field if you don''t specify</strong> <code>location_name</code>_or <code>location_coordinate</code><br><strong>if you use this field, you don''t need to specify <code>location_name</code> or <code>location_coordinate</code></strong><br>you can receive the list of available locations with <code>location_code</code> by making a separate request to the <code>https://api.dataforseo.com/v3/business_data/google/locations</code><br>example:<br><code class="long-string">2840</code>n'
        location_coordinate:
          type: string
          description: '<em>GPS coordinates of a location</em><br><strong>required field if you don''t specify</strong> <code>location_name</code>_or <code>location_code</code><br><strong>if you use this field, you don''t need to specify <code>location_name</code> or <code>location_code</code></strong><br><code>location_coordinate</code> parameter should be specified in the <em>"latitude,longitude,radius"</em> format<br>the maximum number of decimal digits for <em>"latitude"</em> and <em>"longitude"</em>: 7<br>the minimum value for <em>"radius"</em>: 199.9<br>example:<br><code class="long-string">53.476225,-2.243572,200</code>n'
        language_name:
          type: string
          description: '<em>full name of search engine language</em><br><strong>required field if you don''t specify</strong> <code>language_code</code><br><strong>if you use this field, you don''t need to specify <code>language_code</code></strong><br>you can receive the list of available languages with <code>language_name</code> by making a separate request to the <code>https://api.dataforseo.com/v3/business_data/google/languages</code><br>example:<br><code class="long-string">English</code>'
        language_code:
          type: string
          description: '<em>search engine language code</em><br><strong>required field if you don''t specify</strong> <code>language_name</code><br><strong>if you use this field, you don''t need to specify <code>language_name</code></strong><br>you can receive the list of available languages with their <code>language_code</code>_by making a separate request to the <code>https://api.dataforseo.com/v3/business_data/google/languages</code><em><br></em>example:<em><br></em><code class="long-string">en</code>n'
        depth:
          type: integer
          description: '<em>parsing depth</em><br>optional field<br>number of reviews in SERP<br>we strongly recommend setting the parsing depth in the multiples of twenty, because our systems processes twenty reviews in a row<br>default value: <code>20</code><br>maximum value: <code>1000</code><p><strong>Your account will be billed per each SERP containing up to 20 results;</strong> <br>Setting depth above 20 may result in additional charges if the search engine returns more than 20 results;<br>The cost can be calculated on the <a title="Pricing" href="https://dataforseo.com/pricing/business-data/google-reviews-api" target="_blank" rel="noopener noreferrer">Pricing</a> page.'
          nullable: true
        tag:
          type: string
          description: <em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response
          nullable: true
        postback_url:
          type: string
          description: '<em>URL for sending task results</em><br>optional field<br>once the task is completed, we will send a POST request with its results compressed in the <code>gzip</code> format to the <code>postback_url</code> you specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/postbackscript?id=$id</code><br><code>http://your-server.com/postbackscript?id=$id&amp;tag=$tag</code><br><strong>Note:</strong> special characters in <code>postback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href="https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api" target="_blank" rel="noopener noreferrer">Help Center</a>'
          nullable: true
        pingback_url:
          type: string
          description: '<em>notification URL of a completed task</em><br>optional field<br>when a task is completed we will notify you by GET request sent to the URL you have specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/pingscript?id=$id</code><br><code>http://your-server.com/pingscript?id=$id&amp;tag=$tag</code><br><strong>Note:</strong> special characters in <code>pingback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href="https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api" target="_blank" rel="noopener noreferrer">Help Center</a>'
          nullable: true
      example:
        - location_name: 'London,England,United Kingdom'
          language_name: english
          cid: '17626775537598922320'
    BusinessDataGoogleExtendedReviewsTaskPostTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: object
              description: '<em>array of results</em><br>in this case, the value will be <code>null</code>'
              nullable: true
    BusinessDataGoogleExtendedReviewsTaskPostResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/BusinessDataGoogleExtendedReviewsTaskPostTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    BusinessDataGoogleExtendedReviewsTasksReadyResultInfo:
      type: object
      properties:
        id:
          type: string
          description: <em>task identifier of the completed task</em><br><strong>unique task identifier in our system in the <a href="https://en.wikipedia.org/wiki/Universally_unique_identifier">UUID</a> format</strong>
          nullable: true
        se:
          type: string
          description: '<em>search engine specified when setting the task</em><br>can take the following values: <code>google</code>'
          nullable: true
        se_type:
          type: string
          description: <em>type of search engine</em>
          nullable: true
        date_posted:
          type: string
          description: <em>date when the task was posted (in the UTC format)</em>
          nullable: true
        tag:
          type: string
          description: <em>user-defined task identifier</em>
          nullable: true
        endpoint:
          type: string
          description: <em>URL for collecting the results of the task</em>
          nullable: true
    BusinessDataGoogleExtendedReviewsTasksReadyTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/BusinessDataGoogleExtendedReviewsTasksReadyResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    BusinessDataGoogleExtendedReviewsTasksReadyResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/BusinessDataGoogleExtendedReviewsTasksReadyTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    Source:
      type: object
      properties:
        title:
          type: string
          description: <em>name of the source where the review was posted</em>
          nullable: true
        image:
          type: string
          description: <em>featured image of the source</em>
          nullable: true
        domain:
          type: string
          description: <em>domain of the source where the review was posted</em>
          nullable: true
    GoogleExtendedReviewsSearch:
      type: object
      properties:
        type:
          type: string
          description: type of element
          nullable: true
        rank_group:
          type: integer
          description: <em>position within a group of elements with identical <code>type</code> values</em><br>positions of elements with different <code>type</code> values are omitted from <code>rank_group</code>
          nullable: true
        rank_absolute:
          type: integer
          description: <em>absolute rank among all the listed reviews</em><br>absolute position among all reviews on the list
          nullable: true
        position:
          type: string
          description: '<em>the alignment of the review in SERP</em><br>can take the following values: <code>right</code>'
          nullable: true
        xpath:
          type: string
          description: <em>the <a href="https://en.wikipedia.org/wiki/XPath" rel="noopener noreferrer" target="_blank">XPath</a> of the review</em>
          nullable: true
        review_text:
          type: string
          description: <em>the content of the review</em>
          nullable: true
        original_review_text:
          type: string
          description: '<em>original content of the review</em><br>the original content of the review, no auto-translate applied'
          nullable: true
        time_ago:
          type: string
          description: <em>the time of publication</em><br>indicates the time (in the 'time ago' format) when the review was listed
          nullable: true
        timestamp:
          type: string
          description: '<em>date and time when a review was published</em><br>in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”<br>example:<br><code>2019-11-15 12:57:46 +00:00</code>'
          nullable: true
        rating:
          type: object
          oneOf:
            - $ref: '#/components/schemas/RatingInfo'
          description: <em>the rating score submitted by the reviewer</em>
          nullable: true
        reviews_count:
          type: integer
          description: <em>total number of reviews submitted by the reviewer</em>
          format: int64
          nullable: true
        photos_count:
          type: integer
          description: <em>total number of photos submitted by the reviewer</em>
          format: int64
          nullable: true
        local_guide:
          type: boolean
          description: <em>indicates whether the reviewer has a 'local guide' status</em>
          nullable: true
        profile_name:
          type: string
          description: <em>profile name of the reviewer</em>
          nullable: true
        profile_url:
          type: string
          description: <em>URL of the reviewer's profile</em>
          nullable: true
        review_url:
          type: string
          description: <em>the URL of the review</em>
          nullable: true
        profile_image_url:
          type: string
          description: <em>URL of the reviewer's profile image</em>
          nullable: true
        owner_answer:
          type: string
          description: <em>text of the owner's response</em><br>the owner's response to the review
          nullable: true
        original_owner_answer:
          type: string
          description: '<em>original text of the owner''s response</em><br>the original response to the review, no auto-translate applied'
          nullable: true
        owner_time_ago:
          type: string
          description: <em>publication time</em><br>indicates the time (in the 'time ago' format) when the owner submitted the response to the review
          nullable: true
        owner_timestamp:
          type: string
          description: '<em>date and time of the owner''s reply to the review</em><br>in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”<br>example:<br><code>2019-11-15 12:57:46 +00:00</code>'
          nullable: true
        review_id:
          type: string
          description: <em>the unique identifier of a review on Google</em><br>example:<br><code>ChZDSUhNMG9nS0VJQ0FnSUMxbHFyMFlnEAE</code>
          nullable: true
        images:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/AiModeImagesElementInfo'
            nullable: true
          description: <em>images submitted by the reviewer</em>
          nullable: true
        review_highlights:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/ReviewHighlights'
            nullable: true
          description: <em>review highlights</em><br>contains highlighted review criteria and assessments
          nullable: true
        source:
          type: object
          oneOf:
            - $ref: '#/components/schemas/Source'
          description: <em>source of the review</em><br>contains information about the source where the review was posted
          nullable: true
    BusinessDataGoogleExtendedReviewsTaskGetResultInfo:
      type: object
      properties:
        keyword:
          type: string
          description: <em>keyword received in a POST array</em><br><strong>keyword is returned with decoded %## (plus character '+' will be decoded to a space character)</strong>
          nullable: true
        type:
          type: string
          description: type of element
          nullable: true
        se_domain:
          type: string
          description: <em>search engine domain in a POST array</em>
          nullable: true
        location_code:
          type: integer
          description: <em>location code in a POST array</em>
          nullable: true
        language_code:
          type: string
          description: <em>language code in a POST array</em>
          nullable: true
        check_url:
          type: string
          description: <em>direct URL to search engine results</em><br>you can use it to make sure that we provided accurate results
          nullable: true
        datetime:
          type: string
          description: '<em>date and time when the result was received</em><br>in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”<br>example:<br><code class="long-string">2019-11-15 12:57:46 +00:00</code>'
          nullable: true
        title:
          type: string
          description: <em>title of the 'reviews' element in SERP</em><br>the name of the local establishment for which the reviews are collected
          nullable: true
        sub_title:
          type: string
          description: '<em>subtitle of the ''reviews'' element in SERP</em><br>additional information (e.g., address) on the ''reviews'' element for which the reviews are collected'
          nullable: true
        rating:
          type: object
          oneOf:
            - $ref: '#/components/schemas/RatingInfo'
          description: <em>rating of the corresponding local establishment</em><br>popularity rate based on reviews and displayed in SERP
          nullable: true
        feature_id:
          type: string
          description: <em>the unique identifier of the 'reviews' element in SERP</em><br>learn more about the identifier in <a href="https://dataforseo.com/help-center/what-is-cid-place-id-feature-id" rel="noopener noreferrer" target="_blank">this help center article</a>
          nullable: true
        place_id:
          type: string
          description: <em>unique identifier of a business location assigned by Google</em><br>learn more about the identifier in <a href="https://dataforseo.com/help-center/what-is-cid-place-id-feature-id" rel="noopener noreferrer" target="_blank">this help center article</a>
          nullable: true
        cid:
          type: string
          description: <i>google-defined client id</i><br>unique id of a local establishment<br>learn more about the identifier in <a href="https://dataforseo.com/help-center/what-is-cid-place-id-feature-id" rel="noopener noreferrer" target="_blank">this help center article</a>
          nullable: true
        reviews_count:
          type: integer
          description: <em>the total number of reviews</em>
          format: int64
          nullable: true
        items_count:
          type: integer
          description: <em>the number of reviews items in the results array</em><br>you can get more results by using the <code>depth</code> parameter when setting a task
          format: int64
          nullable: true
        items:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/GoogleExtendedReviewsSearch'
            nullable: true
          description: <em>found reviews</em><br>you can get more results by using the <code>depth</code> parameter when setting a task
          nullable: true
    BusinessDataGoogleExtendedReviewsTaskGetTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/BusinessDataGoogleExtendedReviewsTaskGetResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    BusinessDataGoogleExtendedReviewsTaskGetResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/BusinessDataGoogleExtendedReviewsTaskGetTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    BusinessDataGoogleQuestionsAndAnswersTaskPostRequestInfo:
      type: object
      properties:
        keyword:
          type: string
          description: '<em>keyword</em><br><strong>required field</strong><br>the keyword you specify should indicate the name of the local establishment<br>you can specify <strong>up to 700 characters</strong> in the <code>keyword</code> filed<br><strong>all %## will be decoded (plus character ‘+’ will be decoded to a space character)</strong><br>if you need to use the “%” character for your <code>keyword</code>, please specify it as “%25”; <p>this field can also be used to pass the following parameters:<br><code>cid</code> - a unique, google-defined id of the business entity;<br><code>place_id</code> - an identifier of the business entity in Google Maps;<p>example:<br><code>cid:194604053573767737</code><br><code>place_id:GhIJQWDl0CIeQUARxks3icF8U8A</code><p>learn more about the <code>cid</code> and <code>place_id</code> identifiers in <a href="https://dataforseo.com/help-center/what-is-cid-place-id-feature-id" rel="noopener noreferrer" target="_blank">this help center article</a><p>learn more about rules and limitations of <code>keyword</code> and <code>keywords</code> fields in DataForSEO APIs in this <a href="https://dataforseo.com/help-center/rules-and-limitations-of-keyword-and-keywords-fields-in-dataforseo-apis" rel="noopener noreferrer" target="_blank">Help Center article</a>'
        priority:
          type: integer
          description: <em>task priority</em><br>optional field<br>can take the following values:<br>1 – normal execution priority (set by default)<br>2 – high execution priorityYou will be additionally charged for the tasks with high execution priority.<br>The cost can be calculated on the <a title="Pricing" href="https://dataforseo.com/pricing/business-data/google-questions-and-answers-api-pricing" target="_blank" rel="noopener noreferrer">Pricing</a> page.
          nullable: true
        location_name:
          type: string
          description: '<em>full name of search engine location</em><br><strong>required field if you don''t specify</strong> <code>location_code</code> or <code>location_coordinate</code><br><strong>if you use this field, you don''t need to specify <code>location_code</code> or <code>location_coordinate</code></strong><br>you can receive the list of available locations with <code>location_name</code> by making a separate request to <code>https://api.dataforseo.com/v3/business_data/google/locations</code><br>example:<br><code class="long-string">London,England,United Kingdom</code>'
        location_code:
          type: integer
          description: '<em>search engine location code</em><br><strong>required field if you don''t specify</strong> <code>location_name</code>_or <code>location_coordinate</code><br><strong>if you use this field, you don''t need to specify <code>location_name</code> or <code>location_coordinate</code></strong><br>you can receive the list of available locations with <code>location_code</code> by making a separate request to the <code>https://api.dataforseo.com/v3/business_data/google/locations</code><br>example:<br><code class="long-string">2840</code>n'
        location_coordinate:
          type: string
          description: '<em>GPS coordinates of a location</em><br><strong>required field if you don''t specify</strong> <code>location_name</code>_or <code>location_code</code><br><strong>if you use this field, you don''t need to specify <code>location_name</code> or <code>location_code</code></strong><br><code>location_coordinate</code> parameter should be specified in the <em>"latitude,longitude,radius"</em> format<br>the maximum number of decimal digits for <em>"latitude"</em> and <em>"longitude"</em>: 7<br>the minimum value for <em>"radius"</em>: 199.9 (mm)<br>the maximum value for <em>"radius"</em>: 199999 (mm)<br>example:<br><code class="long-string">53.476225,-2.243572,200</code>n'
        language_name:
          type: string
          description: '<em>full name of search engine language</em><br><strong>required field if you don''t specify</strong> <code>language_code</code><br><strong>if you use this field, you don''t need to specify <code>language_code</code></strong><br>you can receive the list of available languages with <code>language_name</code> by making a separate request to <code>https://api.dataforseo.com/v3/business_data/google/languages</code><br>example:<br><code class="long-string">English</code>'
        language_code:
          type: string
          description: '<em>search engine language code</em><br><strong>required field if you don''t specify</strong> <code>language_name</code><br><strong>if you use this field, you don''t need to specify <code>language_name</code></strong><br>you can receive the list of available languages with their <code>language_code</code>_by making a separate request to <code>https://api.dataforseo.com/v3/business_data/google/languages</code><em><br></em>example:<em><br></em><code class="long-string">en</code>n'
        depth:
          type: integer
          description: '<em>parsing depth</em><br>optional field<br>number of question rows in the result<br>default value: <code>20</code><br>max value: <code>700</code><br><strong>Your account will be billed per each SERP containing up to 20 results;</strong> <br>Setting depth above 20 may result in additional charges if the search engine returns more than 20 results</a>;<br>If the specified depth is higher than the number of questions in the response, the difference will be refunded automatically to your account balance;<br>The cost can be calculated on the <a title="Pricing" href="https://dataforseo.com/pricing/business-data/google-questions-and-answers-api-pricing" target="_blank" rel="noopener noreferrer">Pricing</a> page.'
          nullable: true
        tag:
          type: string
          description: <em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response
          nullable: true
        postback_url:
          type: string
          description: '<em>URL for sending task results</em><br>optional field<br>once the task is completed, we will send a POST request with its results compressed in the <code>gzip</code> format to the <code>postback_url</code> you specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/postbackscript?id=$id</code><br><code>http://your-server.com/postbackscript?id=$id&amp;tag=$tag</code><br><strong>Note:</strong> special characters in <code>postback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href="https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api" target="_blank" rel="noopener noreferrer">Help Center</a>'
          nullable: true
        pingback_url:
          type: string
          description: '<em>notification URL of a completed task</em><br>optional field<br>when a task is completed we will notify you by GET request sent to the URL you have specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/pingscript?id=$id</code><br><code>http://your-server.com/pingscript?id=$id&amp;tag=$tag</code><br><strong>Note:</strong> special characters in <code>pingback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code><br>learn more on our <a href="https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api" target="_blank" rel="noopener noreferrer">Help Center</a>'
          nullable: true
      example:
        - language_code: en
          location_name: 'Los Angeles,California,United States'
          keyword: The Last Bookstore
    BusinessDataGoogleQuestionsAndAnswersTaskPostTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: object
              description: '<em>array of results</em><br>in this case, the value will be <code>null</code>'
              nullable: true
    BusinessDataGoogleQuestionsAndAnswersTaskPostResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/BusinessDataGoogleQuestionsAndAnswersTaskPostTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    BusinessDataGoogleQuestionsAndAnswersTasksReadyResultInfo:
      type: object
      properties:
        id:
          type: string
          description: <em>task identifier of the completed task</em><br><strong>unique task identifier in our system in the <a href="https://en.wikipedia.org/wiki/Universally_unique_identifier">UUID</a> format</strong>
          nullable: true
        se:
          type: string
          description: '<em>search engine specified when setting the task</em><br>can take the following values: <code>google</code>'
          nullable: true
        se_type:
          type: string
          description: <em>search engine type</em>
          nullable: true
        date_posted:
          type: string
          description: <em>date when the task was posted (in the UTC format)</em>
          nullable: true
        tag:
          type: string
          description: <em>user-defined task identifier</em>
          nullable: true
        endpoint:
          type: string
          description: <em>URL for collecting the results of the task</em>
          nullable: true
    BusinessDataGoogleQuestionsAndAnswersTasksReadyTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/BusinessDataGoogleQuestionsAndAnswersTasksReadyResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    BusinessDataGoogleQuestionsAndAnswersTasksReadyResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/BusinessDataGoogleQuestionsAndAnswersTasksReadyTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    GoogleBusinessQuestionItem:
      type: object
      properties:
        type:
          type: string
          description: type of element
          nullable: true
        rank_group:
          type: integer
          description: <em>position within a group of elements with identical <code>type</code> values</em><br>positions of elements with different <code>type</code> values are omitted from <code>rank_group</code>
          nullable: true
        rank_absolute:
          type: integer
          description: <em>absolute rank among all the elements</em>
          nullable: true
        question_id:
          type: string
          description: <em>ID of the question</em>
          nullable: true
        url:
          type: string
          description: <em>URL of the question</em>
          nullable: true
        profile_image_url:
          type: string
          description: <em>URL of the user's profile image</em>
          nullable: true
        profile_url:
          type: string
          description: <em>URL of the user's profile</em>
          nullable: true
        profile_name:
          type: string
          description: <em>displayed name of the user</em>
          nullable: true
        question_text:
          type: string
          description: <em>current text of the question</em>
          nullable: true
        original_question_text:
          type: string
          description: <em>original text of the question</em>
          nullable: true
        time_ago:
          type: string
          description: <em>estimated time when the question was posted</em>
          nullable: true
        timestamp:
          type: string
          description: <em>exact time when the question was posted</em>
          nullable: true
        items:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/GoogleBusinessAnswerElement'
            nullable: true
          description: <em>array of items</em><br>items within <code>google_business_question_item</code>
          nullable: true
    GoogleBusinessAnswerElement:
      type: object
      properties:
        type:
          type: string
          description: type of element
          nullable: true
        answer_id:
          type: string
          description: <em>ID of the answer</em>
          nullable: true
        profile_image_url:
          type: string
          description: <em>URL of the user's profile image</em>
          nullable: true
        profile_url:
          type: string
          description: <em>URL of the user's profile</em>
          nullable: true
        profile_name:
          type: string
          description: <em>displayed name of the user</em>
          nullable: true
        answer_text:
          type: string
          description: <em>current text of the answer</em>
          nullable: true
        original_answer_text:
          type: string
          description: <em>original text of the answer</em>
          nullable: true
        time_ago:
          type: string
          description: <em>estimated time when the answer was posted</em>
          nullable: true
        timestamp:
          type: string
          description: <em>exact time when the answer was posted</em>
          nullable: true
    BusinessDataGoogleQuestionsAndAnswersTaskGetResultInfo:
      type: object
      properties:
        keyword:
          type: string
          description: <em>keyword received in a POST array</em><br><strong>keyword is returned with decoded %## (plus character '+' will be decoded to a space character)</strong><br>this field will contain the <code>cid</code> parameter if you specified it in the <code>keyword</code> field when setting a task;<br>example:<br><code>cid:2946633002421908862</code><br>learn more about the parameter in <a href="https://dataforseo.com/help-center/what-is-cid-place-id-feature-id" target="_blank" rel="noopener noreferrer">this help center article</a>
          nullable: true
        se_domain:
          type: string
          description: <em>search engine domain as specified in a POST array</em>
          nullable: true
        location_code:
          type: integer
          description: <em>location code in a POST array</em>
          nullable: true
        language_code:
          type: string
          description: <em>language code in a POST array</em>
          nullable: true
        check_url:
          type: string
          description: <em>direct URL to search engine results</em><br>you can use it to make sure that we provided accurate results
          nullable: true
        datetime:
          type: string
          description: '<em>date and time when the result was received</em><br>in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”<br>example:<br><code class="long-string">2019-11-15 12:57:46 +00:00</code>'
          nullable: true
        cid:
          type: string
          description: <em>google-defined client id</em><br>unique id of a local establishment;<br>learn more about the identifier in <a href="https://dataforseo.com/help-center/what-is-cid-place-id-feature-id" target="_blank" rel="noopener noreferrer">this help center article</a>
          nullable: true
        feature_id:
          type: string
          description: <em> unique identifier of the SERP feature</em>
          nullable: true
        item_types:
          type: array
          items:
            type: string
            nullable: true
          description: '<em>item types</em><br>types of search engine results encountered in the <code>items</code> array;<br>possible item types: <code>google_business_question_item</code>'
          nullable: true
        items_without_answers:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/GoogleBusinessQuestionItem'
            nullable: true
          description: <em>array of google business question items without answers</em>
          nullable: true
        items_count:
          type: integer
          description: <em>the number of items in the <code>items</code> array</em>
          format: int64
          nullable: true
        items:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/GoogleBusinessQuestionItem'
            nullable: true
          description: '<em> array of items within <code>google_business_question_item</code></em><br>contains answers to the google business questions;<br>the maximum number of answers returned for each question: <code>5</code> <br>possible item types <code>google_business_answer_element</code>'
          nullable: true
    BusinessDataGoogleQuestionsAndAnswersTaskGetTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/BusinessDataGoogleQuestionsAndAnswersTaskGetResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    BusinessDataGoogleQuestionsAndAnswersTaskGetResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/BusinessDataGoogleQuestionsAndAnswersTaskGetTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    BusinessDataGoogleQuestionsAndAnswersLiveRequestInfo:
      type: object
      properties:
        keyword:
          type: string
          description: '<em>keyword</em><br><strong>required field</strong><br>the keyword you specify should indicate the name of the local establishment<br>you can specify <strong>up to 700 characters</strong> in the <code>keyword</code> filed<br><strong>all %## will be decoded (plus character ‘+’ will be decoded to a space character)</strong><br>if you need to use the “%” character for your <code>keyword</code>, please specify it as “%25”; <p>this field can also be used to pass the following parameters:<br><code>cid</code> - a unique, google-defined id of the business entity;<br><code>place_id</code> - an identifier of the business entity in Google Maps;<p>example:<br><code>cid:194604053573767737</code><br><code>place_id:GhIJQWDl0CIeQUARxks3icF8U8A</code><p>learn more about the <code>cid</code> and <code>place_id</code> identifiers in <a href="https://dataforseo.com/help-center/what-is-cid-place-id-feature-id" rel="noopener noreferrer" target="_blank">this help center article</a><p>learn more about rules and limitations of <code>keyword</code> and <code>keywords</code> fields in DataForSEO APIs in this <a href="https://dataforseo.com/help-center/rules-and-limitations-of-keyword-and-keywords-fields-in-dataforseo-apis" rel="noopener noreferrer" target="_blank">Help Center article</a>'
        location_name:
          type: string
          description: '<em>full name of search engine location</em><br><strong>required field if you don''t specify</strong> <code>location_code</code> or <code>location_coordinate</code><br><strong>if you use this field, you don''t need to specify <code>location_code</code> or <code>location_coordinate</code></strong><br>you can receive the list of available locations with <code>location_name</code> by making a separate request to <code>https://api.dataforseo.com/v3/business_data/google/locations</code><br>example:<br><code class="long-string">London,England,United Kingdom</code>'
        location_code:
          type: integer
          description: '<em>search engine location code</em><br><strong>required field if you don''t specify</strong> <code>location_name</code>_or <code>location_coordinate</code><br><strong>if you use this field, you don''t need to specify <code>location_name</code> or <code>location_coordinate</code></strong><br>you can receive the list of available locations with <code>location_code</code> by making a separate request to the <code>https://api.dataforseo.com/v3/business_data/google/locations</code><br>example:<br><code class="long-string">2840</code>n'
        location_coordinate:
          type: string
          description: '<em>GPS coordinates of a location</em><br><strong>required field if you don''t specify</strong> <code>location_name</code>_or <code>location_code</code><br><strong>if you use this field, you don''t need to specify <code>location_name</code> or <code>location_code</code></strong><br><code>location_coordinate</code> parameter should be specified in the <em>"latitude,longitude,radius"</em> format<br>the maximum number of decimal digits for <em>"latitude"</em> and <em>"longitude"</em>: 7<br>the minimum value for <em>"radius"</em>: 199.9 (mm)<br>the maximum value for <em>"radius"</em>: 199999 (mm)<br>example:<br><code class="long-string">53.476225,-2.243572,200</code>n'
        language_name:
          type: string
          description: '<em>full name of search engine language</em><br><strong>required field if you don''t specify</strong> <code>language_code</code><br><strong>if you use this field, you don''t need to specify <code>language_code</code></strong><br>you can receive the list of available languages with <code>language_name</code> by making a separate request to <code>https://api.dataforseo.com/v3/business_data/google/languages</code><br>example:<br><code class="long-string">English</code>'
        language_code:
          type: string
          description: '<em>search engine language code</em><br><strong>required field if you don''t specify</strong> <code>language_name</code><br><strong>if you use this field, you don''t need to specify <code>language_name</code></strong><br>you can receive the list of available languages with their <code>language_code</code>_by making a separate request to <code>https://api.dataforseo.com/v3/business_data/google/languages</code><em><br></em>example:<em><br></em><code class="long-string">en</code>n'
        depth:
          type: integer
          description: '<em>parsing depth</em><br>optional field<br>number of results in SERP<br>default value: <code>20</code><br>max value: <code>100</code><br><strong>Your account will be billed per each SERP containing up to 20 results;</strong> <br>Setting depth above 20 may result in additional charges if the search engine returns more than 20 results</a>;<br>If the specified depth is higher than the number of questions in the response, the difference will be refunded automatically to your account balance;<br>The cost can be calculated on the <a title="Pricing" href="https://dataforseo.com/pricing/business-data/google-questions-and-answers-api-pricing" target="_blank" rel="noopener noreferrer">Pricing</a> page.'
          nullable: true
        tag:
          type: string
          description: <em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response
          nullable: true
      example:
        - language_code: en
          location_name: 'Los Angeles,California,United States'
          keyword: The Last Bookstore
    BusinessDataGoogleQuestionsAndAnswersLiveResultInfo:
      type: object
      properties:
        keyword:
          type: string
          description: <em>keyword received in a POST array</em><br><strong>keyword is returned with decoded %## (plus character '+' will be decoded to a space character)</strong><br>this field will contain the <code>cid</code> parameter if you specified it in the <code>keyword</code> field when setting a task;<br>example:<br><code>cid:2946633002421908862</code><br>learn more about the parameter in <a href="https://dataforseo.com/help-center/what-is-cid-place-id-feature-id" target="_blank" rel="noopener noreferrer">this help center article</a>
          nullable: true
        se_domain:
          type: string
          description: <em>search engine domain as specified in a POST array</em>
          nullable: true
        location_code:
          type: integer
          description: <em>location code in a POST array</em>
          nullable: true
        language_code:
          type: string
          description: <em>language code in a POST array</em>
          nullable: true
        check_url:
          type: string
          description: <em>direct URL to search engine results</em><br>you can use it to make sure that we provided accurate results
          nullable: true
        datetime:
          type: string
          description: '<em>date and time when the result was received</em><br>in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”<br>example:<br><code class="long-string">2019-11-15 12:57:46 +00:00</code>'
          nullable: true
        cid:
          type: string
          description: <em>google-defined client id</em><br>unique id of a local establishment;<br>learn more about the identifier in <a href="https://dataforseo.com/help-center/what-is-cid-place-id-feature-id" target="_blank" rel="noopener noreferrer">this help center article</a>
          nullable: true
        feature_id:
          type: string
          description: <em> unique identifier of the SERP feature</em>
          nullable: true
        item_types:
          type: array
          items:
            type: string
            nullable: true
          description: '<em>item types</em><br>types of search engine results encountered in the <code>items</code> array;<br>possible item types: <code>google_business_question_item</code>'
          nullable: true
        items_without_answers:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/GoogleBusinessQuestionItem'
            nullable: true
          description: <em>array of google business question items without answers</em>
          nullable: true
        items_count:
          type: integer
          description: <em>the number of items in the <code>items</code> array</em>
          format: int64
          nullable: true
        items:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/GoogleBusinessQuestionItem'
            nullable: true
          description: <em>array of items</em><br>items within <code>google_business_question_item</code>
          nullable: true
    BusinessDataGoogleQuestionsAndAnswersLiveTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/BusinessDataGoogleQuestionsAndAnswersLiveResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    BusinessDataGoogleQuestionsAndAnswersLiveResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/BusinessDataGoogleQuestionsAndAnswersLiveTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    BusinessDataTrustpilotSearchTaskPostRequestInfo:
      type: object
      properties:
        keyword:
          type: string
          description: '<em>keyword</em><br><strong>required field</strong><br>the keyword you specify should indicate a business category or company name;<br>you can specify up to 700 characters in the <code>keyword</code> filed;<br>all %## will be decoded (plus character ‘+’ will be decoded to a space character);<br>if you need to use the “%” character for your <code>keyword</code>, please specify it as “%25”<p>learn more about rules and limitations of <code>keyword</code> and <code>keywords</code> fields in DataForSEO APIs in this <a href="https://dataforseo.com/help-center/rules-and-limitations-of-keyword-and-keywords-fields-in-dataforseo-apis" rel="noopener noreferrer" target="_blank">Help Center article</a>'
        priority:
          type: integer
          description: <em>task priority</em><br>optional field<br>can take the following values:<br>1 – normal execution priority (set by default)<br>2 – high execution priorityYou will be additionally charged for the tasks with high execution priority.<br>The cost can be calculated on the <a title="Pricing" href="https://dataforseo.com/pricing/business-data/business-data-api-trustpilot-search-pricing" target="_blank" rel="noopener noreferrer">Pricing</a> page.
          nullable: true
        depth:
          type: integer
          description: '<em>parsing depth</em><br>optional field<br>number of search results to be returned from the API response<br>we strongly recommend setting the parsing depth in the multiples of twenty because our systems processes twenty search results in a row;<br>default value: <code>10</code>;<br>maximum value: <code>140</code><br><strong>Your account will be billed per each SERP containing up to 10 results;</strong> <br>Setting depth above 10 may result in additional charges if the search engine returns more than 10 results</a>;<br>The cost can be calculated on the <a title="Pricing" href="https://dataforseo.com/pricing/business-data/business-data-api-trustpilot-search-pricing" target="_blank" rel="noopener noreferrer">Pricing</a> page.'
          nullable: true
        tag:
          type: string
          description: <em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response
          nullable: true
        postback_url:
          type: string
          description: '<em>URL for sending task results</em><br>optional field<br>once the task is completed, we will send a POST request with its results compressed in the <code>gzip</code> format to the <code>postback_url</code> you specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/postbackscript?id=$id</code><br><code>http://your-server.com/postbackscript?id=$id&amp;tag=$tag</code><br><strong>Note:</strong> special characters in <code>postback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href="https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api" target="_blank" rel="noopener noreferrer">Help Center</a>'
          nullable: true
        pingback_url:
          type: string
          description: '<em>notification URL of a completed task</em><br>optional field<br>when a task is completed we will notify you by GET request sent to the URL you have specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/pingscript?id=$id</code><br><code>http://your-server.com/pingscript?id=$id&amp;tag=$tag</code><br><strong>Note:</strong> special characters in <code>pingback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href="https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api" target="_blank" rel="noopener noreferrer">Help Center</a>'
          nullable: true
      example:
        - keyword: pizza restaurant
          depth: 20
    BusinessDataTrustpilotSearchTaskPostTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: object
              description: '<em>array of results</em><br>in this case, the value will be <code>null</code>'
              nullable: true
    BusinessDataTrustpilotSearchTaskPostResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/BusinessDataTrustpilotSearchTaskPostTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    BusinessDataTrustpilotSearchTasksReadyResultInfo:
      type: object
      properties:
        id:
          type: string
          description: <em>task identifier of the completed task</em><br><strong>unique task identifier in our system in the <a href="https://en.wikipedia.org/wiki/Universally_unique_identifier">UUID</a> format</strong>
          nullable: true
        se:
          type: string
          description: '<em>search engine specified when setting the task</em><br>can take the following values: <code>trustpilot</code>'
          nullable: true
        se_type:
          type: string
          description: <em>search engine type</em>
          nullable: true
        date_posted:
          type: string
          description: <em>date when the task was posted (in the UTC format)</em>
          nullable: true
        tag:
          type: string
          description: <em>user-defined task identifier</em>
          nullable: true
        endpoint:
          type: string
          description: <em>URL for collecting the results of the task</em>
          nullable: true
    BusinessDataTrustpilotSearchTasksReadyTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/BusinessDataTrustpilotSearchTasksReadyResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    BusinessDataTrustpilotSearchTasksReadyResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/BusinessDataTrustpilotSearchTasksReadyTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    TrustpilotSearchOrganic:
      type: object
      properties:
        type:
          type: string
          description: type of element
          nullable: true
        rank_group:
          type: integer
          description: <em>position within a group of elements with identical <code>type</code> values</em><br>positions of elements with different <code>type</code> values are omitted from <code>rank_group</code>
          nullable: true
        rank_absolute:
          type: integer
          description: <em>absolute rank among all the listed reviews</em><br>absolute position among all reviews on the list
          nullable: true
        title:
          type: string
          description: <em>title of the establishment</em>
          nullable: true
        domain:
          type: string
          description: <em>domain of the establishment</em>
          nullable: true
        url:
          type: string
          description: <em>URL to the establishment</em>
          nullable: true
        reviews_count:
          type: integer
          description: <em>the total number of reviews</em>
          format: int64
          nullable: true
        rating:
          type: object
          oneOf:
            - $ref: '#/components/schemas/RatingInfo'
          description: <em>the rating score of the establishment submitted by reviewers</em>
          nullable: true
    BusinessDataTrustpilotSearchTaskGetResultInfo:
      type: object
      properties:
        keyword:
          type: string
          description: <em>keyword in a POST array</em>
          nullable: true
        se_domain:
          type: string
          description: <em>search engine domain in a POST array</em>
          nullable: true
        check_url:
          type: string
          description: <em>direct URL to search engine results</em><br>you can use it to make sure that we provided accurate results
          nullable: true
        datetime:
          type: string
          description: '<em>date and time when the result was received</em><br>in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”<br>example:<br><code class="long-string">2019-11-15 12:57:46 +00:00</code>'
          nullable: true
        items_count:
          type: integer
          description: <em>the number of items in the results array</em><br>you can get more results by using the <code>depth</code> parameter when setting a task
          format: int64
          nullable: true
        items:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/TrustpilotSearchOrganic'
            nullable: true
          description: <em>found reviews</em><br>you can get more results by using the <code>depth</code> parameter when setting a task
          nullable: true
    BusinessDataTrustpilotSearchTaskGetTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/BusinessDataTrustpilotSearchTaskGetResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    BusinessDataTrustpilotSearchTaskGetResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/BusinessDataTrustpilotSearchTaskGetTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    BusinessDataTrustpilotReviewsTaskPostRequestInfo:
      type: object
      properties:
        domain:
          type: string
          description: <em>domain of the local establishment</em><br><strong>required field</strong><br>domain of the local establishment on Trustpilot;<br>you can find the domain in the URL of every business listed on Trustpilot<br>example:<br><code>www.thepearlsource.com</code><br><code>https://www.trustpilot.com/review/<strong>www.thepearlsource.com</strong></code>
        sort_by:
          type: string
          description: '<em>results sorting parameter</em><br>optional field<br>you can use this field to sort the results;<br>possible sorting parameters:<br><code>recency</code> — most recent reviews first;<br><code>relevance</code> — most relevant reviews first;<br>default value: <code>relevance</code>'
          nullable: true
        priority:
          type: integer
          description: <em>task priority</em><br>optional field<br>can take the following values:<br>1 – normal execution priority (set by default)<br>2 – high execution priorityYou will be additionally charged for the tasks with high execution priority.<br>The cost can be calculated on the <a title="Pricing" href="https://dataforseo.com/pricing/business-data/business-data-api-trustpilot-reviews-pricing" target="_blank" rel="noopener noreferrer">Pricing</a> page.
          nullable: true
        depth:
          type: integer
          description: '<em>parsing depth</em><br>optional field<br>number of reviews to be returned from the API response<br>we strongly recommend setting the parsing depth in the multiples of twenty, because our system processes twenty reviews in a row<br>default value: <code>20</code><br>maximum value: <code>200</code><br><strong>Your account will be billed per each SERP containing up to 20 results;</strong> <br>Setting depth above 20 may result in additional charges if the search engine returns more than 20 results</a>;<br>The cost can be calculated on the <a title="Pricing" href="https://dataforseo.com/pricing/business-data/business-data-api-trustpilot-reviews-pricing" target="_blank" rel="noopener noreferrer">Pricing</a> page.'
          nullable: true
        tag:
          type: string
          description: <em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response
          nullable: true
        postback_url:
          type: string
          description: '<em>URL for sending task results</em><br>optional field<br>once the task is completed, we will send a POST request with its results compressed in the <code>gzip</code> format to the <code>postback_url</code> you specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/postbackscript?id=$id</code><br><code>http://your-server.com/postbackscript?id=$id&amp;tag=$tag</code><br><strong>Note:</strong> special characters in <code>postback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href="https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api" target="_blank" rel="noopener noreferrer">Help Center</a>'
          nullable: true
        pingback_url:
          type: string
          description: '<em>notification URL of a completed task</em><br>optional field<br>when a task is completed we will notify you by GET request sent to the URL you have specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/pingscript?id=$id</code><br><code>http://your-server.com/pingscript?id=$id&amp;tag=$tag</code><br><strong>Note:</strong> special characters in <code>pingback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href="https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api" target="_blank" rel="noopener noreferrer">Help Center</a>'
          nullable: true
      example:
        - domain: www.thepearlsource.com
          depth: 40
    BusinessDataTrustpilotReviewsTaskPostTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: object
              description: '<em>array of results</em><br>in this case, the value will be <code>null</code>'
              nullable: true
    BusinessDataTrustpilotReviewsTaskPostResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/BusinessDataTrustpilotReviewsTaskPostTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    BusinessDataTrustpilotReviewsTasksReadyResultInfo:
      type: object
      properties:
        id:
          type: string
          description: <em>task identifier of the completed task</em><br><strong>unique task identifier in our system in the <a href="https://en.wikipedia.org/wiki/Universally_unique_identifier">UUID</a> format</strong>
          nullable: true
        se:
          type: string
          description: '<em>search engine specified when setting the task</em><br>can take the following values: <code>trustpilot</code>'
          nullable: true
        se_type:
          type: string
          description: <em>search engine type</em>
          nullable: true
        date_posted:
          type: string
          description: <em>date when the task was posted (in the UTC format)</em>
          nullable: true
        tag:
          type: string
          description: <em>user-defined task identifier</em>
          nullable: true
        endpoint:
          type: string
          description: <em>URL for collecting the results of the task</em>
          nullable: true
    BusinessDataTrustpilotReviewsTasksReadyTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/BusinessDataTrustpilotReviewsTasksReadyResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    BusinessDataTrustpilotReviewsTasksReadyResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/BusinessDataTrustpilotReviewsTasksReadyTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    BusinessDataUserProfileInfo:
      type: object
      properties:
        name:
          type: string
          nullable: true
        url:
          type: string
          nullable: true
        image_url:
          type: string
          nullable: true
        location:
          type: string
          nullable: true
        reviews_count:
          type: integer
          description: <em>total number of reviews submitted by the reviewer</em>
          format: int64
          nullable: true
    TrustpilotReviewSearch:
      type: object
      properties:
        type:
          type: string
          description: type of element
          nullable: true
        rank_group:
          type: integer
          description: <em>position within a group of elements with identical <code>type</code> values</em><br>positions of elements with different <code>type</code> values are omitted from <code>rank_group</code>
          nullable: true
        rank_absolute:
          type: integer
          description: <em>absolute rank among all the listed reviews</em><br>absolute position among all reviews on the list
          nullable: true
        position:
          type: string
          description: '<em>the alignment of the review in SERP</em><br>can take the following values: <code>right</code>'
          nullable: true
        url:
          type: string
          description: <em>the URL of the review</em>
          nullable: true
        rating:
          type: object
          oneOf:
            - $ref: '#/components/schemas/RatingInfo'
          description: <em>the rating score submitted by the reviewer</em>
          nullable: true
        verified:
          type: boolean
          description: <em>indicates whether the review has the "Verified" mark</em>
          nullable: true
        language:
          type: string
          description: <em>the language of the review</em>
          nullable: true
        timestamp:
          type: string
          description: '<em>date and time when a review was published</em><br>in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”<br>example:<br><code>2019-11-15 12:57:46 +00:00</code>'
          nullable: true
        title:
          type: string
          description: <em>the title of the review</em>
          nullable: true
        review_text:
          type: string
          description: <em>the content of the review</em>
          nullable: true
        review_images:
          type: array
          items:
            type: string
          description: '<em>images submitted by the reviewer</em><br>displays URLs to the images provided by the author of the review;<br><strong>please note</strong> that Trustpilot doesn''t allow adding images to reviews, so the <code>review_images</code> parameter will always equal <code>null</code>'
          nullable: true
        user_profile:
          type: object
          oneOf:
            - $ref: '#/components/schemas/BusinessDataUserProfileInfo'
          description: <em>user profile of the reviewer</em>
          nullable: true
        responses:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/ReviewResponseItemInfo'
            nullable: true
          description: <em>owner's response to the submitted review</em>
          nullable: true
    BusinessDataTrustpilotReviewsTaskGetResultInfo:
      type: object
      properties:
        domain:
          type: string
          description: <em>domain of the business entity</em>
          nullable: true
        type:
          type: string
          description: type of element
          nullable: true
        se_domain:
          type: string
          description: <em>search engine domain in a POST array</em>
          nullable: true
        check_url:
          type: string
          description: <em>direct URL to search engine results</em><br>you can use it to make sure that we provided accurate results
          nullable: true
        datetime:
          type: string
          description: '<em>date and time when the result was received</em><br>in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”<br>example:<br><code class="long-string">2019-11-15 12:57:46 +00:00</code>'
          nullable: true
        title:
          type: string
          description: <em>title of the 'reviews' element on Trustpilot</em><br>the name of the business entity for which the reviews are collected
          nullable: true
        location:
          type: string
          description: <em>location of the business entity as specified on Trustpilot</em><br>address of the business entity for which the reviews are collected
          nullable: true
        reviews_count:
          type: string
          description: <em>the total number of reviews</em>
          format: int64
          nullable: true
        rating:
          type: object
          description: <em>rating of the corresponding business entity</em><br>popularity rate based on reviews and displayed in SERP
          nullable: true
        items_count:
          type: integer
          description: <em>the number of items in the results array</em><br>you can get more results by using the <code>depth</code> parameter when setting a task
          format: int64
          nullable: true
        items:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/TrustpilotReviewSearch'
            nullable: true
          description: <em>found reviews</em><br>you can get more results by using the <code>depth</code> parameter when setting a task
          nullable: true
    BusinessDataTrustpilotReviewsTaskGetTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/BusinessDataTrustpilotReviewsTaskGetResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    BusinessDataTrustpilotReviewsTaskGetResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/BusinessDataTrustpilotReviewsTaskGetTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    BusinessDataTripadvisorLocationsResultInfo:
      type: object
      properties:
        location_code:
          type: integer
          description: <em>location code</em>
          nullable: true
        location_name:
          type: string
          description: <em>full name of the location</em>
          nullable: true
        location_name_parent:
          type: string
          description: '<em>the name of the superordinate location</em><br>example:<br><code>"location_code": 9041134,<br>"location_name": "Vienna International Airport,Lower Austria,Austria",<br>"location_name_parent": "Lower Austria,Austria"</code>'
          nullable: true
        country_iso_code:
          type: string
          description: <em>ISO country code of the location</em>
          nullable: true
        location_type:
          type: string
          description: <em>location type</em>
          nullable: true
    BusinessDataTripadvisorLocationsTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/BusinessDataTripadvisorLocationsResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    BusinessDataTripadvisorLocationsResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/BusinessDataTripadvisorLocationsTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    BusinessDataTripadvisorLocationsCountryResultInfo:
      type: object
      properties:
        location_code:
          type: integer
          description: <em>location code</em>
          nullable: true
        location_name:
          type: string
          description: <em>full name of the location</em>
          nullable: true
        location_name_parent:
          type: string
          description: '<em>the name of the superordinate location</em><br>example:<br><code>"location_code": 9041134,<br>"location_name": "Vienna International Airport,Lower Austria,Austria",<br>"location_name_parent": "Lower Austria,Austria"</code>'
          nullable: true
        country_iso_code:
          type: string
          description: <em>ISO country code of the location</em>
          nullable: true
        location_type:
          type: string
          description: <em>location type</em>
          nullable: true
    BusinessDataTripadvisorLocationsCountryTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/BusinessDataTripadvisorLocationsCountryResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    BusinessDataTripadvisorLocationsCountryResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/BusinessDataTripadvisorLocationsCountryTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    BusinessDataTripadvisorLanguagesResultInfo:
      type: object
      properties:
        language_name:
          type: string
          description: <em>language name</em>
          nullable: true
        language_code:
          type: string
          description: <em>language code according to <a href="https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes" target="_blank" rel="noopener noreferrer">ISO 639-1</a></em>
          nullable: true
    BusinessDataTripadvisorLanguagesTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/BusinessDataTripadvisorLanguagesResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    BusinessDataTripadvisorLanguagesResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/BusinessDataTripadvisorLanguagesTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    BusinessDataTripadvisorSearchTaskPostRequestInfo:
      type: object
      properties:
        keyword:
          type: string
          description: '<em>keyword</em><br><strong>required field</strong><br>the keyword you specify should indicate a business category, company name, or a prominent place;<br>you can specify up to 700 characters in the <code>keyword</code> filed;<br>all %## will be decoded (plus character ‘+’ will be decoded to a space character);<br>if you need to use the “%” character for your <code>keyword</code>, please specify it as “%25”<p>learn more about rules and limitations of <code>keyword</code> and <code>keywords</code> fields in DataForSEO APIs in this <a href="https://dataforseo.com/help-center/rules-and-limitations-of-keyword-and-keywords-fields-in-dataforseo-apis" rel="noopener noreferrer" target="_blank">Help Center article</a>'
        location_name:
          type: string
          description: '<em>full name of search engine location</em><br><strong>required field if you don''t specify <code>location_code</code></strong><br>you can receive the list of available locations with <code>location_name</code> by making a separate request to the <code>https://api.dataforseo.com/v3/business_data/tripadvisor/locations</code><br>example:<br><code class="long-string">London,England,United Kingdom</code>'
        location_code:
          type: integer
          description: <em>search engine location code</em><br><strong>required field if you don't specify <code>location_name</code></strong><br>you can receive the list of available locations with <code>location_code</code> by making a separate request to the <code>https://api.dataforseo.com/v3/business_data/tripadvisor/locations</code><br>example:<br><code class="long-string">1003854</code>
        priority:
          type: integer
          description: <em>task priority</em><br>optional field<br>can take the following values:<br>1 – normal execution priority (set by default)<br>2 – high execution priorityYou will be additionally charged for the tasks with high execution priority.<br>The cost can be calculated on the <a title="Pricing" href="https://dataforseo.com/pricing/business-data/business-data-api-tripadvisor-search-pricing" target="_blank" rel="noopener noreferrer">Pricing</a> page.
          nullable: true
        depth:
          type: integer
          description: '<em>parsing depth</em><br>optional field<br>number of search results to be returned from the API response<br>we strongly recommend setting the parsing depth in the multiples of thirty because our systems processes thirty search results in a row;<br>default value: <code>30</code>;<br>maximum value: <code>210</code><p><strong>Your account will be billed per each SERP containing up to 30 results;</strong> <br>Setting depth above 30 may result in additional charges if the search engine returns more than 30 results</a>;<br>The cost can be calculated on the <a title="Pricing" href="https://dataforseo.com/pricing/business-data/business-data-api-tripadvisor-search-pricing" target="_blank" rel="noopener noreferrer">Pricing</a> page.'
          nullable: true
        tag:
          type: string
          description: <em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response
          nullable: true
        postback_url:
          type: string
          description: '<em>URL for sending task results</em><br>optional field<br>once the task is completed, we will send a POST request with its results compressed in the <code>gzip</code> format to the <code>postback_url</code> you specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/postbackscript?id=$id</code><br><code>http://your-server.com/postbackscript?id=$id&amp;tag=$tag</code><br><strong>Note:</strong> special characters in <code>postback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href="https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api" target="_blank" rel="noopener noreferrer">Help Center</a>'
          nullable: true
        pingback_url:
          type: string
          description: '<em>notification URL of a completed task</em><br>optional field<br>when a task is completed we will notify you by GET request sent to the URL you have specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/pingscript?id=$id</code><br><code>http://your-server.com/pingscript?id=$id&amp;tag=$tag</code><br><strong>Note:</strong> special characters in <code>pingback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href="https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api" target="_blank" rel="noopener noreferrer">Help Center</a>'
          nullable: true
      example:
        - keyword: pizza
          location_code: 1003854
          depth: 30
    BusinessDataTripadvisorSearchTaskPostTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: object
              description: '<em>array of results</em><br>in this case, the value will be <code>null</code>'
              nullable: true
    BusinessDataTripadvisorSearchTaskPostResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/BusinessDataTripadvisorSearchTaskPostTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    BusinessDataTripadvisorSearchTasksReadyResultInfo:
      type: object
      properties:
        id:
          type: string
          description: <em>task identifier of the completed task</em><br><strong>unique task identifier in our system in the <a href="https://en.wikipedia.org/wiki/Universally_unique_identifier">UUID</a> format</strong>
          nullable: true
        se:
          type: string
          description: '<em>search engine specified when setting the task</em><br>can take the following values: <code>tripadvisor</code>'
          nullable: true
        se_type:
          type: string
          description: <em>search engine type</em>
          nullable: true
        date_posted:
          type: string
          description: <em>date when the task was posted (in the UTC format)</em>
          nullable: true
        tag:
          type: string
          description: <em>user-defined task identifier</em>
          nullable: true
        endpoint:
          type: string
          description: <em>URL for collecting the results of the task</em>
          nullable: true
    BusinessDataTripadvisorSearchTasksReadyTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/BusinessDataTripadvisorSearchTasksReadyResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    BusinessDataTripadvisorSearchTasksReadyResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/BusinessDataTripadvisorSearchTasksReadyTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    TripadvisorSearchOrganic:
      type: object
      properties:
        type:
          type: string
          description: type of element
          nullable: true
        rank_group:
          type: integer
          description: <em>position within a group of elements with identical <code>type</code> values</em><br>positions of elements with different <code>type</code> values are omitted from <code>rank_group</code>
          nullable: true
        rank_absolute:
          type: integer
          description: <em>absolute rank among all the listed results</em><br>absolute position among all reviews on the list
          nullable: true
        title:
          type: string
          description: <em>name of the business entity</em>
          nullable: true
        url_path:
          type: string
          description: <em>URL path of the business entity</em><br>URL path to the Tripadvisor page of the business entity<br>you can use this identifier to collect reviews for the business entity using <a href="/v3/business_data/tripadvisor/reviews/task_post/" rel="noopener noreferrer" target="_blank">Tripadvisor Reviews</a>
          nullable: true
        is_sponsored:
          type: boolean
          description: '<em>indicates a sponsored placement</em><br>if <code>true</code>, related <code>tripadvisor_search_organic</code> item is a paid advertising on Tripadvisor'
          nullable: true
        reviews_count:
          type: integer
          description: <em>the total number of reviews</em>
          format: int64
          nullable: true
        category:
          type: string
          description: <em>place category</em>
          nullable: true
        price_rate:
          type: string
          description: <em>average price rate</em>
          nullable: true
        rating:
          type: object
          oneOf:
            - $ref: '#/components/schemas/RatingInfo'
          description: <em>the rating score of the establishment submitted by the reviewers</em>
          nullable: true
    BusinessDataTripadvisorSearchTaskGetResultInfo:
      type: object
      properties:
        keyword:
          type: string
          description: <em>keyword received in a POST array</em><br>this field will contain the <code>alias</code> parameter if it was specified in a POST array
          nullable: true
        se_domain:
          type: string
          description: <em>search engine domain in a POST array</em>
          nullable: true
        location_code:
          type: integer
          description: <em>location code in a POST array</em>
          nullable: true
        language_code:
          type: string
          description: <em>language code in a POST array</em>
          nullable: true
        check_url:
          type: string
          description: <em>direct URL to Tripadvisor results</em><br>you can use it to make sure that we provided accurate results
          nullable: true
        datetime:
          type: string
          description: '<em>date and time when the result was received</em><br>in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”<br>example:<br><code class="long-string">2019-11-15 12:57:46 +00:00</code>'
          nullable: true
        item_types:
          type: array
          items:
            type: string
            nullable: true
          description: '<em>item types encountered in the result</em><br>possible item types: <code>tripadvisor_search_organic</code>'
          nullable: true
        se_results_count:
          type: integer
          description: <em>the total number of results</em>
          format: int64
          nullable: true
        items_count:
          type: integer
          description: <em>the number of items in the results array</em><br>you can get more results by using the <code>depth</code> parameter when setting a task
          format: int64
          nullable: true
        items:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/TripadvisorSearchOrganic'
            nullable: true
          description: <em>Tripadvisor search listing results</em><br>you can get more results by using the <code>depth</code> parameter when setting a task
          nullable: true
    BusinessDataTripadvisorSearchTaskGetTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/BusinessDataTripadvisorSearchTaskGetResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    BusinessDataTripadvisorSearchTaskGetResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/BusinessDataTripadvisorSearchTaskGetTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    BusinessDataTripadvisorReviewsTaskPostRequestInfo:
      type: object
      properties:
        url_path:
          type: string
          description: <em>URL path of the business entity</em><br><strong>required field if you do not specify <code>keyword</code></strong><br>URL path to the Tripadvisor page of the business entity;<br>examples:<br><code>Hotel_Review-g60763-d23462501-Reviews-Margaritaville_Times_Square-New_York_City_New_York.html</code><br><code>https://www.tripadvisor.com/Hotel_Review-g60763-d23462501-Reviews-Margaritaville_Times_Square-New_York_City_New_York.html</code>
        keyword:
          type: string
          description: '<em>keyword</em><br><strong>required field if you do not specify <code>url_path</code></strong><br>the keyword you specify should indicate a name of an existing business or prominent place on Tripadvisor;<br>you can specify up to 700 characters in the <code>keyword</code> filed;<br>all %## will be decoded (plus character ‘+’ will be decoded to a space character);<br>if you need to use the “%” character for your <code>keyword</code>, please specify it as “%25”'
        location_name:
          type: string
          description: '<em>full name of search engine location</em><br><strong>required field if you don''t specify <code>location_code</code> or <code>url_path</code></strong><br>you can receive the list of available locations with <code>location_name</code> by making a separate request to the <code>https://api.dataforseo.com/v3/business_data/tripadvisor/locations</code><br>example:<br><code class="long-string">London,England,United Kingdom</code>'
        location_code:
          type: integer
          description: <em>search engine location code</em><br><strong>required field if you don't specify <code>location_name</code> or <code>url_path</code></strong><br>you can receive the list of available locations with <code>location_code</code> by making a separate request to the <code>https://api.dataforseo.com/v3/business_data/tripadvisor/locations</code><br>example:<br><code class="long-string">1003854</code>
        priority:
          type: integer
          description: <em>task priority</em><br>optional field<br>can take the following values:<br>1 – normal execution priority (set by default)<br>2 – high execution priorityYou will be additionally charged for the tasks with high execution priority.<br>The cost can be calculated on the <a title="Pricing" href="https://dataforseo.com/pricing/business-data/business-data-api-tripadvisor-pricing" target="_blank" rel="noopener noreferrer">Pricing</a> page.
          nullable: true
        language_name:
          type: string
          description: '<em>full name of search engine language</em><br>optional field<br><strong>if you use this field, your account will be charged for one extra request</strong><br>you can receive the list of available languages with <code>language_name</code> by making a separate request to the <code>https://api.dataforseo.com/v3/business_data/tripadvisor/languages</code><br>example:<br><code class="long-string">English</code><br>You will be additionally charged for setting a language parameter in this endpoint.<br>The cost can be calculated on the <a title="Pricing" href="https://dataforseo.com/pricing/business-data/business-data-api-tripadvisor-pricing" target="_blank" rel="noopener noreferrer">Pricing</a> page.'
          nullable: true
        language_code:
          type: string
          description: '<em>search engine language code</em><br>optional field<br><strong>if you use this field, your account will be charged for one extra request</strong><br>you can receive the list of available languages with <code>language_code</code> by making a separate request to the <code>https://api.dataforseo.com/v3/business_data/tripadvisor/languages</code><br>example:<em><br></em><code class="long-string">en</code><br>You will be additionally charged for setting a language parameter in this endpoint.<br>The cost can be calculated on the <a title="Pricing" href="https://dataforseo.com/pricing/business-data/business-data-api-tripadvisor-pricing" target="_blank" rel="noopener noreferrer">Pricing</a> page.'
          nullable: true
        depth:
          type: integer
          description: '<em>parsing depth</em><br>optional field<br>number of reviews in SERP;<br>we strongly recommend setting the parsing depth in the multiples of ten, because our systems processes ten reviews in a row;<br>default value: <code>10</code>;<br>max value: <code>4490</code><br><strong>Your account will be billed per each SERP containing up to 10 results;</strong> <br>Setting depth above 10 may result in additional charges if the search engine returns more than 10 results</a>;<br>The cost can be calculated on the <a title="Pricing" href="https://dataforseo.com/pricing/business-data/business-data-api-tripadvisor-pricing" target="_blank" rel="noopener noreferrer">Pricing</a> page.'
          nullable: true
        ratings:
          type: array
          items:
            type: string
          description: '<em>Tripadvisor traveler rating for a place of interest</em><br>optional field<br>rating based on the written reviews by a traveler after they visited a place.<br>possible values: <code>excellent</code>, <code>very_good</code>, <code>average</code>, <code>poor</code>, <code>terrible</code><br>you can specify several values at once'
          nullable: true
        visit_type:
          type: array
          items:
            type: string
          description: '<em>filter by type of travelers who left a review</em><br>optional field<br>possible values: <code>families</code>, <code>couples</code>, <code>solo</code>, <code>business</code>, <code>friends</code><br>you can specify several values at once'
          nullable: true
        months:
          type: array
          items:
            type: string
          description: '<em>filter by months when a traveler made a visit</em><br>optional field<br>possible values: <code>january</code>, <code>february</code>, <code>march</code>, <code>april</code>, <code>may</code>, <code>april</code>, <code>june</code>, <code>july</code>, <code>august</code>, <code>september</code>, <code>october</code>, <code>november</code>, <code>december</code><br>you can specify several values at once'
          nullable: true
        sort_by:
          type: string
          description: <em>results sorting parameters</em><br>optional field<br>you can use this field to sort the results;<br>possible types of sorting:<br><code>most_recent</code><br><code>detailed_reviews</code>
          nullable: true
        translate_reviews:
          type: boolean
          description: '<em>translate reviews according to the URL path</em><br>optional field<br>if set to <code>true</code>, returned reviews will be translated to the language matching the specified <code>url_path</code>;<br>for example, if <code>url_path</code> contains <code>tripadvisor.it</code> and <code>translate_reviews</code> is <code>true</code>, reviews will be translated to the Italian language;<br>default value: <code>true</code><br>you can learn more about how reviews are translated in <a href="https://dataforseo.com/help-center/how-to-translate-reviews-in-tripadvisor-business-data-api" rel="noopener noreferrer" target="_blank">this Help Center article</a>'
          nullable: true
        tag:
          type: string
          description: <em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response
          nullable: true
        postback_url:
          type: string
          description: '<em>URL for sending task results</em><br>optional field<br>once the task is completed, we will send a POST request with its results compressed in the <code>gzip</code> format to the <code>postback_url</code> you specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/postbackscript?id=$id</code><br><code>http://your-server.com/postbackscript?id=$id&amp;tag=$tag</code><br><strong>Note:</strong> special characters in <code>postback_url</code> will be urlencoded;<br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href="https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api" target="_blank" rel="noopener noreferrer">Help Center</a>'
          nullable: true
        pingback_url:
          type: string
          description: '<em>notification URL of a completed task</em><br>optional field<br>when a task is completed we will notify you by GET request sent to the URL you have specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/pingscript?id=$id</code><br><code>http://your-server.com/pingscript?id=$id&amp;tag=$tag</code><br><strong>Note:</strong> special characters in <code>pingback_url</code> will be urlencoded;<br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href="https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api" target="_blank" rel="noopener noreferrer">Help Center</a>'
          nullable: true
      example:
        - url_path: Hotel_Review-g60763-d23462501-Reviews-Margaritaville_Times_Square-New_York_City_New_York.html
          location_code: 1003854
          pingback_url: https://your-server.com/pingback.php?id=$id&tag=$tag
          tag: some_string_123
    BusinessDataTripadvisorReviewsTaskPostTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: object
              description: '<em>array of results</em><br>in this case, the value will be <code>null</code>'
              nullable: true
    BusinessDataTripadvisorReviewsTaskPostResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/BusinessDataTripadvisorReviewsTaskPostTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    BusinessDataTripadvisorReviewsTasksReadyResultInfo:
      type: object
      properties:
        id:
          type: string
          description: <em>task identifier of the completed task</em><br><strong>unique task identifier in our system in the <a href="https://en.wikipedia.org/wiki/Universally_unique_identifier">UUID</a> format</strong>
          nullable: true
        se:
          type: string
          description: '<em>search engine specified when setting the task</em><br>can take the following values: <code>tripadvisor</code>'
          nullable: true
        se_type:
          type: string
          description: <em>search engine type</em>
          nullable: true
        date_posted:
          type: string
          description: <em>date when the task was posted (in the UTC format)</em>
          nullable: true
        tag:
          type: string
          description: <em>user-defined task identifier</em>
          nullable: true
        endpoint:
          type: string
          description: <em>URL for collecting the results of the task</em>
          nullable: true
    BusinessDataTripadvisorReviewsTasksReadyTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/BusinessDataTripadvisorReviewsTasksReadyResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    BusinessDataTripadvisorReviewsTasksReadyResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/BusinessDataTripadvisorReviewsTasksReadyTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    ImageUrlInfo:
      type: object
      properties:
        url:
          type: string
          description: <em>URL of the image used in the review</em>
          nullable: true
    TripadvisorReviewSearch:
      type: object
      properties:
        type:
          type: string
          description: type of element
          nullable: true
        rank_group:
          type: integer
          description: <em>position within a group of elements with identical <code>type</code> values</em><br>positions of elements with different <code>type</code> values are omitted from <code>rank_group</code>
          nullable: true
        rank_absolute:
          type: integer
          description: <em>absolute rank among all the listed reviews</em><br>absolute position among all reviews on the list
          nullable: true
        position:
          type: string
          description: '<em>the alignment of the review in SERP</em><br>can take the following values: <code>right</code>'
          nullable: true
        url:
          type: string
          description: <em>URL of the review</em>
          nullable: true
        rating:
          type: object
          oneOf:
            - $ref: '#/components/schemas/RatingInfo'
          description: <em>the rating score submitted by the reviewer</em>
          nullable: true
        date_of_visit:
          type: string
          description: '<em>date of the reviewer''s visit to the local establishment</em><br>in the UTC format: "yyyy-mm-dd hh-mm-ss +00:00"<br>example:<br><code>2019-11-15 12:57:46 +00:00</code>'
          nullable: true
        timestamp:
          type: string
          description: '<em>date and time when the review was published</em><br>in the UTC format: "yyyy-mm-dd hh-mm-ss +00:00"<br>example:<br><code>2019-11-15 12:57:46 +00:00</code>'
          nullable: true
        review_id:
          type: string
          description: <em>ID of the review</em>
          nullable: true
        title:
          type: string
          description: <em>title of the review</em>
          nullable: true
        review_text:
          type: string
          description: <em>content of the review</em>
          nullable: true
        language:
          type: string
          description: <em>language of the review text</em>
          nullable: true
        original_language:
          type: string
          description: <em>language of the untranslated review text</em>
          nullable: true
        review_images:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/ImageUrlInfo'
            nullable: true
          description: <em>contains URLs of the images used in the review</em>
          nullable: true
        user_profile:
          type: object
          oneOf:
            - $ref: '#/components/schemas/BusinessDataUserProfileInfo'
          description: <em>information from the reviewer's profile</em>
          nullable: true
        responses:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/ReviewResponseItemInfo'
            nullable: true
          description: <em>contains information about the owner's response</em>
          nullable: true
        review_highlights:
          type: object
          description: <em>review highlights</em><br>contains highlighted review criteria and assessments
          nullable: true
    BusinessDataTripadvisorReviewsTaskGetResultInfo:
      type: object
      properties:
        url_path:
          type: string
          description: <em>URL path received in a POST array</em>
          nullable: true
        type:
          type: string
          description: type of element
          nullable: true
        se_domain:
          type: string
          description: <em>search engine domain in a POST array</em>
          nullable: true
        check_url:
          type: string
          description: <em>direct URL to search engine results</em><br>you can use it to make sure that we provided accurate results
          nullable: true
        datetime:
          type: string
          description: '<em>date and time when the result was received</em><br>in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”<br>example:<br><code class="long-string">2019-11-15 12:57:46 +00:00</code>'
          nullable: true
        title:
          type: string
          description: <em>title of the 'reviews' element in SERP</em><br>the name of the local establishment for which the reviews are collected
          nullable: true
        location:
          type: string
          description: <em>location of the local establishment</em><br>address of the local establishment for which the reviews are collected
          nullable: true
        reviews_count:
          type: integer
          description: <em>the total number of reviews</em>
          format: int64
          nullable: true
        rating:
          type: object
          oneOf:
            - $ref: '#/components/schemas/RatingInfo'
          description: <em>rating of the corresponding local establishment</em><br>popularity rate based on reviews and displayed in SERP
          nullable: true
        rating_distribution:
          type: object
          additionalProperties:
            type: integer
            format: Int64
            nullable: true
          description: <em>rating distribution by votes</em><br>the distribution of votes across the rating in the range from 1 to 5
          nullable: true
        items_count:
          type: integer
          description: <em>the number of reviews items in the results array</em><br>you can get more results by using the <code>depth</code> parameter when setting a task
          format: int64
          nullable: true
        items:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/TripadvisorReviewSearch'
            nullable: true
          description: <em>found reviews</em><br>you can get more results by using the <code>depth</code> parameter when setting a task
          nullable: true
        language_code:
          type: string
          description: language code in a POST array
          nullable: true
    BusinessDataTripadvisorReviewsTaskGetTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/BusinessDataTripadvisorReviewsTaskGetResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    BusinessDataTripadvisorReviewsTaskGetResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/BusinessDataTripadvisorReviewsTaskGetTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    AppendixFunctionTypeInfo:
      type: object
      properties:
        regular:
          type: number
          format: double
          nullable: true
        advanced:
          type: number
          format: double
          nullable: true
        html:
          type: number
          format: double
          nullable: true
    AppendixJobsSerpLimitsRatesDataInfo:
      type: object
      properties:
        task_post:
          type: number
          format: double
          nullable: true
    AppendixSerpDaysRatesDataInfo:
      type: object
      properties:
        task_post:
          type: number
          format: double
          nullable: true
        task_get:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixFunctionTypeInfo'
          nullable: true
        tasks_ready:
          type: number
          format: double
          nullable: true
        locations:
          type: number
          format: double
          nullable: true
        languages:
          type: number
          format: double
          nullable: true
        live:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixFunctionTypeInfo'
          properties:
            regular:
              type: number
              format: double
            advanced:
              type: number
              format: double
            html:
              type: number
              format: double
          nullable: true
        errors:
          type: number
          format: double
          nullable: true
        tasks_fixed:
          type: number
          format: double
          nullable: true
        jobs:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixJobsSerpLimitsRatesDataInfo'
          nullable: true
        screenshot:
          type: number
          format: double
          nullable: true
        id_list:
          type: number
          format: double
          nullable: true
        ai_summary:
          type: number
          format: double
          nullable: true
    AppendixInfo:
      type: object
      properties:
        task_post:
          type: number
          format: double
        task_get:
          type: number
          format: double
        tasks_ready:
          type: number
          format: double
        live:
          type: number
          format: double
    AppendixBingKeywordsDataLimitsRatesDataInfo:
      type: object
      properties:
        keyword_performance:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixInfo'
          nullable: true
        search_volume:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixInfo'
          nullable: true
        keywords_for_site:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixInfo'
          nullable: true
        keywords_for_keywords:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixInfo'
          nullable: true
        audience_estimation:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixInfo'
          nullable: true
        keyword_suggestions_for_url:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixInfo'
          nullable: true
    AppendixGoogleAdsKeywordsDataLimitsRatesDataInfo:
      type: object
      properties:
        status:
          type: number
          format: double
          nullable: true
        search_volume:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixInfo'
          nullable: true
        keywords_for_keywords:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixInfo'
          nullable: true
        keywords_for_site:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixInfo'
          nullable: true
        ad_traffic_by_keywords:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixInfo'
          nullable: true
    AppendixDataforseoTrendsKeywordsDataLimitsRatesDataInfo:
      type: object
      properties:
        explore:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixInfo'
          nullable: true
        subregion_interests:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixInfo'
          nullable: true
        demography:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixInfo'
          nullable: true
        merged_data:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixInfo'
          nullable: true
    AppendixClickstreamDataKeywordsDataLimitsRatesDataInfo:
      type: object
      properties:
        dataforseo_search_volume:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixInfo'
          nullable: true
        locations_and_languages:
          type: number
          format: double
          nullable: true
        bulk_search_volume:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixInfo'
          nullable: true
        global_search_volume:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixInfo'
          nullable: true
    AppendixKeywordsDataDaysRatesDataInfo:
      type: object
      properties:
        keywords_for_keywords:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixInfo'
          properties:
            task_post:
              type: number
              format: double
            task_get:
              type: number
              format: double
            tasks_ready:
              type: number
              format: double
            live:
              type: number
              format: double
          nullable: true
        keywords_for_site:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixInfo'
          nullable: true
        search_volume:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixInfo'
          nullable: true
        ad_traffic_by_keywords:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixInfo'
          nullable: true
        languages:
          type: number
          format: double
          nullable: true
        locations:
          type: number
          format: double
          nullable: true
        tasks_ready:
          type: number
          format: double
          nullable: true
        explore:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixInfo'
          nullable: true
        categories:
          type: number
          format: double
          nullable: true
        errors:
          type: number
          format: double
          nullable: true
        bing:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixBingKeywordsDataLimitsRatesDataInfo'
          nullable: true
        keyword_performance:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixInfo'
          nullable: true
        locations_and_languages:
          type: number
          format: double
          nullable: true
        google_ads:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixGoogleAdsKeywordsDataLimitsRatesDataInfo'
          nullable: true
        id_list:
          type: number
          format: double
          nullable: true
        dataforseo_trends:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixDataforseoTrendsKeywordsDataLimitsRatesDataInfo'
          nullable: true
        clickstream_data:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixClickstreamDataKeywordsDataLimitsRatesDataInfo'
          nullable: true
        audience_estimation:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixInfo'
          nullable: true
        keyword_suggestions_for_url:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixInfo'
          nullable: true
    AppendixAppendixDaysRatesDataInfo:
      type: object
      properties:
        user_data:
          type: number
          format: double
          nullable: true
        errors:
          type: number
          format: double
          nullable: true
    AppendixDataforseoLabsLimitsRatesDataInfo:
      type: object
      properties:
        related_keywords:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixInfo'
          nullable: true
        locations_and_languages:
          type: number
          format: double
          nullable: true
        categories:
          type: number
          format: double
          nullable: true
        errors:
          type: number
          format: double
          nullable: true
        available_filters:
          type: number
          format: double
          nullable: true
        product_competitors:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixInfo'
          nullable: true
        product_keyword_intersections:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixInfo'
          nullable: true
        product_rank_overview:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixInfo'
          nullable: true
        ranked_keywords:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixInfo'
          nullable: true
        serp_competitors:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixInfo'
          nullable: true
        subdomains:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixInfo'
          nullable: true
        relevant_pages:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixInfo'
          nullable: true
        competitors_domain:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixInfo'
          nullable: true
        domain_rank_overview:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixInfo'
          nullable: true
        domain_intersection:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixInfo'
          nullable: true
        page_intersection:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixInfo'
          nullable: true
        bulk_traffic_estimation:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixInfo'
          nullable: true
        bulk_keyword_difficulty:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixInfo'
          nullable: true
        bulk_search_volume:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixInfo'
          nullable: true
        keywords_for_site:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixInfo'
          nullable: true
        keyword_suggestions:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixInfo'
          nullable: true
        keyword_ideas:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixInfo'
          nullable: true
        categories_for_domain:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixInfo'
          nullable: true
        domain_metrics_by_categories:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixInfo'
          nullable: true
        top_searches:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixInfo'
          nullable: true
        domain_whois_overview:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixInfo'
          nullable: true
        historical_rank_overview:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixInfo'
          nullable: true
        keywords_for_categories:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixInfo'
          nullable: true
        historical_serps:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixInfo'
          nullable: true
        app_competitors:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixInfo'
          nullable: true
        keywords_for_app:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixInfo'
          nullable: true
        app_intersection:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixInfo'
          nullable: true
        bulk_app_metrics:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixInfo'
          nullable: true
        id_list:
          type: number
          format: double
          nullable: true
        search_intent:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixInfo'
          nullable: true
        historical_bulk_traffic_estimation:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixInfo'
          nullable: true
        categories_for_keywords:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixInfo'
          nullable: true
        keyword_overview:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixInfo'
          nullable: true
        historical_keyword_data:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixInfo'
          nullable: true
    AppendixWhoisDomainAnalyticsLimitsRatesDataInfo:
      type: object
      properties:
        overview:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixInfo'
          nullable: true
    AppendixTechnologiesDomainAnalyticsLimitsRatesDataInfo:
      type: object
      properties:
        domain_technologies:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixInfo'
          nullable: true
        domains_by_technology:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixInfo'
          nullable: true
        languages:
          type: number
          format: double
          nullable: true
        locations:
          type: number
          format: double
          nullable: true
        technologies:
          type: number
          format: double
          nullable: true
        aggregation_technologies:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixInfo'
          nullable: true
        technologies_summary:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixInfo'
          nullable: true
        domains_by_html_terms:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixInfo'
          nullable: true
        technology_stats:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixInfo'
          nullable: true
    AppendixDomainAnalyticsLimitsRatesDataInfo:
      type: object
      properties:
        tasks_ready:
          type: number
          format: double
          nullable: true
        errors:
          type: number
          format: double
          nullable: true
        whois:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixWhoisDomainAnalyticsLimitsRatesDataInfo'
          nullable: true
        technologies:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixTechnologiesDomainAnalyticsLimitsRatesDataInfo'
          nullable: true
        available_filters:
          type: number
          format: double
          nullable: true
    AppendixSellersGoogleMerchantLimitsRatesDataInfo:
      type: object
      properties:
        task_post:
          type: number
          format: double
          nullable: true
        tasks_ready:
          type: number
          format: double
          nullable: true
        task_get:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixFunctionTypeInfo'
          nullable: true
        ad_url:
          type: number
          format: double
          nullable: true
    AppendixMerchantGoogleInfo:
      type: object
      properties:
        products:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixSerpDaysRatesDataInfo'
          nullable: true
        sellers:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixSellersGoogleMerchantLimitsRatesDataInfo'
          nullable: true
        product_spec:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixSerpDaysRatesDataInfo'
          nullable: true
        product_info:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixSerpDaysRatesDataInfo'
          nullable: true
    AppendixMerchantAmazonInfo:
      type: object
      properties:
        asin:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixSerpDaysRatesDataInfo'
          nullable: true
        products:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixSerpDaysRatesDataInfo'
          nullable: true
        sellers:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixSerpDaysRatesDataInfo'
          nullable: true
    AppendixMerchantLimitsRatesDataInfo:
      type: object
      properties:
        google:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixMerchantGoogleInfo'
          nullable: true
        amazon:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixMerchantAmazonInfo'
          nullable: true
        locations:
          type: number
          format: double
          nullable: true
        languages:
          type: number
          format: double
          nullable: true
        errors:
          type: number
          format: double
          nullable: true
        reviews:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixSerpDaysRatesDataInfo'
          nullable: true
        id_list:
          type: number
          format: double
          nullable: true
        tasks_ready:
          type: number
          format: double
          nullable: true
    AppendixOnPageLimitsRatesDataInfo:
      type: object
      properties:
        task_post:
          type: number
          format: double
          nullable: true
        tasks_ready:
          type: number
          format: double
          nullable: true
        summary:
          type: number
          format: double
          nullable: true
        resources:
          type: number
          format: double
          nullable: true
        pages:
          type: number
          format: double
          nullable: true
        non_indexable:
          type: number
          format: double
          nullable: true
        duplicate_tags:
          type: number
          format: double
          nullable: true
        links:
          type: number
          format: double
          nullable: true
        waterfall:
          type: number
          format: double
          nullable: true
        errors:
          type: number
          format: double
          nullable: true
        pages_by_resource:
          type: number
          format: double
          nullable: true
        duplicate_content:
          type: number
          format: double
          nullable: true
        raw_html:
          type: number
          format: double
          nullable: true
        instant_pages:
          type: number
          format: double
          nullable: true
        redirect_chains:
          type: number
          format: double
          nullable: true
        lighthouse:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixInfo'
          nullable: true
        available_filters:
          type: number
          format: double
          nullable: true
        keyword_density:
          type: number
          format: double
          nullable: true
        page_screenshot:
          type: number
          format: double
          nullable: true
        content_parsing:
          type: number
          format: double
          nullable: true
        content_parsing_live:
          type: number
          format: double
          nullable: true
        id_list:
          type: number
          format: double
          nullable: true
        uncrawlable_resources:
          type: number
          format: double
          nullable: true
    AppendixBusinessDataGoogleInfo:
      type: object
      properties:
        my_business_info:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixInfo'
          nullable: true
        my_business_updates:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixInfo'
          nullable: true
        hotel_info:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixSerpDaysRatesDataInfo'
          nullable: true
        hotel_searches:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixInfo'
          nullable: true
        reviews:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixInfo'
          nullable: true
        questions_and_answers:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixInfo'
          nullable: true
        extended_reviews:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixInfo'
          nullable: true
    AppendixTrBusinessDataDayLimitsRatesDataInfo:
      type: object
      properties:
        reviews:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixInfo'
          nullable: true
        search:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixInfo'
          nullable: true
    AppendixBusinessListingsBusinessDataLimitsRatesDataInfo:
      type: object
      properties:
        search:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixInfo'
          nullable: true
        categories_aggregation:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixInfo'
          nullable: true
        categories:
          type: number
          format: double
          nullable: true
        locations:
          type: number
          format: double
          nullable: true
    AppendixBusinessDataLimitsRatesDataInfo:
      type: object
      properties:
        google:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixBusinessDataGoogleInfo'
          nullable: true
        locations:
          type: number
          format: double
          nullable: true
        languages:
          type: number
          format: double
          nullable: true
        errors:
          type: number
          format: double
          nullable: true
        tripadvisor:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixTrBusinessDataDayLimitsRatesDataInfo'
          nullable: true
        trustpilot:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixTrBusinessDataDayLimitsRatesDataInfo'
          nullable: true
        id_list:
          type: number
          format: double
          nullable: true
        business_listings:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixBusinessListingsBusinessDataLimitsRatesDataInfo'
          nullable: true
        available_filters:
          type: number
          format: double
          nullable: true
        tasks_ready:
          type: number
          format: double
          nullable: true
    AppendixBacklinksLimitsRatesDataInfo:
      type: object
      properties:
        summary:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixInfo'
          nullable: true
        history:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixInfo'
          nullable: true
        content_duplicates:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixInfo'
          nullable: true
        domain_intersection:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixInfo'
          nullable: true
        backlinks:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixInfo'
          nullable: true
        domain_pages:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixInfo'
          nullable: true
        domain_backlinks:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixInfo'
          nullable: true
        anchors:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixInfo'
          nullable: true
        referring_domains:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixInfo'
          nullable: true
        links_intersection:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixInfo'
          nullable: true
        page_intersection:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixInfo'
          nullable: true
        available_filters:
          type: number
          format: double
          nullable: true
        referring_networks:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixInfo'
          nullable: true
        bulk_ranks:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixInfo'
          nullable: true
        bulk_backlinks:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixInfo'
          nullable: true
        bulk_new_lost_backlinks:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixInfo'
          nullable: true
        bulk_new_lost_referring_domains:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixInfo'
          nullable: true
        bulk_referring_domains:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixInfo'
          nullable: true
        errors:
          type: number
          format: double
          nullable: true
        domain_pages_summary:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixInfo'
          nullable: true
        timeseries_summary:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixInfo'
          nullable: true
        timeseries_new_lost_summary:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixInfo'
          nullable: true
        competitors:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixInfo'
          nullable: true
        bulk_spam_score:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixInfo'
          nullable: true
        id_list:
          type: number
          format: double
          nullable: true
        bulk_pages_summary:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixInfo'
          nullable: true
    AppendixAppDataLimitsRatesDataInfo:
      type: object
      properties:
        app_info:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixSerpDaysRatesDataInfo'
          nullable: true
        app_list:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixSerpDaysRatesDataInfo'
          nullable: true
        app_reviews:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixSerpDaysRatesDataInfo'
          nullable: true
        app_searches:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixSerpDaysRatesDataInfo'
          nullable: true
        errors:
          type: number
          format: double
          nullable: true
        languages:
          type: number
          format: double
          nullable: true
        locations:
          type: number
          format: double
          nullable: true
        categories:
          type: number
          format: double
          nullable: true
        id_list:
          type: number
          format: double
          nullable: true
        app_listings:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixTrBusinessDataDayLimitsRatesDataInfo'
          nullable: true
        pp_listings:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixDataforseoLabsLimitsRatesDataInfo'
          nullable: true
        tasks_ready:
          type: number
          format: double
          nullable: true
    AppendixContentAnalysisLimitsRatesDataInfo:
      type: object
      properties:
        search:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixInfo'
          nullable: true
        summary:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixInfo'
          nullable: true
        sentiment_analysis:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixInfo'
          nullable: true
        rating_distribution:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixInfo'
          nullable: true
        phrase_trends:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixInfo'
          nullable: true
        category_trends:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixInfo'
          nullable: true
        locations:
          type: number
          format: double
          nullable: true
        languages:
          type: number
          format: double
          nullable: true
        categories:
          type: number
          format: double
          nullable: true
        errors:
          type: number
          format: double
          nullable: true
        available_filters:
          type: number
          format: double
          nullable: true
        id_list:
          type: number
          format: double
          nullable: true
    AppendixLlmResponsesAiOptimizationLimitsRatesDataInfo:
      type: object
      properties:
        live:
          type: number
          format: double
          nullable: true
        task_post:
          type: number
          format: double
          nullable: true
        tasks_ready:
          type: number
          format: double
          nullable: true
        task_get:
          type: number
          format: double
          nullable: true
        models:
          type: number
          format: double
          nullable: true
    AppendixAiKeywordDataAiOptimizationLimitsRatesDataInfo:
      type: object
      properties:
        locations_and_languages:
          type: number
          format: double
          nullable: true
        keywords_search_volume:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixInfo'
          nullable: true
        available_filters:
          type: number
          format: double
          nullable: true
    AppendixLlmMentionsAiOptimizationLimitsRatesDataInfo:
      type: object
      properties:
        search:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixInfo'
          nullable: true
        aggregated_metrics:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixInfo'
          nullable: true
        cross_aggregated_metrics:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixInfo'
          nullable: true
        top_domains:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixInfo'
          nullable: true
        top_pages:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixInfo'
          nullable: true
        locations_and_languages:
          type: number
          format: double
          nullable: true
        available_filters:
          type: number
          format: double
          nullable: true
        search_mentions:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixInfo'
          nullable: true
        target_metrics:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixInfo'
          nullable: true
        multi_target_metrics:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixInfo'
          nullable: true
        top_mentioned_domains:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixInfo'
          nullable: true
        top_mentioned_pages:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixInfo'
          nullable: true
        top_mentioned_brands:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixInfo'
          nullable: true
        top_mentioned_brand_categories:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixInfo'
          nullable: true
        target_metrics_lite:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixInfo'
          nullable: true
        top_mentioned_domains_lite:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixInfo'
          nullable: true
        top_mentioned_pages_lite:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixInfo'
          nullable: true
        top_mentioned_brands_lite:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixInfo'
          nullable: true
        top_mentioned_brand_categories_lite:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixInfo'
          nullable: true
        historical:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixInfo'
          nullable: true
        timeseries_delta:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixInfo'
          nullable: true
        timeseries_new_lost:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixInfo'
          nullable: true
    AppendixAiOptimizationLimitsRatesDataInfo:
      type: object
      properties:
        llm_responses:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixLlmResponsesAiOptimizationLimitsRatesDataInfo'
          nullable: true
        ai_keyword_data:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixAiKeywordDataAiOptimizationLimitsRatesDataInfo'
          nullable: true
        errors:
          type: number
          format: double
          nullable: true
        llm_scraper:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixSerpDaysRatesDataInfo'
          nullable: true
        llm_mentions:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixLlmMentionsAiOptimizationLimitsRatesDataInfo'
          nullable: true
        id_list:
          type: number
          format: double
          nullable: true
    AppendixDayLimitsRatesData:
      type: object
      properties:
        serp:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixSerpDaysRatesDataInfo'
          nullable: true
        total:
          type: number
          description: <em>total amount of money deposited to your account</em>
          format: double
          nullable: true
        total_serp:
          type: number
          format: double
          nullable: true
        keywords_data:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixKeywordsDataDaysRatesDataInfo'
          nullable: true
        total_keywords_data:
          type: number
          format: double
          nullable: true
        appendix:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixAppendixDaysRatesDataInfo'
          nullable: true
        total_appendix:
          type: number
          format: double
          nullable: true
        dataforseo_labs:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixDataforseoLabsLimitsRatesDataInfo'
          nullable: true
        total_dataforseo_labs:
          type: number
          format: double
          nullable: true
        domain_analytics:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixDomainAnalyticsLimitsRatesDataInfo'
          nullable: true
        total_domain_analytics:
          type: number
          format: double
          nullable: true
        merchant:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixMerchantLimitsRatesDataInfo'
          nullable: true
        total_merchant:
          type: number
          format: double
          nullable: true
        on_page:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixOnPageLimitsRatesDataInfo'
          nullable: true
        total_on_page:
          type: number
          format: double
          nullable: true
        business_data:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixBusinessDataLimitsRatesDataInfo'
          nullable: true
        total_business_data:
          type: number
          format: double
          nullable: true
        backlinks:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixBacklinksLimitsRatesDataInfo'
          nullable: true
        total_backlinks:
          type: number
          format: double
          nullable: true
        app_data:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixAppDataLimitsRatesDataInfo'
          nullable: true
        total_app_data:
          type: number
          format: double
          nullable: true
        content_analysis:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixContentAnalysisLimitsRatesDataInfo'
          nullable: true
        total_content_analysis:
          type: number
          format: double
          nullable: true
        ai_optimization:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixAiOptimizationLimitsRatesDataInfo'
          nullable: true
        total_ai_optimization:
          type: number
          format: double
          nullable: true
        total_reviews:
          type: number
          format: double
          nullable: true
        total_social:
          type: number
          format: double
          nullable: true
    AppendixSerpDataInfo:
      type: object
      properties:
        task_post:
          type: number
          format: double
          nullable: true
        task_get:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixFunctionTypeInfo'
          nullable: true
        tasks_ready:
          type: number
          format: double
          nullable: true
        locations:
          type: number
          format: double
          nullable: true
        languages:
          type: number
          format: double
          nullable: true
        live:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixFunctionTypeInfo'
          nullable: true
        errors:
          type: number
          format: double
          nullable: true
        tasks_fixed:
          type: number
          format: double
          nullable: true
        jobs:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixJobsSerpLimitsRatesDataInfo'
          nullable: true
        screenshot:
          type: number
          format: double
          nullable: true
        id_list:
          type: number
          format: double
          nullable: true
        ai_summary:
          type: number
          format: double
          nullable: true
        tasks_ready_queue:
          type: number
          format: double
          nullable: true
    AppendixNaverKeywordsDataDataInfo:
      type: object
      properties:
        keywords_for_category:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixInfo'
          nullable: true
        search_volume:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixInfo'
          nullable: true
    AppendixKeywordsDataDataInfo:
      type: object
      properties:
        keywords_for_keywords:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixInfo'
          nullable: true
        keywords_for_site:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixInfo'
          nullable: true
        search_volume:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixInfo'
          nullable: true
        ad_traffic_by_keywords:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixInfo'
          nullable: true
        languages:
          type: number
          format: double
          nullable: true
        locations:
          type: number
          format: double
          nullable: true
        tasks_ready:
          type: number
          format: double
          nullable: true
        explore:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixInfo'
          nullable: true
        categories:
          type: number
          format: double
          nullable: true
        errors:
          type: number
          format: double
          nullable: true
        bing:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixBingKeywordsDataLimitsRatesDataInfo'
          nullable: true
        keyword_performance:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixInfo'
          nullable: true
        locations_and_languages:
          type: number
          format: double
          nullable: true
        google_ads:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixGoogleAdsKeywordsDataLimitsRatesDataInfo'
          nullable: true
        id_list:
          type: number
          format: double
          nullable: true
        dataforseo_trends:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixDataforseoTrendsKeywordsDataLimitsRatesDataInfo'
          nullable: true
        clickstream_data:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixClickstreamDataKeywordsDataLimitsRatesDataInfo'
          nullable: true
        audience_estimation:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixInfo'
          nullable: true
        keyword_suggestions_for_url:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixInfo'
          nullable: true
        naver:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixNaverKeywordsDataDataInfo'
          nullable: true
        google:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixBingKeywordsDataLimitsRatesDataInfo'
          nullable: true
        keyword_ideas_ads_api:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixSerpDaysRatesDataInfo'
          nullable: true
    AppendixAppendixDataInfo:
      type: object
      properties:
        user_data:
          type: number
          format: double
          nullable: true
        errors:
          type: number
          format: double
          nullable: true
        status:
          type: number
          format: double
          nullable: true
        test:
          type: number
          format: double
          nullable: true
    AppendixDataInfo:
      type: object
      properties:
        serp:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixSerpDataInfo'
          nullable: true
        total:
          type: number
          description: <em>total amount of money deposited to your account</em>
          format: double
          nullable: true
        total_serp:
          type: number
          format: double
          nullable: true
        keywords_data:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixKeywordsDataDataInfo'
          nullable: true
        total_keywords_data:
          type: number
          format: double
          nullable: true
        appendix:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixAppendixDataInfo'
          nullable: true
        total_appendix:
          type: number
          format: double
          nullable: true
        dataforseo_labs:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixDataforseoLabsLimitsRatesDataInfo'
          nullable: true
        total_dataforseo_labs:
          type: number
          format: double
          nullable: true
        domain_analytics:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixDomainAnalyticsLimitsRatesDataInfo'
          nullable: true
        total_domain_analytics:
          type: number
          format: double
          nullable: true
        merchant:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixMerchantLimitsRatesDataInfo'
          nullable: true
        total_merchant:
          type: number
          format: double
          nullable: true
        on_page:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixOnPageLimitsRatesDataInfo'
          nullable: true
        total_on_page:
          type: number
          format: double
          nullable: true
        business_data:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixBusinessDataLimitsRatesDataInfo'
          nullable: true
        total_business_data:
          type: number
          format: double
          nullable: true
        backlinks:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixBacklinksLimitsRatesDataInfo'
          nullable: true
        total_backlinks:
          type: number
          format: double
          nullable: true
        app_data:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixAppDataLimitsRatesDataInfo'
          nullable: true
        total_app_data:
          type: number
          format: double
          nullable: true
        content_analysis:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixContentAnalysisLimitsRatesDataInfo'
          nullable: true
        total_content_analysis:
          type: number
          format: double
          nullable: true
        ai_optimization:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixAiOptimizationLimitsRatesDataInfo'
          nullable: true
        total_ai_optimization:
          type: number
          format: double
          nullable: true
        total_reviews:
          type: number
          format: double
          nullable: true
        reviews:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixSerpDaysRatesDataInfo'
          nullable: true
        total_social:
          type: number
          format: double
          nullable: true
        social:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixSerpDaysRatesDataInfo'
          nullable: true
    AppendixLimitsRatesData:
      type: object
      properties:
        day:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixDayLimitsRatesData'
          nullable: true
        minute:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixDataInfo'
          nullable: true
    AppendixStatisticsRatesDataInfo:
      type: object
      properties:
        serp:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixSerpDaysRatesDataInfo'
          nullable: true
        total:
          type: number
          description: <em>total amount of money deposited to your account</em>
          format: double
          nullable: true
        total_serp:
          type: number
          format: double
          nullable: true
        keywords_data:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixKeywordsDataDaysRatesDataInfo'
          nullable: true
        total_keywords_data:
          type: number
          format: double
          nullable: true
        appendix:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixAppendixDaysRatesDataInfo'
          nullable: true
        total_appendix:
          type: number
          format: double
          nullable: true
        dataforseo_labs:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixDataforseoLabsLimitsRatesDataInfo'
          nullable: true
        total_dataforseo_labs:
          type: number
          format: double
          nullable: true
        domain_analytics:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixDomainAnalyticsLimitsRatesDataInfo'
          nullable: true
        total_domain_analytics:
          type: number
          format: double
          nullable: true
        merchant:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixMerchantLimitsRatesDataInfo'
          nullable: true
        total_merchant:
          type: number
          format: double
          nullable: true
        on_page:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixOnPageLimitsRatesDataInfo'
          nullable: true
        total_on_page:
          type: number
          format: double
          nullable: true
        business_data:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixBusinessDataLimitsRatesDataInfo'
          nullable: true
        total_business_data:
          type: number
          format: double
          nullable: true
        backlinks:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixBacklinksLimitsRatesDataInfo'
          nullable: true
        total_backlinks:
          type: number
          format: double
          nullable: true
        app_data:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixAppDataLimitsRatesDataInfo'
          nullable: true
        total_app_data:
          type: number
          format: double
          nullable: true
        content_analysis:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixContentAnalysisLimitsRatesDataInfo'
          nullable: true
        total_content_analysis:
          type: number
          format: double
          nullable: true
        ai_optimization:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixAiOptimizationLimitsRatesDataInfo'
          nullable: true
        total_ai_optimization:
          type: number
          format: double
          nullable: true
        value:
          type: string
          description: <em>time period for grouping</em><br><code>day</code>_in the yyyy-MM-dd format<br><code>minute</code>_in the yyyy-MM-dd HH:mm formatn
          nullable: true
    AppendixStatisticsDataInfo:
      type: object
      properties:
        day:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixStatisticsRatesDataInfo'
          nullable: true
        minute:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixStatisticsRatesDataInfo'
          nullable: true
    AppendixRatesData:
      type: object
      properties:
        limits:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixLimitsRatesData'
          description: <em>rate limits for API calls per a certain period of time</em>
          nullable: true
        statistics:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixStatisticsDataInfo'
          description: <em>statisctics for API calls</em>
          nullable: true
    AppendixLimitsMoneyData:
      type: object
      properties:
        day:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixDataInfo'
          nullable: true
        minute:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixDataInfo'
          nullable: true
    AppendixMoneyData:
      type: object
      properties:
        total:
          type: number
          description: <em>total amount of money deposited to your account</em>
          format: double
          nullable: true
        balance:
          type: number
          description: <em>amount of money left in your account</em>
          format: double
          nullable: true
        limits:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixLimitsMoneyData'
          description: <em>cost limits</em>
          nullable: true
        statistics:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixStatisticsDataInfo'
          description: <em>statistics of your spending</em>
          nullable: true
    AppendixPriorityTasksReadyKeywordsDataPriceDataInfo:
      type: object
      properties:
        cost_type:
          type: string
          description: <em>charge type</em><br>can take the following values:<br><code>per_result</code>_- charge for every row in the <code>result</code> array<br><code>per_request</code>_- charge for a GET or POST requestn
          nullable: true
        cost:
          type: number
          description: '<em>cost, USD</em>'
          format: double
          nullable: true
    AppendixTaskKeywordsDataPriceDataInfo:
      type: object
      properties:
        priority_low:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/AppendixPriorityTasksReadyKeywordsDataPriceDataInfo'
            nullable: true
          nullable: true
        priority_normal:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/AppendixPriorityTasksReadyKeywordsDataPriceDataInfo'
            nullable: true
          nullable: true
        priority_high:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/AppendixPriorityTasksReadyKeywordsDataPriceDataInfo'
            nullable: true
          nullable: true
    AppendixAKeywordsDataPriceDataInfo:
      type: object
      properties:
        task_get:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixTaskKeywordsDataPriceDataInfo'
          nullable: true
        task_post:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixTaskKeywordsDataPriceDataInfo'
          nullable: true
    AppendixBingKeywordsDataPriceDataInfo:
      type: object
      properties:
        live:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixTaskKeywordsDataPriceDataInfo'
          nullable: true
    AppendixBingKeywordsDataPriceData:
      type: object
      properties:
        audience_estimation:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixBingKeywordsDataPriceDataInfo'
          nullable: true
        keyword_performance:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixBingKeywordsDataPriceDataInfo'
          nullable: true
        keywords_for_keywords:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixBingKeywordsDataPriceDataInfo'
          nullable: true
        keywords_for_site:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixBingKeywordsDataPriceDataInfo'
          nullable: true
        keyword_suggestions_for_url:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixBingKeywordsDataPriceDataInfo'
          nullable: true
        search_volume:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixBingKeywordsDataPriceDataInfo'
          nullable: true
    AppendixClickstreamDataKeywordsDataPriceData:
      type: object
      properties:
        bulk_search_volume:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixBingKeywordsDataPriceDataInfo'
          nullable: true
        dataforseo_search_volume:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixBingKeywordsDataPriceDataInfo'
          nullable: true
        global_search_volume:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixBingKeywordsDataPriceDataInfo'
          nullable: true
        locations_and_languages:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixTaskKeywordsDataPriceDataInfo'
          nullable: true
    AppendixGoogleAdsKeywordsDataPriceData:
      type: object
      properties:
        ad_traffic_by_keywords:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixBingKeywordsDataPriceDataInfo'
          nullable: true
        keywords_for_keywords:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixBingKeywordsDataPriceDataInfo'
          nullable: true
        keywords_for_site:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixBingKeywordsDataPriceDataInfo'
          nullable: true
        search_volume:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixBingKeywordsDataPriceDataInfo'
          nullable: true
        status:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixTaskKeywordsDataPriceDataInfo'
          nullable: true
    AppendixDataforseoTrendsKeywordsDataPriceData:
      type: object
      properties:
        demography:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixBingKeywordsDataPriceDataInfo'
          nullable: true
        explore:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixBingKeywordsDataPriceDataInfo'
          nullable: true
        merged_data:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixBingKeywordsDataPriceDataInfo'
          nullable: true
        subregion_interests:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixBingKeywordsDataPriceDataInfo'
          nullable: true
    AppendixExploreKeywordsDataPriceData:
      type: object
      properties:
        live:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixTaskKeywordsDataPriceDataInfo'
          nullable: true
        task_get:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixTaskKeywordsDataPriceDataInfo'
          nullable: true
        task_post:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixTaskKeywordsDataPriceDataInfo'
          nullable: true
    AppendixKeywordsDataPriceData:
      type: object
      properties:
        tasks_ready:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixTaskKeywordsDataPriceDataInfo'
          nullable: true
        ad_traffic_by_keywords:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixAKeywordsDataPriceDataInfo'
          nullable: true
        audience_estimation:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixAKeywordsDataPriceDataInfo'
          nullable: true
        bing:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixBingKeywordsDataPriceData'
          nullable: true
        categories:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixTaskKeywordsDataPriceDataInfo'
          nullable: true
        clickstream_data:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixClickstreamDataKeywordsDataPriceData'
          nullable: true
        errors:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixTaskKeywordsDataPriceDataInfo'
          nullable: true
        google_ads:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixGoogleAdsKeywordsDataPriceData'
          nullable: true
        id_list:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixTaskKeywordsDataPriceDataInfo'
          nullable: true
        keyword_performance:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixAKeywordsDataPriceDataInfo'
          nullable: true
        keywords_for_keywords:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixAKeywordsDataPriceDataInfo'
          nullable: true
        keywords_for_site:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixAKeywordsDataPriceDataInfo'
          nullable: true
        keyword_suggestions_for_url:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixAKeywordsDataPriceDataInfo'
          nullable: true
        languages:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixTaskKeywordsDataPriceDataInfo'
          nullable: true
        locations:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixTaskKeywordsDataPriceDataInfo'
          nullable: true
        locations_and_languages:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixTaskKeywordsDataPriceDataInfo'
          nullable: true
        search_volume:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixAKeywordsDataPriceDataInfo'
          nullable: true
        dataforseo_trends:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixDataforseoTrendsKeywordsDataPriceData'
          nullable: true
        explore:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixExploreKeywordsDataPriceData'
          nullable: true
    AppendixTaskGetPriceDataInfo:
      type: object
      properties:
        advanced:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixTaskKeywordsDataPriceDataInfo'
          nullable: true
    AppendixPriceDataInfo:
      type: object
      properties:
        task_get:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixTaskGetPriceDataInfo'
          nullable: true
        tasks_ready:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixTaskKeywordsDataPriceDataInfo'
          nullable: true
        task_post:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixTaskKeywordsDataPriceDataInfo'
          nullable: true
    AppendixTaskGetProductGoogleMerchantPriceDataInfo:
      type: object
      properties:
        advanced:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixTaskKeywordsDataPriceDataInfo'
          nullable: true
        html:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixTaskKeywordsDataPriceDataInfo'
          nullable: true
    AppendixProductGoogleMerchantPriceDataInfo:
      type: object
      properties:
        task_get:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixTaskGetProductGoogleMerchantPriceDataInfo'
          nullable: true
        task_post:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixTaskKeywordsDataPriceDataInfo'
          nullable: true
        tasks_ready:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixTaskKeywordsDataPriceDataInfo'
          nullable: true
    AppendixSellersGoogleMerchantPriceData:
      type: object
      properties:
        ad_url:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixTaskKeywordsDataPriceDataInfo'
          nullable: true
        task_get:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixTaskGetProductGoogleMerchantPriceDataInfo'
          nullable: true
        task_post:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixTaskKeywordsDataPriceDataInfo'
          nullable: true
        tasks_ready:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixTaskKeywordsDataPriceDataInfo'
          nullable: true
    AppendixGoogleMerchantPriceData:
      type: object
      properties:
        product_info:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixPriceDataInfo'
          nullable: true
        product_spec:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixProductGoogleMerchantPriceDataInfo'
          nullable: true
        products:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixProductGoogleMerchantPriceDataInfo'
          nullable: true
        sellers:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixSellersGoogleMerchantPriceData'
          nullable: true
    AppendixAmazonMerchantPriceDataInfo:
      type: object
      properties:
        live:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixTaskGetProductGoogleMerchantPriceDataInfo'
          nullable: true
        task_get:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixTaskGetProductGoogleMerchantPriceDataInfo'
          nullable: true
        task_post:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixTaskKeywordsDataPriceDataInfo'
          nullable: true
        tasks_ready:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixTaskKeywordsDataPriceDataInfo'
          nullable: true
    AppendixAmazonMerchantPriceData:
      type: object
      properties:
        asin:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixAmazonMerchantPriceDataInfo'
          nullable: true
        products:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixAmazonMerchantPriceDataInfo'
          nullable: true
        sellers:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixAmazonMerchantPriceDataInfo'
          nullable: true
    AppendixMerchantPriceData:
      type: object
      properties:
        google:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixGoogleMerchantPriceData'
          nullable: true
        amazon:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixAmazonMerchantPriceData'
          nullable: true
        errors:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixTaskKeywordsDataPriceDataInfo'
          nullable: true
        id_list:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixTaskKeywordsDataPriceDataInfo'
          nullable: true
        languages:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixTaskKeywordsDataPriceDataInfo'
          nullable: true
        locations:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixTaskKeywordsDataPriceDataInfo'
          nullable: true
        reviews:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixProductGoogleMerchantPriceDataInfo'
          nullable: true
        tasks_ready:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixTaskKeywordsDataPriceDataInfo'
          nullable: true
    AppendixLlmScraperAiOptimizationPriceData:
      type: object
      properties:
        locations:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixTaskKeywordsDataPriceDataInfo'
          nullable: true
        languages:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixTaskKeywordsDataPriceDataInfo'
          nullable: true
        live:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixTaskGetProductGoogleMerchantPriceDataInfo'
          nullable: true
        task_post:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixTaskKeywordsDataPriceDataInfo'
          nullable: true
        task_get:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixTaskGetProductGoogleMerchantPriceDataInfo'
          nullable: true
        tasks_ready:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixTaskKeywordsDataPriceDataInfo'
          nullable: true
    AppendixLlmMentionsAiOptimizationPriceData:
      type: object
      properties:
        aggregated_metrics:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixBingKeywordsDataPriceDataInfo'
          nullable: true
        available_filters:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixTaskKeywordsDataPriceDataInfo'
          nullable: true
        cross_aggregated_metrics:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixBingKeywordsDataPriceDataInfo'
          nullable: true
        historical:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixBingKeywordsDataPriceDataInfo'
          nullable: true
        locations_and_languages:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixTaskKeywordsDataPriceDataInfo'
          nullable: true
        multi_target_metrics:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixBingKeywordsDataPriceDataInfo'
          nullable: true
        search:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixBingKeywordsDataPriceDataInfo'
          nullable: true
        search_mentions:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixBingKeywordsDataPriceDataInfo'
          nullable: true
        target_metrics:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixBingKeywordsDataPriceDataInfo'
          nullable: true
        target_metrics_lite:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixBingKeywordsDataPriceDataInfo'
          nullable: true
        timeseries_delta:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixBingKeywordsDataPriceDataInfo'
          nullable: true
        timeseries_new_lost:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixBingKeywordsDataPriceDataInfo'
          nullable: true
        top_domains:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixBingKeywordsDataPriceDataInfo'
          nullable: true
        top_mentioned_brand_categories:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixBingKeywordsDataPriceDataInfo'
          nullable: true
        top_mentioned_brand_categories_lite:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixBingKeywordsDataPriceDataInfo'
          nullable: true
        top_mentioned_brands:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixBingKeywordsDataPriceDataInfo'
          nullable: true
        top_mentioned_brands_lite:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixBingKeywordsDataPriceDataInfo'
          nullable: true
        top_mentioned_domains:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixBingKeywordsDataPriceDataInfo'
          nullable: true
        top_mentioned_domains_lite:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixBingKeywordsDataPriceDataInfo'
          nullable: true
        top_mentioned_pages:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixBingKeywordsDataPriceDataInfo'
          nullable: true
        top_mentioned_pages_lite:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixBingKeywordsDataPriceDataInfo'
          nullable: true
        top_pages:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixBingKeywordsDataPriceDataInfo'
          nullable: true
    AppendixAiKeywordDataAiOptimizationPriceData:
      type: object
      properties:
        available_filters:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixTaskKeywordsDataPriceDataInfo'
          nullable: true
        keywords_search_volume:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixBingKeywordsDataPriceDataInfo'
          nullable: true
        locations_and_languages:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixTaskKeywordsDataPriceDataInfo'
          nullable: true
    AppendixLlmResponsesAiOptimizationPriceData:
      type: object
      properties:
        live:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixTaskKeywordsDataPriceDataInfo'
          nullable: true
        models:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixTaskKeywordsDataPriceDataInfo'
          nullable: true
        task_get:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixTaskKeywordsDataPriceDataInfo'
          nullable: true
        task_post:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixTaskKeywordsDataPriceDataInfo'
          nullable: true
        tasks_ready:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixTaskKeywordsDataPriceDataInfo'
          nullable: true
    AppendixAiOptimizationPriceData:
      type: object
      properties:
        llm_scraper:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixLlmScraperAiOptimizationPriceData'
          nullable: true
        llm_mentions:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixLlmMentionsAiOptimizationPriceData'
          nullable: true
        ai_keyword_data:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixAiKeywordDataAiOptimizationPriceData'
          nullable: true
        errors:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixTaskKeywordsDataPriceDataInfo'
          nullable: true
        id_list:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixTaskKeywordsDataPriceDataInfo'
          nullable: true
        llm_responses:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixLlmResponsesAiOptimizationPriceData'
          nullable: true
    AppendixSerpPriceDataInfo:
      type: object
      properties:
        html:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixTaskKeywordsDataPriceDataInfo'
          nullable: true
        regular:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixTaskKeywordsDataPriceDataInfo'
          nullable: true
        advanced:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixTaskKeywordsDataPriceDataInfo'
          nullable: true
    AppendixSerpPriceData:
      type: object
      properties:
        tasks_fixed:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixTaskKeywordsDataPriceDataInfo'
          nullable: true
        ai_summary:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixTaskKeywordsDataPriceDataInfo'
          nullable: true
        errors:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixTaskKeywordsDataPriceDataInfo'
          nullable: true
        id_list:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixTaskKeywordsDataPriceDataInfo'
          nullable: true
        jobs:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixAKeywordsDataPriceDataInfo'
          nullable: true
        languages:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixTaskKeywordsDataPriceDataInfo'
          nullable: true
        live:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixSerpPriceDataInfo'
          nullable: true
        locations:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixTaskKeywordsDataPriceDataInfo'
          nullable: true
        screenshot:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixTaskKeywordsDataPriceDataInfo'
          nullable: true
        task_get:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixSerpPriceDataInfo'
          nullable: true
        task_post:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixTaskKeywordsDataPriceDataInfo'
          nullable: true
        tasks_ready:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixTaskKeywordsDataPriceDataInfo'
          nullable: true
    AppendixAppendixPriceData:
      type: object
      properties:
        errors:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixTaskKeywordsDataPriceDataInfo'
          nullable: true
        user_data:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixTaskKeywordsDataPriceDataInfo'
          nullable: true
    AppendixAppDataPriceData:
      type: object
      properties:
        app_info:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixProductGoogleMerchantPriceDataInfo'
          nullable: true
        app_listings:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixLlmMentionsAiOptimizationPriceData'
          nullable: true
        app_list:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixProductGoogleMerchantPriceDataInfo'
          nullable: true
        app_reviews:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixPriceDataInfo'
          nullable: true
        app_searches:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixProductGoogleMerchantPriceDataInfo'
          nullable: true
        pp_listings:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixLlmMentionsAiOptimizationPriceData'
          nullable: true
        categories:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixTaskKeywordsDataPriceDataInfo'
          nullable: true
        errors:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixTaskKeywordsDataPriceDataInfo'
          nullable: true
        id_list:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixTaskKeywordsDataPriceDataInfo'
          nullable: true
        languages:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixTaskKeywordsDataPriceDataInfo'
          nullable: true
        locations:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixTaskKeywordsDataPriceDataInfo'
          nullable: true
        tasks_ready:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixTaskKeywordsDataPriceDataInfo'
          nullable: true
    AppendixBacklinksPriceData:
      type: object
      properties:
        anchors:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixBingKeywordsDataPriceDataInfo'
          nullable: true
        available_filters:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixTaskKeywordsDataPriceDataInfo'
          nullable: true
        backlinks:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixBingKeywordsDataPriceDataInfo'
          nullable: true
        bulk_backlinks:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixBingKeywordsDataPriceDataInfo'
          nullable: true
        bulk_new_lost_backlinks:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixBingKeywordsDataPriceDataInfo'
          nullable: true
        bulk_new_lost_referring_domains:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixBingKeywordsDataPriceDataInfo'
          nullable: true
        bulk_pages_summary:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixBingKeywordsDataPriceDataInfo'
          nullable: true
        bulk_ranks:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixBingKeywordsDataPriceDataInfo'
          nullable: true
        bulk_referring_domains:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixBingKeywordsDataPriceDataInfo'
          nullable: true
        bulk_spam_score:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixBingKeywordsDataPriceDataInfo'
          nullable: true
        competitors:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixBingKeywordsDataPriceDataInfo'
          nullable: true
        content_duplicates:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixBingKeywordsDataPriceDataInfo'
          nullable: true
        domain_backlinks:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixBingKeywordsDataPriceDataInfo'
          nullable: true
        domain_intersection:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixBingKeywordsDataPriceDataInfo'
          nullable: true
        domain_pages:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixBingKeywordsDataPriceDataInfo'
          nullable: true
        domain_pages_summary:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixBingKeywordsDataPriceDataInfo'
          nullable: true
        errors:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixTaskKeywordsDataPriceDataInfo'
          nullable: true
        history:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixBingKeywordsDataPriceDataInfo'
          nullable: true
        id_list:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixTaskKeywordsDataPriceDataInfo'
          nullable: true
        links_intersection:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixBingKeywordsDataPriceDataInfo'
          nullable: true
        page_intersection:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixBingKeywordsDataPriceDataInfo'
          nullable: true
        referring_domains:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixBingKeywordsDataPriceDataInfo'
          nullable: true
        referring_networks:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixBingKeywordsDataPriceDataInfo'
          nullable: true
        summary:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixBingKeywordsDataPriceDataInfo'
          nullable: true
        timeseries_new_lost_summary:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixBingKeywordsDataPriceDataInfo'
          nullable: true
        timeseries_summary:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixBingKeywordsDataPriceDataInfo'
          nullable: true
    AppendixBusinessListingsBusinessDataPriceData:
      type: object
      properties:
        categories:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixTaskKeywordsDataPriceDataInfo'
          nullable: true
        categories_aggregation:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixBingKeywordsDataPriceDataInfo'
          nullable: true
        locations:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixTaskKeywordsDataPriceDataInfo'
          nullable: true
        search:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixBingKeywordsDataPriceDataInfo'
          nullable: true
    AppendixGoogleBusinessDataPriceData:
      type: object
      properties:
        extended_reviews:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixAKeywordsDataPriceDataInfo'
          nullable: true
        hotel_info:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixAmazonMerchantPriceDataInfo'
          nullable: true
        hotel_searches:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixLlmResponsesAiOptimizationPriceData'
          nullable: true
        my_business_info:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixLlmResponsesAiOptimizationPriceData'
          nullable: true
        my_business_updates:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixLlmResponsesAiOptimizationPriceData'
          nullable: true
        questions_and_answers:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixLlmResponsesAiOptimizationPriceData'
          nullable: true
        reviews:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixLlmResponsesAiOptimizationPriceData'
          nullable: true
    AppendixTrBusinessDataPriceDataInfo:
      type: object
      properties:
        reviews:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixLlmResponsesAiOptimizationPriceData'
          nullable: true
        search:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixLlmResponsesAiOptimizationPriceData'
          nullable: true
    AppendixBusinessDataPriceData:
      type: object
      properties:
        available_filters:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixTaskKeywordsDataPriceDataInfo'
          nullable: true
        business_listings:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixBusinessListingsBusinessDataPriceData'
          nullable: true
        errors:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixTaskKeywordsDataPriceDataInfo'
          nullable: true
        google:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixGoogleBusinessDataPriceData'
          nullable: true
        id_list:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixTaskKeywordsDataPriceDataInfo'
          nullable: true
        languages:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixTaskKeywordsDataPriceDataInfo'
          nullable: true
        locations:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixTaskKeywordsDataPriceDataInfo'
          nullable: true
        tripadvisor:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixTrBusinessDataPriceDataInfo'
          nullable: true
        trustpilot:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixTrBusinessDataPriceDataInfo'
          nullable: true
        tasks_ready:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixTaskKeywordsDataPriceDataInfo'
          nullable: true
    AppendixContentAnalysisPriceData:
      type: object
      properties:
        categories:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixTaskKeywordsDataPriceDataInfo'
          nullable: true
        category_trends:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixBingKeywordsDataPriceDataInfo'
          nullable: true
        available_filters:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixTaskKeywordsDataPriceDataInfo'
          nullable: true
        errors:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixTaskKeywordsDataPriceDataInfo'
          nullable: true
        id_list:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixTaskKeywordsDataPriceDataInfo'
          nullable: true
        languages:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixTaskKeywordsDataPriceDataInfo'
          nullable: true
        locations:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixTaskKeywordsDataPriceDataInfo'
          nullable: true
        phrase_trends:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixBingKeywordsDataPriceDataInfo'
          nullable: true
        rating_distribution:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixBingKeywordsDataPriceDataInfo'
          nullable: true
        search:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixBingKeywordsDataPriceDataInfo'
          nullable: true
        sentiment_analysis:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixBingKeywordsDataPriceDataInfo'
          nullable: true
        summary:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixBingKeywordsDataPriceDataInfo'
          nullable: true
    AppendixDataforseoLabsPriceData:
      type: object
      properties:
        app_competitors:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixBingKeywordsDataPriceDataInfo'
          nullable: true
        app_intersection:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixBingKeywordsDataPriceDataInfo'
          nullable: true
        bulk_app_metrics:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixBingKeywordsDataPriceDataInfo'
          nullable: true
        bulk_keyword_difficulty:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixBingKeywordsDataPriceDataInfo'
          nullable: true
        bulk_search_volume:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixBingKeywordsDataPriceDataInfo'
          nullable: true
        bulk_traffic_estimation:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixBingKeywordsDataPriceDataInfo'
          nullable: true
        categories:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixTaskKeywordsDataPriceDataInfo'
          nullable: true
        categories_for_domain:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixBingKeywordsDataPriceDataInfo'
          nullable: true
        categories_for_keywords:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixBingKeywordsDataPriceDataInfo'
          nullable: true
        competitors_domain:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixBingKeywordsDataPriceDataInfo'
          nullable: true
        available_filters:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixTaskKeywordsDataPriceDataInfo'
          nullable: true
        domain_intersection:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixBingKeywordsDataPriceDataInfo'
          nullable: true
        domain_metrics_by_categories:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixBingKeywordsDataPriceDataInfo'
          nullable: true
        domain_rank_overview:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixBingKeywordsDataPriceDataInfo'
          nullable: true
        domain_whois_overview:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixBingKeywordsDataPriceDataInfo'
          nullable: true
        errors:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixTaskKeywordsDataPriceDataInfo'
          nullable: true
        historical_bulk_traffic_estimation:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixBingKeywordsDataPriceDataInfo'
          nullable: true
        historical_keyword_data:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixBingKeywordsDataPriceDataInfo'
          nullable: true
        historical_rank_overview:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixBingKeywordsDataPriceDataInfo'
          nullable: true
        historical_serps:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixBingKeywordsDataPriceDataInfo'
          nullable: true
        id_list:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixTaskKeywordsDataPriceDataInfo'
          nullable: true
        keyword_ideas:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixBingKeywordsDataPriceDataInfo'
          nullable: true
        keyword_overview:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixBingKeywordsDataPriceDataInfo'
          nullable: true
        keywords_for_app:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixBingKeywordsDataPriceDataInfo'
          nullable: true
        keywords_for_categories:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixBingKeywordsDataPriceDataInfo'
          nullable: true
        keywords_for_site:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixBingKeywordsDataPriceDataInfo'
          nullable: true
        keyword_suggestions:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixBingKeywordsDataPriceDataInfo'
          nullable: true
        locations_and_languages:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixTaskKeywordsDataPriceDataInfo'
          nullable: true
        page_intersection:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixBingKeywordsDataPriceDataInfo'
          nullable: true
        product_competitors:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixBingKeywordsDataPriceDataInfo'
          nullable: true
        product_keyword_intersections:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixBingKeywordsDataPriceDataInfo'
          nullable: true
        product_rank_overview:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixBingKeywordsDataPriceDataInfo'
          nullable: true
        ranked_keywords:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixBingKeywordsDataPriceDataInfo'
          nullable: true
        related_keywords:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixBingKeywordsDataPriceDataInfo'
          nullable: true
        relevant_pages:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixBingKeywordsDataPriceDataInfo'
          nullable: true
        search_intent:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixBingKeywordsDataPriceDataInfo'
          nullable: true
        serp_competitors:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixBingKeywordsDataPriceDataInfo'
          nullable: true
        subdomains:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixBingKeywordsDataPriceDataInfo'
          nullable: true
        top_searches:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixBingKeywordsDataPriceDataInfo'
          nullable: true
    AppendixWhoisDomainAnalyticsPriceData:
      type: object
      properties:
        overview:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixBingKeywordsDataPriceDataInfo'
          nullable: true
    AppendixTechnologiesDomainAnalyticsPriceData:
      type: object
      properties:
        languages:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixTaskKeywordsDataPriceDataInfo'
          nullable: true
        locations:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixTaskKeywordsDataPriceDataInfo'
          nullable: true
        technologies:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixTaskKeywordsDataPriceDataInfo'
          nullable: true
        aggregation_technologies:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixBingKeywordsDataPriceDataInfo'
          nullable: true
        domains_by_html_terms:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixBingKeywordsDataPriceDataInfo'
          nullable: true
        domains_by_technology:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixBingKeywordsDataPriceDataInfo'
          nullable: true
        domain_technologies:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixBingKeywordsDataPriceDataInfo'
          nullable: true
        technologies_summary:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixBingKeywordsDataPriceDataInfo'
          nullable: true
        technology_stats:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixBingKeywordsDataPriceDataInfo'
          nullable: true
    AppendixDomainAnalyticsPriceData:
      type: object
      properties:
        whois:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixWhoisDomainAnalyticsPriceData'
          nullable: true
        available_filters:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixTaskKeywordsDataPriceDataInfo'
          nullable: true
        technologies:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixTechnologiesDomainAnalyticsPriceData'
          nullable: true
        errors:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixTaskKeywordsDataPriceDataInfo'
          nullable: true
        tasks_ready:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixTaskKeywordsDataPriceDataInfo'
          nullable: true
    AppendixOnPagePriceData:
      type: object
      properties:
        errors:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixTaskKeywordsDataPriceDataInfo'
          nullable: true
        id_list:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixTaskKeywordsDataPriceDataInfo'
          nullable: true
        lighthouse:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixLlmResponsesAiOptimizationPriceData'
          nullable: true
        available_filters:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixTaskKeywordsDataPriceDataInfo'
          nullable: true
        content_parsing:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixTaskKeywordsDataPriceDataInfo'
          nullable: true
        content_parsing_live:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixTaskKeywordsDataPriceDataInfo'
          nullable: true
        duplicate_content:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixTaskKeywordsDataPriceDataInfo'
          nullable: true
        duplicate_tags:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixTaskKeywordsDataPriceDataInfo'
          nullable: true
        instant_pages:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixTaskKeywordsDataPriceDataInfo'
          nullable: true
        keyword_density:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixTaskKeywordsDataPriceDataInfo'
          nullable: true
        links:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixTaskKeywordsDataPriceDataInfo'
          nullable: true
        non_indexable:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixTaskKeywordsDataPriceDataInfo'
          nullable: true
        pages:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixTaskKeywordsDataPriceDataInfo'
          nullable: true
        pages_by_resource:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixTaskKeywordsDataPriceDataInfo'
          nullable: true
        page_screenshot:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixTaskKeywordsDataPriceDataInfo'
          nullable: true
        raw_html:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixTaskKeywordsDataPriceDataInfo'
          nullable: true
        redirect_chains:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixTaskKeywordsDataPriceDataInfo'
          nullable: true
        resources:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixTaskKeywordsDataPriceDataInfo'
          nullable: true
        summary:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixTaskKeywordsDataPriceDataInfo'
          nullable: true
        task_post:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixTaskKeywordsDataPriceDataInfo'
          nullable: true
        tasks_ready:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixTaskKeywordsDataPriceDataInfo'
          nullable: true
        uncrawlable_resources:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixTaskKeywordsDataPriceDataInfo'
          nullable: true
        waterfall:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixTaskKeywordsDataPriceDataInfo'
          nullable: true
    AppendixPriceData:
      type: object
      properties:
        keywords_data:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixKeywordsDataPriceData'
          nullable: true
        merchant:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixMerchantPriceData'
          nullable: true
        ai_optimization:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixAiOptimizationPriceData'
          nullable: true
        serp:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixSerpPriceData'
          nullable: true
        appendix:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixAppendixPriceData'
          nullable: true
        app_data:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixAppDataPriceData'
          nullable: true
        backlinks:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixBacklinksPriceData'
          nullable: true
        business_data:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixBusinessDataPriceData'
          nullable: true
        content_analysis:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixContentAnalysisPriceData'
          nullable: true
        dataforseo_labs:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixDataforseoLabsPriceData'
          nullable: true
        domain_analytics:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixDomainAnalyticsPriceData'
          nullable: true
        on_page:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixOnPagePriceData'
          nullable: true
    AppendixUserDataResultInfo:
      type: object
      properties:
        login:
          type: string
          description: <em>your login</em>
          nullable: true
        timezone:
          type: string
          description: <em>your time zone</em><br><strong>can be set in your profile settings</strong>
          nullable: true
        rates:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixRatesData'
          description: <em>your API rates</em>
          nullable: true
        money:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixMoneyData'
          description: '<em>section of your spending, USD</em>'
          nullable: true
        price:
          type: object
          oneOf:
            - $ref: '#/components/schemas/AppendixPriceData'
          description: <em>pricing</em>
          nullable: true
        backlinks_subscription_expiry_date:
          type: string
          description: '<em>expiry date of the backlinks api subscription</em><br>date and time when the current subscription to Backlinks API expires;<br>in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”<br>example:<br><code class="long-string">2025-06-15 12:57:46 +00:00</code><br><strong>Note:</strong> if there is no active subscription to Backlinks API, the value equals <code>null</code><br><strong>Note #2:</strong> the Backlinks API subscription format was removed, and this field is deprecated'
          nullable: true
        llm_mentions_subscription_expiry_date:
          type: string
          description: '<em>expiry date of the llm mentions api subscription</em><br>date and time when the current subscription to LLM Mentions API expires;<br>in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”<br>example:<br><code class="long-string">2026-02-28 14:01:38 +00:00</code><br><strong>Note:</strong> if there is no active subscription to LLM Mentions API, the value equals <code>null</code><br><strong>Note #2:</strong> the LLM Mentions API subscription format was removed, and this field is deprecated'
          nullable: true
    AppendixUserDataTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AppendixUserDataResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    AppendixUserDataResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AppendixUserDataTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    AppendixErrorsResultInfo:
      type: object
      properties:
        code:
          type: integer
          description: <em>code</em>
          nullable: true
        message:
          type: string
          description: <em>message</em>
          nullable: true
    AppendixErrorsTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AppendixErrorsResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    AppendixErrorsResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AppendixErrorsTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    AppendixWebhookResendRequestInfo:
      type: object
      properties:
        id:
          type: string
          description: <em>task identifier</em><br><strong>unique task identifier in our system in the <a href="https://en.wikipedia.org/wiki/Universally_unique_identifier">UUID</a> format</strong><br>you can specify up to 100 identifiers;<br>each identifier in the task array must be specified as a separate object
          nullable: true
      example:
        - id: 08161139-0001-0066-1000-06491d097ed5
    AppendixWebhookResendTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: object
              description: <em>array of results</em><br>the value of this array is always <code>null</code>;<br>you can get the results by the preferred method of results delivery (pingback or postback) you specified when setting a task
              nullable: true
    AppendixWebhookResendResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AppendixWebhookResendTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    AppendixStatusEndpointsInfo:
      type: object
      properties:
        endpoint:
          type: string
          description: <em>name of the endpoint</em><br>the list of possible endpoints:<br>`task_get`<br>`task_post`<br>`live`<br>`postback/pingback`
          nullable: true
        status:
          type: string
          description: <em>current status</em><br>you can find all information about your API statuses for the last 60 days <a href="https://status.dataforseo.com/" rel="noopener noreferrer" target="_blank">here</a><br>the list of possible current statuses:<br>`major_outage`<br>`partial_outage`<br>`long_response_time`<br>`long_execution_time`<br>`webhook_delay`<br>`send_delay`
          nullable: true
    AppendixStatusResultInfo:
      type: object
      properties:
        api:
          type: string
          description: <em>name of the API</em><br>the list of APIs:<br>`serp`<br>`keywords_data`<br>`appendix`<br>`dataforseo_labs`<br>`domain_analytics`<br>`merchant`<br>`on_page`<br>`business_data`<br>`backlinks`<br>`app_data`<br>`content_analysis`<br>`content_generation`
          nullable: true
        status:
          type: string
          description: <em>current status</em><br>you can find all information about the statuses of our endpoints for the last 60 days <a href="https://status.dataforseo.com/" rel="noopener noreferrer" target="_blank">here</a><br>the list of possible current statuses:<br>`major_outage`<br>`partial_outage`<br>`long_response_time`<br>`long_execution_time`<br>`webhook_delay`<br>`send_delay`
          nullable: true
        endpoints:
          type: array
          items:
            type: object
            oneOf:
              - $ref: '#/components/schemas/AppendixStatusEndpointsInfo'
            nullable: true
          description: <em>array of objects that contain status information for API endpoints</em>
          nullable: true
    AppendixStatusTaskInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseTaskInfo'
        - type: object
          properties:
            result:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AppendixStatusResultInfo'
                nullable: true
              description: <em>array of results</em>
              nullable: true
    AppendixStatusResponseInfo:
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseResponseInfo'
        - type: object
          properties:
            tasks:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/AppendixStatusTaskInfo'
                nullable: true
              description: <em>array of tasks</em>
              nullable: true
    DataLabsFoundOnWebSerpElementItem:
      type: object
      allOf:
        - type: object
          oneOf:
            - $ref: '#/components/schemas/BaseDataforseoLabsApiElementItem'
          nullable: true
        - type: object
          properties:
            title:
              type: string
              description: title of the result in SERP
              nullable: true
            related_searches:
              type: array
              items:
                type: string
                nullable: true
              description: search queries related to the elment
              nullable: true
            items:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/FoundOnWebElement'
                nullable: true
              description: historical SERPs and related data found in the database
              nullable: true
      deprecated: true
    DataLabsExploreBrandsSerpElementItem:
      type: object
      allOf:
        - type: object
          oneOf:
            - $ref: '#/components/schemas/BaseDataforseoLabsApiElementItem'
          nullable: true
        - type: object
          properties:
            title:
              type: string
              description: title of the result in SERP
              nullable: true
            items:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/ExploreBrandsElement'
                nullable: true
              description: historical SERPs and related data found in the database
              nullable: true
      deprecated: true
    DataLabsCoursesSerpElementItem:
      type: object
      allOf:
        - type: object
          oneOf:
            - $ref: '#/components/schemas/BaseDataforseoLabsApiElementItem'
          nullable: true
        - type: object
          properties:
            title:
              type: string
              description: title of the result in SERP
              nullable: true
            categories:
              type: array
              items:
                type: string
                nullable: true
              description: "array of course categories\ncontains a list of categories relevant to courses"
              nullable: true
            items:
              type: array
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/CoursesElement'
                nullable: true
              description: historical SERPs and related data found in the database
              nullable: true
      deprecated: true
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
security:
  - basicAuth: [ ]
tags:
  - name: Serp
  - name: DataforseoLabs
  - name: DomainAnalytics
  - name: KeywordsData
  - name: Backlinks
  - name: AiOptimization
  - name: OnPage
  - name: ContentAnalysis
  - name: Merchant
  - name: AppData
  - name: BusinessData
  - name: Appendix