openapi: 3.0.1
info:
  title: DataForSEO AiOptimization KeywordsData API
  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
tags:
- name: KeywordsData
paths:
  /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.

        for more info please visit ''https://docs.dataforseo.com/v3/keywords_data/id_list/?bash'''
      operationId: KeywordsDataIdList
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                oneOf:
                - $ref: '#/components/schemas/KeywordsDataIdListRequestInfo'
                nullable: true
              example:
              - datetime_from: '2026-04-12 04:39:39 +00:00'
                datetime_to: '2026-04-14 04:39:39 +00:00'
                limit: 100
                offset: 0
                sort: desc
                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.

        for more info please visit ''https://docs.dataforseo.com/v3/keywords_data/errors/?bash'''
      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: 'By 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.

        for more info please visit ''https://docs.dataforseo.com/v3/keywords_data/google_ads/status/?bash'''
      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: 'We 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”.

        Postal Codes can be used to set a task, albeit API response will not return data for such tasks.

        for more info please visit ''https://docs.dataforseo.com/v3/keywords_data/google_ads/locations/?bash'''
      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: 'We 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”.

        Postal Codes can be used to set a task, albeit API response will not return data for such tasks.

        for more info please visit ''https://docs.dataforseo.com/v3/keywords_data/google_ads/locations/?bash'''
      operationId: GoogleAdsLocationsCountry
      parameters:
      - name: country
        in: path
        description: 'country ISO code

          optional field

          specify the ISO code if you want to filter the list of locations by country

          example:

          us'
        required: true
        schema:
          type: string
          nullable: true
        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.

        ‌

        ‌‌As a response of the API server, you will receive JSON-encoded data containing a tasks array with the information about available languages.

        for more info please visit ''https://docs.dataforseo.com/v3/keywords_data/google_ads/languages/?bash'''
      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: '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.

        for more info please visit ''https://docs.dataforseo.com/v3/keywords_data/google_ads/search_volume/task_post/?bash'''
      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: 'This 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.

        for more info please visit ''https://docs.dataforseo.com/v3/keywords_data/google_ads/search_volume/tasks_ready/?bash'''
      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: '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.

        for more info please visit ''https://docs.dataforseo.com/v3/keywords_data/google_ads/search_volume/task_get/?bash'''
      operationId: GoogleAdsSearchVolumeTaskGet
      parameters:
      - name: id
        in: path
        description: 'task identifier

          unique task identifier in our system in the UUID format

          you will be able to use it within 30 days 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: '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.

        for more info please visit ''https://docs.dataforseo.com/v3/keywords_data/google_ads/search_volume/live/?bash'''
      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: '2026-01-15'
                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: for more info please visit 'https://docs.dataforseo.com/v3/keywords_data/google_ads/keywords_for_site/task_post/?bash'
      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: 'This 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.

        for more info please visit ''https://docs.dataforseo.com/v3/keywords_data/google_ads/keywords_for_site/tasks_ready/?bash'''
      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: '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.

        ‌‌

        This 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.

        for more info please visit ''https://docs.dataforseo.com/v3/keywords_data/google_ads/keywords_for_site/task_get/?bash'''
      operationId: GoogleAdsKeywordsForSiteTaskGet
      parameters:
      - name: id
        in: path
        description: 'task identifier

          unique task identifier in our system in the UUID format

          you will be able to use it within 30 days 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.

        ‌‌

        This 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.

        for more info please visit ''https://docs.dataforseo.com/v3/keywords_data/google_ads/keywords_for_site/live/?bash'''
      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.

        ‌‌

        This 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.

        for more info please visit ''https://docs.dataforseo.com/v3/keywords_data/google_ads/keywords_for_keywords/task_post/?bash'''
      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: 'This 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.

        for more info please visit ''https://docs.dataforseo.com/v3/keywords_data/google_ads/keywords_for_keywords/tasks_ready/?bash'''
      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.

        ‌

        This 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.

        for more info please visit ''https://docs.dataforseo.com/v3/keywords_data/google_ads/keywords_for_keywords/task_get/?bash'''
      operationId: GoogleAdsKeywordsForKeywordsTaskGet
      parameters:
      - name: id
        in: path
        description: 'task identifier

          unique task identifier in our system in the UUID format

          you will be able to use it within 30 days 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.

        ‌‌

        This 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.

        for more info please visit ''https://docs.dataforseo.com/v3/keywords_data/google_ads/keywords_for_keywords/live/?bash'''
      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: for more info please visit 'https://docs.dataforseo.com/v3/keywords_data/google_ads/ad_traffic_by_keywords/task_post/?bash'
      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: 'This 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.

        for more info please visit ''https://docs.dataforseo.com/v3/keywords_data/google_ads/ad_traffic_by_keywords/tasks_ready/?bash'''
      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: for more info please visit 'https://docs.dataforseo.com/v3/keywords_data/google_ads/ad_traffic_by_keywords/task_get/?bash'
      operationId: GoogleAdsAdTrafficByKeywordsTaskGet
      parameters:
      - name: id
        in: path
        description: 'task identifier

          unique task identifier in our system in the UUID format

          you will be able to use it within 30 days 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: for more info please visit 'https://docs.dataforseo.com/v3/keywords_data/google_ads/ad_traffic_by_keywords/live/?bash'
      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: for more info please visit 'https://docs.dataforseo.com/v3/keywords_data/google_trends/locations/?bash'
      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: for more info please visit 'https://docs.dataforseo.com/v3/keywords_data/google_trends/locations/?bash'
      operationId: GoogleTrendsLocationsCountry
      parameters:
      - name: country
        in: path
        description: 'country ISO code

          optional field

          specify the ISO code if you want to filter the list of locations by country

          example:

          us'
        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.

        ‌

        ‌‌As a response of the API server, you will receive JSON-encoded data containing a tasks array with the information about available languages.

        for more info please visit ''https://docs.dataforseo.com/v3/keywords_data/google_trends/languages/?bash'''
      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.

        ‌

        ‌‌As a response of the API server, you will receive JSON-encoded data containing a tasks array with the information about available categories.

        for more info please visit ''https://docs.dataforseo.com/v3/keywords_data/google_trends/categories/?bash'''
      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: '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.

        for more info please visit ''https://docs.dataforseo.com/v3/keywords_data/google_trends/explore/task_post/?bash'''
      operationId: GoogleTrendsExploreTaskPost
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                oneOf:
                - $ref: '#/components/schemas/KeywordsDataGoogleTrendsExploreTaskPostRequestInfo'
                nullable: true
              example:
              - date_from: '2026-01-15'
                date_to: '2026-03-15'
                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: 'This 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.

        for more info please visit ''https://docs.dataforseo.com/v3/keywords_data/google_trends/explore/tasks_ready/?bash'''
      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: for more info please visit 'https://docs.dataforseo.com/v3/keywords_data/google_trends/explore/task_get/?bash'
      operationId: GoogleTrendsExploreTaskGet
      parameters:
      - name: id
        in: path
        description: 'task identifier

          unique task identifier in our system in the UUID format

          you will be able to use it within 30 days 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.

        for more info please visit ''https://docs.dataforseo.com/v3/keywords_data/google_trends/explore/live/?bash'''
      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: '2026-01-15'
                date_to: '2026-03-15'
                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.

        for more info please visit ''https://docs.dataforseo.com/v3/keywords_data/dataforseo_trends/locations/?bash'''
      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.

        for more info please visit ''https://docs.dataforseo.com/v3/keywords_data/dataforseo_trends/locations/?bash'''
      operationId: DataforseoTrendsLocationsCountry
      parameters:
      - name: country
        in: path
        description: 'country ISO code

          optional field

          specify the ISO code if you want to filter the list of locations by country

          example:

          us'
        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.

        for more info please visit ''https://docs.dataforseo.com/v3/keywords_data/dataforseo_trends/explore/live/?bash'''
      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.

        for more info please visit ''https://docs.dataforseo.com/v3/keywords_data/dataforseo_trends/subregion_interests/live/?bash'''
      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: '2026-01-15'
                date_to: '2026-03-15'
                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.

        for more info please visit ''https://docs.dataforseo.com/v3/keywords_data/dataforseo_trends/demography/live/?bash'''
      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: '2026-01-15'
                date_to: '2026-03-15'
                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.

        for more info please visit ''https://docs.dataforseo.com/v3/keywords_data/dataforseo_trends/merged_data/live/?bash'''
      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: '2026-01-15'
                date_to: '2026-03-15'
                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.

        for more info please visit ''https://docs.dataforseo.com/v3/keywords_data/bing/locations/?bash'''
      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.

        for more info please visit ''https://docs.dataforseo.com/v3/keywords_data/bing/languages/?bash'''
      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: '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.

        for more info please visit ''https://docs.dataforseo.com/v3/keywords_data/bing/search_volume/task_post/?bash'''
      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: 'This 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.

        for more info please visit ''https://docs.dataforseo.com/v3/keywords_data/bing/search_volume/tasks_ready/?bash'''
      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: for more info please visit 'https://docs.dataforseo.com/v3/keywords_data/bing/search_volume/task_get/?bash'
      operationId: BingSearchVolumeTaskGet
      parameters:
      - name: id
        in: path
        description: 'task identifier

          unique task identifier in our system in the UUID format

          you will be able to use it within 30 days 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.

        for more info please visit ''https://docs.dataforseo.com/v3/keywords_data/bing/search_volume/live/?bash'''
      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.

        for more info please visit ''https://docs.dataforseo.com/v3/keywords_data/bing/audience_estimation/job_functions/?bash'''
      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.

        for more info please visit ''https://docs.dataforseo.com/v3/keywords_data/bing/audience_estimation/industries/?bash'''
      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: '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.

        for more info please visit ''https://docs.dataforseo.com/v3/keywords_data/bing/audience_estimation/task_post/?bash'''
      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: 'This 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.

        for more info please visit ''https://docs.dataforseo.com/v3/keywords_data/bing/audience_estimation/tasks_ready/?bash'''
      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: for more info please visit 'https://docs.dataforseo.com/v3/keywords_data/bing/audience_estimation/task_get/?bash'
      operationId: BingAudienceEstimationTaskGet
      parameters:
      - name: id
        in: path
        description: 'task identifier

          unique task identifier in our system in the UUID format

          you will be able to use it within 30 days 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.

        for more info please visit ''https://docs.dataforseo.com/v3/keywords_data/bing/audience_estimation/live/?bash'''
      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.

        for more info please visit ''https://docs.dataforseo.com/v3/keywords_data/bing/keywords_for_site/task_post/?bash'''
      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: 'This 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.

        for more info please visit ''https://docs.dataforseo.com/v3/keywords_data/bing/keywords_for_site/tasks_ready/?bash'''
      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: '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 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.

        for more info please visit ''https://docs.dataforseo.com/v3/keywords_data/bing/keywords_for_site/task_get/?bash'''
      operationId: BingKeywordsForSiteTaskGet
      parameters:
      - name: id
        in: path
        description: 'task identifier

          unique task identifier in our system in the UUID format

          you will be able to use it within 30 days 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.

        for more info please visit ''https://docs.dataforseo.com/v3/keywords_data/bing/keywords_for_site/live/?bash'''
      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: 'This 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.

        for more info please visit ''https://docs.dataforseo.com/v3/keywords_data/bing/keywords_for_keywords/task_post/?bash'''
      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: 'This 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.

        for more info please visit ''https://docs.dataforseo.com/v3/keywords_data/bing/keywords_for_keywords/tasks_ready/?bash'''
      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: 'This 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.

        for more info please visit ''https://docs.dataforseo.com/v3/keywords_data/bing/keywords_for_keywords/task_get/?bash'''
      operationId: BingKeywordsForKeywordsTaskGet
      parameters:
      - name: id
        in: path
        description: 'task identifier

          unique task identifier in our system in the UUID format

          you will be able to use it within 30 days 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: 'This 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.

        for more info please visit ''https://docs.dataforseo.com/v3/keywords_data/bing/keywords_for_keywords/live/?bash'''
      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: 'Using this endpoint you can get the full list of locations and languages supported in Keyword Performance endpoints of Bing Keywords Data API.

        for more info please visit ''https://docs.dataforseo.com/v3/keywords_data/bing/keyword_performance/locations_and_languages/?bash'''
      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: 'You 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.

        for more info please visit ''https://docs.dataforseo.com/v3/keywords_data/bing/keyword_performance/task_post/?bash'''
      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: 'This 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.

        for more info please visit ''https://docs.dataforseo.com/v3/keywords_data/bing/keyword_performance/tasks_ready/?bash'''
      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: 'You 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.

        for more info please visit ''https://docs.dataforseo.com/v3/keywords_data/bing/keyword_performance/task_get/?bash'''
      operationId: BingKeywordPerformanceTaskGet
      parameters:
      - name: id
        in: path
        description: 'task identifier

          unique task identifier in our system in the UUID format

          you will be able to use it within 30 days 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: 'You 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.

        for more info please visit ''https://docs.dataforseo.com/v3/keywords_data/bing/keyword_performance/live/?bash'''
      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.

        for more info please visit ''https://docs.dataforseo.com/v3/keywords_data/bing/search_volume_history/locations_and_languages/?bash'''
      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: '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.

        for more info please visit ''https://docs.dataforseo.com/v3/keywords_data/bing/search_volume_history/task_post/?bash'''
      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: 'This 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.

        for more info please visit ''https://docs.dataforseo.com/v3/keywords_data/bing/search_volume_history/tasks_ready/?bash'''
      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: for more info please visit 'https://docs.dataforseo.com/v3/keywords_data/bing/search_volume_history/task_get/?bash'
      operationId: BingSearchVolumeHistoryTaskGet
      parameters:
      - name: id
        in: path
        description: 'task identifier

          unique task identifier in our system in the UUID format

          you will be able to use it within 30 days 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.

        for more info please visit ''https://docs.dataforseo.com/v3/keywords_data/bing/search_volume_history/live/?bash'''
      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: 'Using this endpoint you can get the full list of locations and languages supported in DataForSEO Clickstream Data API.

        for more info please visit ''https://docs.dataforseo.com/v3/keywords_data/clickstream_data/locations_and_languages/?bash'''
      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: for more info please visit 'https://docs.dataforseo.com/v3/keywords_data/clickstream_data/dataforseo_search_volume/live/?bash'
      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: ' 

        The 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.

        for more info please visit ''https://docs.dataforseo.com/v3/keywords_data/clickstream_data/global_search_volume/live/?bash'''
      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: ' 

        The 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).

        for more info please visit ''https://docs.dataforseo.com/v3/keywords_data/clickstream_data/bulk_search_volume/live/?bash'''
      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: []
components:
  schemas:
    KeywordsDataClickstreamDataGlobalSearchVolumeLiveResultInfo:
      type: object
      properties:
        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/KeywordsDataClickstreamDataGlobalSearchVolumeLiveItem'
            nullable: true
          description: contains keywords and related data
          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: array of results
            nullable: true
    BaseResponseTaskInfo:
      properties:
        id:
          type: string
          description: 'task identifier

            unique task identifier in our system in the UUID format'
          nullable: true
        status_code:
          type: integer
          description: 'status code of the task

            generated by DataForSEO, can be within the following range: 10000-60000

            you can find the full list of the response codes here'
          nullable: true
        status_message:
          type: string
          description: 'informational message of the task

            you 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
    KeywordsDataDataforseoTrendsLocationsCountryResultInfo:
      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_code_parent:
          type: integer
          description: 'the code of the superordinate location

            example:

            "location_code": 9041134,

            "location_name": "Vienna International Airport,Lower Austria,Austria",

            "location_code_parent": 20044

            where location_code_parent corresponds to:

            "location_code": 20044,

            "location_name": "Lower Austria,Austria"'
          nullable: true
        country_iso_code:
          type: string
          description: ISO country code of the location
          nullable: true
        location_type:
          type: string
          description: 'location type

            possible values according to Google’s target types'
          nullable: true
        geo_id:
          type: string
          description: 'DataForSEO trends location identifier

            you can use this field for matching obtained results with the location_code parameter specified in the request'
          nullable: true
    KeywordsDataGoogleAdsKeywordsForKeywordsTasksReadyResultInfo:
      type: object
      properties:
        id:
          type: string
          description: 'task identifier of the completed task

            unique task identifier in our system in the UUID format'
          nullable: true
        se:
          type: string
          description: search engine specified when setting the task
          nullable: true
        se_type:
          type: string
          nullable: true
        date_posted:
          type: string
          description: date when the task was posted (in the UTC format)
          nullable: true
        tag:
          type: string
          description: user-defined task identifier
          nullable: true
        endpoint:
          type: string
          description: URL for collecting the results of the task
          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: array of tasks
            nullable: true
    KeywordsDataBingKeywordPerformanceTaskPostTaskInfo:
      type: object
      allOf:
      - $ref: '#/components/schemas/BaseResponseTaskInfo'
      - type: object
        properties:
          result:
            type: object
            description: 'array of results

              in this case, the value will be null'
            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: array of results
            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: array of results
            nullable: true
    KeywordsDataGoogleAdsSearchVolumeTaskGetResultInfo:
      type: object
      properties:
        keyword:
          type: string
          description: 'keyword

            keyword is returned with decoded %## (plus character ‘+’ will be decoded to a space character)'
          nullable: true
        spell:
          type: string
          description: 'correct spelling of the keyword

            Note:if the keyword in the POST array appears to be misspelled, data will be returned for the correctly spelled keyword;

            we use the functionality of Google Ads API to check and validate the spelling of keywords, learn more by this link'
          nullable: true
        location_code:
          type: integer
          description: 'location code in a POST array

            if there is no data, then the value is null'
          nullable: true
        language_code:
          type: string
          description: 'language code in a POST array

            if there is no data, then the value is null'
          nullable: true
        search_partners:
          type: boolean
          description: indicates whether data from partner networks included in the response
          nullable: true
        competition:
          type: string
          description: 'competition

            represents the relative amount of competition associated with the given keyword in paid SERP only;

            this value is based on Google Ads data and can take the following values: HIGH, MEDIUM, LOW;

            if there is no data the value is null;

            learn more about the metric in this help center article'
          nullable: true
        competition_index:
          type: integer
          description: 'competition

            represents the relative amount of competition associated with the given keyword in paid SERP only;

            this value is based on Google Ads data and can be between 0 and 100 (inclusive);

            if there is no data the value is null;

            learn more about the metric in this help center article'
          nullable: true
        search_volume:
          type: integer
          description: monthly average search volume rate
          format: int64
          nullable: true
        low_top_of_page_bid:
          type: number
          description: 'minimum bid for the ad to be displayed at the top of the first page

            indicates the value greater than about 20% of the lowest bids for which ads were displayed (based on Google Ads statistics for advertisers);

            the value may differ depending on the location specified in a POST request'
          nullable: true
        high_top_of_page_bid:
          type: number
          description: 'maximum bid for the ad to be displayed at the top of the first page

            indicates the value greater than about 80% of the lowest bids for which ads were displayed (based on Google Ads statistics for advertisers);

            the value may differ depending on the location specified in a POST request'
          nullable: true
        cpc:
          type: number
          description: 'cost per click

            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: 'monthly searches

            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;

            if there is no data then the value is null'
          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: array of tasks
            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: array of tasks
            nullable: true
    KeywordKpi:
      type: object
      properties:
        desktop:
          type: array
          items:
            type: object
            oneOf:
            - $ref: '#/components/schemas/KeywordKpiItemInfo'
            nullable: true
          description: 'keyword data aggregated for desktop devices

            if there is no data, then the value is null'
          nullable: true
        mobile:
          type: array
          items:
            type: object
            oneOf:
            - $ref: '#/components/schemas/KeywordKpiItemInfo'
            nullable: true
          description: 'keyword data aggregated for mobile devices

            if there is no data, then the value is null'
          nullable: true
        tablet:
          type: array
          items:
            type: object
            oneOf:
            - $ref: '#/components/schemas/KeywordKpiItemInfo'
            nullable: true
          description: 'keyword data aggregated for tablet devices

            if there is no data, then the value is null'
          nullable: true
    DataforseoTrendsinterestsValuesInfo:
      type: object
      properties:
        geo_id:
          type: string
          description: 'location identifier

            you can use this field for matching obtained results with location parameters specified in the request

            see the full list of available locations with their geo_id here or by making a separate request to https://api.dataforseo.com/v3/keywords_data/dataforseo_trends/locations

            example:

            US-NY'
          nullable: true
        geo_name:
          type: string
          description: 'location name

            you can use this field for matching obtained results with location parameters specified in the request

            see the full list of available locations with their geo_name here or by making a separate request to https://api.dataforseo.com/v3/keywords_data/dataforseo_trends/locations

            example:

            Andorra'
          nullable: true
        value:
          type: integer
          description: 'relative keyword popularity rate in a given location

            represents location-specific keyword popularity rate over the specified time range;

            using this value you can understand how popular a keyword is in one location compared to another location;

            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);

            a value of 100 is the highest popularity for the term

            a value of 50 means that the term is half as popular

            a value of 0 means there was not enough data for this term'
          nullable: true
    KeywordsDataBingKeywordPerformanceLiveResultInfo:
      type: object
      properties:
        keyword:
          type: string
          description: keyword in a POST array
          nullable: true
        location_code:
          type: integer
          description: 'location code in a POST array

            if there is no data, then the value is null'
          nullable: true
        language_code:
          type: string
          description: 'language code in a POST array

            if there is no data, then the value is null'
          nullable: true
        year:
          type: integer
          description: 'indicates the year for which the data is provided for

            example:

            2020'
          nullable: true
        month:
          type: integer
          description: 'indicates the month for which the data is provided for

            example:

            10'
          nullable: true
        keyword_kpi:
          type: object
          oneOf:
          - $ref: '#/components/schemas/KeywordKpi'
          description: 'object containing keyword metrics

            if there is no data, then the value is null'
          nullable: true
    KeywordsDataGoogleAdsLocationsCountryResultInfo:
      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_code_parent:
          type: integer
          description: 'the code of the superordinate location

            example:

            "location_code": 9041134,

            "location_name": "Vienna International Airport,Lower Austria,Austria",

            "location_code_parent": 20044

            where location_code_parent corresponds to:

            "location_code": 20044,

            "location_name": "Lower Austria,Austria"'
          nullable: true
        country_iso_code:
          type: string
          description: ISO country code of the location
          nullable: true
        location_type:
          type: string
          description: 'location type

            possible values according to Google’s target types'
          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: array of results
            nullable: true
    KeywordsDataBingSearchVolumeLiveResultInfo:
      type: object
      properties:
        keyword:
          type: string
          description: keyword in a POST array
          nullable: true
        location_code:
          type: integer
          description: 'location code in a POST array

            if there is no data, then the value is null'
          nullable: true
        language_code:
          type: string
          description: 'language code in a POST array

            if there is no data, then the value is null'
          nullable: true
        search_partners:
          type: boolean
          description: indicates whether data from partner networks included in the response
          nullable: true
        device:
          type: string
          description: 'device type in a POST array

            if there is no data, then the value is null'
          nullable: true
        competition:
          type: number
          description: 'competition

            represents the relative amount of competition associated with the given keyword in paid SERP only. This value is based on Bing Ads data.

            Possible values: 0.1, 0.5,0.90.1 – low competition,

            0.5 – medium competition,

            0.9 – high competition;

            if there is no data the value is null'
          nullable: true
        cpc:
          type: number
          description: 'cost-per-click

            represents the average cost per click (USD) historically paid for the keyword.

            if there is no data then the value is null'
          nullable: true
        search_volume:
          type: integer
          description: 'monthly average search volume rate

            search volume is rounded to the nearest tens'
          format: int64
          nullable: true
        categories:
          type: array
          items:
            type: string
            nullable: true
          description: 'product and service categories

            our API doesn’t return categories for this endpoint: the parameter will always equal null'
          nullable: true
        monthly_searches:
          type: array
          items:
            type: object
            oneOf:
            - $ref: '#/components/schemas/MonthlySearchesInfo'
            nullable: true
          description: 'monthly searches

            represents the (approximate) number of searches on this keyword idea (as available for the past twelve months), targeted to the specified geographic locations

            if there is no data then the value is null'
          nullable: true
    KeywordsDataBingKeywordsForKeywordsTaskGetResultInfo:
      type: object
      properties:
        keyword:
          type: string
          description: keyword 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
        search_partners:
          type: boolean
          description: indicates whether data from partner networks included in the response
          nullable: true
        device:
          type: string
          description: 'device type

            indicates for what device type the data is provided;

            possible values: all, mobile, desktop, tablet'
          nullable: true
        competition:
          type: number
          description: "competition\nrepresents the relative amount of competition associated with the given keyword in paid SERP only. This value is based on Bing Ads data.\nPossible values: 0.1, 0.5,0.9 \n0.1 – low competition,\n0.5 – medium competition,\n0.9 – high competition;\nif there is no data the value is null"
          nullable: true
        cpc:
          type: number
          description: 'cost-per-click

            represents the average cost per click (USD) historically paid for the keyword.

            if there is no data, then the value is null'
          nullable: true
        search_volume:
          type: integer
          description: 'monthly average search volume rate

            represents the (approximate) number of searches for the keyword on the Bing search engine, depending on the user’s targeting

            search volume is rounded to the closest decimal values

            if there is no data, then the value is null'
          format: int64
          nullable: true
        categories:
          type: array
          items:
            type: string
            nullable: true
          description: 'product and service categories

            legacy field, the value will always be null'
          nullable: true
        monthly_searches:
          type: array
          items:
            type: object
            oneOf:
            - $ref: '#/components/schemas/MonthlySearchesInfo'
            nullable: true
          description: 'monthly searches

            represents the (approximate) number of searches on this keyword (as available for the past twelve months), targeted to the specified geographic locations.

            if there is no data, then the value is null'
          nullable: true
    KeywordsDataBingKeywordsForKeywordsTasksReadyResultInfo:
      type: object
      properties:
        id:
          type: string
          description: 'task identifier of the completed task

            unique task identifier in our system in the UUID format'
          nullable: true
        se:
          type: string
          description: search engine specified when setting the task
          nullable: true
        se_type:
          type: string
          nullable: true
        date_posted:
          type: string
          description: date when the task was posted (in the UTC format)
          nullable: true
        tag:
          type: string
          description: user-defined task identifier
          nullable: true
        endpoint:
          type: string
          description: URL for collecting the results of the task
          nullable: true
        function:
          type: string
          description: type of the task
          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: array of tasks
            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: array of results
            nullable: true
    KeywordsDataGoogleAdsLanguagesResultInfo:
      type: object
      properties:
        language_name:
          type: string
          description: language name
          nullable: true
        language_code:
          type: string
          description: language code according to ISO 639-1
          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: array of tasks
            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: array of tasks
            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: array of tasks
            nullable: true
    KeywordsDataBingKeywordPerformanceTaskPostRequestInfo:
      type: object
      properties:
        keywords:
          type: array
          items:
            type: string
          description: 'keywords

            required field

            The maximum number of keywords you can specify: 1000

            The maximum number of characters for each keyword: 80

            The maximum number of words for each keyword phrase: 10

            the specified keywords will be converted to lowercase, data will be provided in a separate array

            learn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article'
        device:
          type: string
          description: 'device type

            optional field

            specify this field if you want to get the data for a particular device typepossible values: desktop, mobile, tablet, all

            default value: all'
          nullable: true
        match:
          type: string
          description: 'keywords match type

            optional field

            can take the following values:

            aggregate returns data across all match types;

            broad returns data for all user queries containing the specified keyword with varying word order;

            phrase returns data for all user queries containing the specified keyword with identical word order;

            exact returns data for user query that matches the specified keyword;Note: the aggregate match type is applied by default'
          nullable: true
        location_name:
          type: string
          description: 'full name of search engine location

            required field if you don’t specify location_code or location_coordinate

            if you use this field, you don’t need to specify location_code or location_coordinate

            you can receive the list of available locations and languages by making a separate request to https://api.dataforseo.com/v3/keywords_data/bing/keyword_performance/locations_and_languages

            example:

            "United States"'
          nullable: true
        location_code:
          type: integer
          description: 'search engine location code

            required field if you don’t specify location_name or location_coordinate

            if you use this field, you don’t need to specify location_name or location_coordinate

            you can receive the list of available locations and languages by making a separate request to https://api.dataforseo.com/v3/keywords_data/bing/keyword_performance/locations_and_languages

            example:

            2840'
          nullable: true
        location_coordinate:
          type: string
          description: 'GPS coordinates of a location

            required field if you don’t specify location_name or location_code

            if you use this field, you don’t need to specify location_name or location_code

            location_coordinate parameter should be specified in the “latitude,longitude” format

            the data will be provided for the country the specified coordinates belong to

            example:

            52.6178549,-155.352142'
          nullable: true
        language_name:
          type: string
          description: 'full name of search engine language

            required field if you don’t specify language_code

            if you use this field, you don’t need to specify language_code

            you can receive the list of available locations and languages by making a separate request to https://api.dataforseo.com/v3/keywords_data/bing/keyword_performance/locations_and_languages

            example:

            English'
          nullable: true
        language_code:
          type: string
          description: 'search engine language code

            required field if you don’t specify language_name

            you can receive the list of available locations and languages by making a separate request to https://api.dataforseo.com/v3/keywords_data/bing/keyword_performance/locations_and_languages

            example:

            "en"'
          nullable: true
        postback_url:
          type: string
          description: 'URL for sending task results

            optional field

            once the task is completed, we will send a POST request with its results compressed in the gzip format to the postback_url you specified

            you 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=$id

            http://your-server.com/postbackscript?id=$id&tag=$tag

            Note: special characters in postback_url will be urlencoded;

            i.a., the # character will be encoded into %23

            learn more on our Help Center'
          nullable: true
        pingback_url:
          type: string
          description: 'notification URL of a completed task

            optional field

            when a task is completed we will notify you by GET request sent to the URL you have specified

            you 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=$id

            http://your-server.com/pingscript?id=$id&tag=$tag

            Note: special characters in pingback_url will be urlencoded;

            i.a., the # character will be encoded into %23

            learn more on our Help Center'
          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:
      - location_code: 2840
        language_code: en
        keywords:
        - dataforseo
        - seo
        - ranking
    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: array of tasks
            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: array of tasks
            nullable: true
    KeywordsDataGoogleAdsSearchVolumeTaskPostRequestInfo:
      type: object
      properties:
        keywords:
          type: array
          items:
            type: string
          description: 'keywords

            required field

            The maximum number of keywords you can specify: 1000

            The maximum number of characters for each keyword: 80

            The maximum number of words for each keyword phrase: 10

            the keywords you specify will be converted to a lowercase format

            Note #1: Google Ads may return no data for certain groups of keywords;

            Note #2: Google Ads provides combined search volume values for groups of similar keywords

            to obtain search volume for similar keywords, we recommend submitting such keywords in separate requests;

            Note #3: 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;

            to learn more about which symbols and characters can be used, please refer to this article

            learn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article'
        location_name:
          type: string
          description: 'full name of search engine location

            optional field

            if you do not indicate the location, you will receive worldwide results, i.e., for all available locations;

            if you use this field, you don’t need to specify location_code or location_coordinate

            you 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/keywords_data/google_ads/locations

            example:

            London,England,United Kingdom'
          nullable: true
        location_code:
          type: integer
          description: 'search engine location code

            optional field

            if you do not indicate the location, you will receive worldwide results, i.e., for all available locations;

            if you use this field, you don’t need to specify location_name or location_coordinate;

            you can receive the list of available locations of the search engines with their location_code by making a separate request to https://api.dataforseo.com/v3/keywords_data/google_ads/locations

            example:

            2840'
          nullable: true
        location_coordinate:
          type: string
          description: 'GPS coordinates of a location

            optional field

            if you do not indicate the location, you will receive worldwide results, i.e., for all available locations;

            if you use this field, you don’t need to specify location_name or location_code;

            location_coordinate parameter should be specified in the “latitude,longitude” format;

            the data will be provided for the country the specified coordinates belong to;

            example:

            52.6178549,-155.352142'
          nullable: true
        language_name:
          type: string
          description: 'full name of search engine language

            optional field

            you can receive the list of available languages of the search engine with their language_name by making a separate request to https://api.dataforseo.com/v3/keywords_data/google_ads/languages

            example:

            English'
          nullable: true
        language_code:
          type: string
          description: 'search engine language code

            optional field

            you can receive the list of available languages of the search engine with their language_code by making a separate request to https://api.dataforseo.com/v3/keywords_data/google_ads/languages

            example:

            en'
          nullable: true
        search_partners:
          type: boolean
          description: 'include Google search partners

            optional field

            if you specify true, the results will be delivered for owned, operated, and syndicated networks across Google and partner sites that host Google search;

            default value: false – results are returned for Google search sites'
          nullable: true
        date_from:
          type: string
          description: 'starting date of the time range

            optional field

            date format: "yyyy-mm-dd"

            minimal value: 4 years from the current date

            by default, data is returned for the past 12 months;

            Note: the indicated date cannot be greater than that specified in date_to and/or yesterday’s date;if Status endpoint returns false in the actual_data field, date_from can be set to the month before last and prior;

            if Status endpoint returns true in the actual_data field, date_from can be set to the last month and prior'
          nullable: true
        date_to:
          type: string
          description: 'ending date of the time range

            optional field

            Note: the indicated date cannot be greater than the past month, Google Ads does not return data on the current month;

            if you don’t specify this field, yesterday’s date will be used by default

            date format: "yyyy-mm-dd"

            example:

            "2022-11-30"'
          nullable: true
        include_adult_keywords:
          type: boolean
          description: 'include keywords associated with adult content

            optional field

            if set to true, adult keywords will be included in the response

            default value: false

            note that the API may return no data for such keywords due to Google Ads restrictions'
          nullable: true
        sort_by:
          type: string
          description: 'results sorting parameters

            optional field

            use these parameters to sort the results by relevance, search_volume, competition_index, low_top_of_page_bid, or high_top_of_page_bid in the descending order

            default value: relevance'
          nullable: true
        postback_url:
          type: string
          description: 'URL for sending task results

            optional field

            once the task is completed, we will send a POST request with its results compressed in the gzip format to the postback_url you specified

            you 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=$id

            http://your-server.com/postbackscript?id=$id&tag=$tag

            Note: special character in postback_url will be urlencoded;

            i.a., the # character will be encoded into %23

            learn more on our Help Center'
          nullable: true
        pingback_url:
          type: string
          description: 'notification URL of a completed task

            optional field

            when a task is completed we will notify you by GET request sent to the URL you have specified

            you 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=$id

            http://your-server.com/pingscript?id=$id&tag=$tag

            Note: special character in pingback_url will be urlencoded;

            i.a., the # character will be encoded into %23

            learn more on our Help Center'
          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 array of the response'
          nullable: true
      example:
      - location_name: United States
        keywords:
        - buy laptop
        - cheap laptops for sale
        - purchase laptop
    DataforseoTrendsinterestsInfo:
      type: object
      properties:
        keyword:
          type: string
          description: 'relevant keyword

            the data included in the values element is based on this keyword'
          nullable: true
        values:
          type: array
          items:
            type: object
            oneOf:
            - $ref: '#/components/schemas/DataforseoTrendsinterestsValuesInfo'
            nullable: true
          description: contains data on relative keyword popularity by country or region
          nullable: true
    CountryDistribution:
      type: object
      properties:
        country_iso_code:
          type: string
          description: country ISO code
          nullable: true
        search_volume:
          type: integer
          description: search volume in a given country
          format: int64
          nullable: true
        percentage:
          type: number
          description: percentage of global search volume
          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: array of tasks
            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: array of tasks
            nullable: true
    AvailableLanguages:
      type: object
      properties:
        available_sources:
          type: array
          items:
            type: string
            nullable: true
          description: 'supported sources

            contains the sources of data supported for a specific location and language combination

            only google and bing are currently available'
          nullable: true
        language_name:
          type: string
          description: language name
          nullable: true
        language_code:
          type: string
          description: language code according to ISO 639-1
          nullable: true
        keywords:
          type: integer
          description: the number of keywords available for the given location and language
          nullable: true
        serps:
          type: integer
          description: the number of SERP pages available for the given location and language
          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: array of results
            nullable: true
    KeywordsDataBingSearchVolumeHistoryLiveRequestInfo:
      type: object
      properties:
        keywords:
          type: array
          items:
            type: string
          description: 'keywords

            required field

            The maximum number of keywords you can specify: 1000

            The maximum number of characters for each keyword: 100

            the specified keywords will be converted to lowercase, data will be provided in a separate array

            learn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article'
        location_name:
          type: string
          description: 'full name of search engine location

            required field if you don’t specify location_code or location_coordinate

            if you use this field, you don’t need to specify location_code or location_coordinate

            you 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/keywords_data/bing/search_volume_history/locations_and_languages

            example:

            London,England,United Kingdom'
          nullable: true
        location_code:
          type: integer
          description: 'search engine location code

            required field if you don’t specify location_name or location_coordinate

            if you use this field, you don’t need to specify location_name or location_coordinate

            you can receive the list of available locations of the search engines with their location_code by making a separate request to https://api.dataforseo.com/v3/keywords_data/bing/search_volume_history/locations_and_languages

            example:

            2840'
          nullable: true
        location_coordinate:
          type: string
          description: 'GPS coordinates of a location

            required field if you don’t specify location_name or location_code

            if you use this field, you don’t need to specify location_name or location_code

            location_coordinate parameter should be specified in the “latitude,longitude” format

            the data will be provided for the country the specified coordinates belong to

            example:

            52.6178549,-155.352142'
          nullable: true
        language_name:
          type: string
          description: 'full name of search engine language

            required field if you don’t specify language_code

            if you use this field, you don’t need to specify language_code

            you can receive the list of available languages of the search engines with their language_code by making a separate request to https://api.dataforseo.com/v3/keywords_data/bing/search_volume_history/locations_and_languages'
          nullable: true
        language_code:
          type: string
          description: 'search engine language code

            required field if you don’t specify language_name

            if you use this field, you don’t need to specify language_name

            you can receive the list of available languages of the search engines with their language_code by making a separate request to https://api.dataforseo.com/v3/keywords_data/bing/search_volume_history/locations_and_languages'
          nullable: true
        device:
          type: array
          items:
            type: string
          description: 'device types

            optional field

            specify this field if you want to get the data for a particular device types

            possible values: mobile, desktop, tablet, non_smartphones

            default value:  ["mobile", "desktop", "tablet", "non_smartphones"]'
          nullable: true
        period:
          type: string
          description: 'aggregates the returned data to a certain time period

            optional field

            specify this field if you want to get the data in monthly, weekly or daily format

            possible values: monthly, weekly, daily

            monthly – returns data up to past 24 months

            weekly – returns data up to past 15 weeks

            daily – returns data up to past 45 days

            default value:  monthly'
          nullable: true
        date_from:
          type: string
          description: 'starting date of the time range

            optional field

            minimum value: 24 months back from today’s date

            maximum value: one day from today’s date

            date format: "yyyy-mm-dd"

            example:

            "2020-01-01"

            Note: we do not recommend using a custom time range

            Note 2: if date_from and date_to parameters are not specified, the data will be returned for the past 24 months

            if you specify the period parameter:

            with value weekly, you will get results for the past 15 weeks

            with value daily, you will get results for the past 45 days'
          nullable: true
        date_to:
          type: string
          description: 'ending date of the time range

            optional field

            minimum value: two years back from today’s date;

            maximum value: one day from today’s date;

            date format: "yyyy-mm-dd"

            example:

            "2020-03-15"

            Note: we do not recommend using a custom time range

            Note 2: if date_from and date_to parameters are not specified, the data will be returned for the past 24 months

            if you specify the period parameter:

            with value weekly, you will get results for the past 15 weeks

            with value daily, you will get results for the past 45 days'
          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:
      - location_code: 2840
        language_code: en
        keywords:
        - 10 minute timer
    KeywordsDataBingKeywordsForKeywordsTaskPostRequestInfo:
      type: object
      properties:
        keywords:
          type: array
          items:
            type: string
          description: 'keywords

            required field

            you can specify the maximum of 200 keywords with each keyword containing no more than 100 characters;

            the specified keywords will be converted to lowercase, data will be provided in a separate array

            learn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article'
        location_name:
          type: string
          description: 'full name of search engine location

            required field if you don’t specify location_code or location_coordinate

            if you use this field, you don’t need to specify location_code or location_coordinate

            you 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/keywords_data/bing/locations

            example:

            London,England,United Kingdom'
          nullable: true
        location_code:
          type: integer
          description: 'search engine location code

            required field if you don’t specify location_name or location_coordinate

            if you use this field, you don’t need to specify location_name or location_coordinate

            you can receive the list of available locations of the search engines with their location_code by making a separate request to https://api.dataforseo.com/v3/keywords_data/bing/locations

            example:

            2840'
          nullable: true
        location_coordinate:
          type: string
          description: 'GPS coordinates of a location

            required field if you don’t specify location_name or location_code

            if you use this field, you don’t need to specify location_name or location_code

            location_coordinate parameter should be specified in the “latitude,longitude” format

            the data will be provided for the country the specified coordinates belong to

            example:

            52.6178549,-155.352142'
          nullable: true
        language_name:
          type: string
          description: 'full name of search engine language

            required field if you don’t specify language_code

            if you use this field, you don’t need to specify language_code

            supported languages:

            English, French, German'
          nullable: true
        language_code:
          type: string
          description: 'search engine language code

            required field if you don’t specify language_name

            if you use this field, you don’t need to specify language_name

            supported languages:

            en, fr, de'
          nullable: true
        sort_by:
          type: string
          description: 'results sorting parameters

            optional field

            Use these parameters to sort the results by search_volume, cpc, competition or relevance in the descending order

            default value: relevance'
          nullable: true
        keywords_negative:
          type: array
          items:
            type: string
          description: 'keywords negative array

            optional field

            These keywords will be ignored in the results array;

            You can specify a maximum of 200 terms that you want to exclude from the results;

            the specified keywords will be converted to lowercase format'
          nullable: true
        device:
          type: string
          description: 'device type

            optional field

            specify this field if you want to get the data for a particular device type;

            possible values: all, mobile, desktop, tablet

            default value: all'
          nullable: true
        date_from:
          type: string
          description: 'starting date of the time range

            optional field

            minimal value: 24 months from today’s date;

            if you don’t specify this field, data will be provided for the last 12 months

            date format: "yyyy-mm-dd"

            example:

            "2020-01-01"

            Note: we do not recommend using a custom time range for the past year’s dates'
          nullable: true
        date_to:
          type: string
          description: 'ending date of the time range

            optional field

            if you don’t specify this field, data will be provided for the last 12 months;

            minimum value: two years back from today’s date;

            maximum value: one month from today’s date;

            date format: "yyyy-mm-dd"

            example:

            "2020-03-15"

            Note: we do not recommend using a custom time range for the past year’s dates'
          nullable: true
        search_partners:
          type: boolean
          description: 'Bing search partners type

            optional field

            if you specify true, 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.

            default value: false – results are returned for Bing, AOL, and Yahoo search networks'
          nullable: true
        postback_url:
          type: string
          description: 'URL for sending task results

            optional field

            once the task is completed, we will send a POST request with its results compressed in the gzip format to the postback_url you specified

            you 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=$id

            http://your-server.com/postbackscript?id=$id&tag=$tag

            Note: special characters in postback_url will be urlencoded;

            i.a., the # character will be encoded into %23

            learn more on our Help Center'
          nullable: true
        pingback_url:
          type: string
          description: 'notification URL of a completed task

            optional field

            when a task is completed we will notify you by GET request sent to the URL you have specified

            you 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=$id

            http://your-server.com/pingscript?id=$id&tag=$tag

            Note: special characters in pingback_url will be urlencoded;

            i.a., the # character will be encoded into %23

            learn more on our Help Center'
          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:
      - location_code: 2840
        language_code: en
        keywords:
        - average page rpm adsense
        - adsense blank ads how long
        - leads and prospects
    KeywordsDataBingLocationsResultInfo:
      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_code_parent:
          type: integer
          description: 'the code of the superordinate location

            example:

            "location_code": 9041134,

            "location_name": "Vienna International Airport,Lower Austria,Austria",

            "location_code_parent": 20044where location_code_parent corresponds to:

            "location_code": 20044,

            "location_name": "Lower Austria,Austria"'
          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
    KeywordsDataDataforseoTrendsExploreLiveResultInfo:
      type: object
      properties:
        keywords:
          type: array
          items:
            type: string
            nullable: true
          description: keywords in a POST array
          nullable: true
        type:
          type: string
          description: type of element
          nullable: true
        location_code:
          type: integer
          description: 'location code in a POST array

            if there is no data, then the value is null'
          nullable: true
        language_code:
          type: string
          description: 'language code in a POST array

            if there is no data, then the value is null'
          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
        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/DataforseoTrendsDataforseoTrendsGraphElementItem'
            nullable: true
          description: contains keyword popularity and related data
          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: array of results
            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: array of results
            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: array of tasks
            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: array of results
            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: array of results
            nullable: true
    Demography:
      type: object
      properties:
        age:
          type: array
          items:
            type: object
            oneOf:
            - $ref: '#/components/schemas/DataforseoTrendsDataInfo'
            nullable: true
          description: distribution of keyword popularity by age
          nullable: true
        gender:
          type: array
          items:
            type: object
            oneOf:
            - $ref: '#/components/schemas/DataforseoTrendsDataInfo'
            nullable: true
          description: distribution of keyword popularity by gender
          nullable: true
    KeywordsDataDataforseoTrendsDemographyLiveRequestInfo:
      type: object
      properties:
        keywords:
          type: array
          items:
            type: string
          description: 'keywords

            required field

            the maximum number of keywords you can specify: 5

            avoid symbols and special characters (e.g., UTF symbols, emojis);

            specifying non-Latin characters, you’ll get data for the countries where they are used

            learn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article'
        location_name:
          type: string
          description: 'full name of search engine location

            optional field

            if you don’t use this field, you will recieve global results

            if you use this field, you don’t need to specify location_code

            you 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/keywords_data/dataforseo_trends/locations

            note that the data will be provided for the country the specified location_name belongs to;

            example:

            United Kingdom'
          nullable: true
        location_code:
          type: integer
          description: 'search engine location code

            optional field

            if you don’t use this field, you will recieve global results

            if you use this field, you don’t need to specify location_name

            you can receive the list of available locations of the search engines with their location_code by making a separate request to https://api.dataforseo.com/v3/keywords_data/dataforseo_trends/locations

            note that the data will be provided for the country the specified location_code belongs to;

            example:

            2840'
          nullable: true
        type:
          type: string
          description: type of element
          nullable: true
        date_from:
          type: string
          description: 'starting date of the time range

            optional field

            if you don’t specify this field, the current day and month of the preceding year will be used by default

            minimal value for the web type: 2004-01-01

            minimal value for other types: 2008-01-01

            date format: "yyyy-mm-dd"

            example:

            "2019-01-15"'
          nullable: true
        date_to:
          type: string
          description: 'ending date of the time range

            optional field

            if you don’t specify this field, the today’s date will be used by default

            date format: "yyyy-mm-dd"

            example:

            "2019-01-15"'
          nullable: true
        time_range:
          type: string
          description: 'preset time ranges

            optional field

            if you specify date_from or date_to parameters, this field will be ignored when setting a task

            possible values for all type parameters:

            past_4_hours, past_day, past_7_days, past_30_days, past_90_days, past_12_months, past_5_years'
          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:
      - keywords:
        - rugby
        - cricket
        date_from: '2026-01-15'
        date_to: '2026-03-15'
        type: web
        location_name: United States
    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: array of tasks
            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: array of tasks
            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: array of tasks
            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: array of results
            nullable: true
    KeywordsDataGoogleAdsAdTrafficByKeywordsTasksReadyResultInfo:
      type: object
      properties:
        id:
          type: string
          description: 'task identifier of the completed task

            unique task identifier in our system in the UUID format'
          nullable: true
        se:
          type: string
          description: search engine specified when setting the task
          nullable: true
        se_type:
          type: string
          nullable: true
        date_posted:
          type: string
          description: date when the task was posted (in the UTC format)
          nullable: true
        tag:
          type: string
          description: user-defined task identifier
          nullable: true
        endpoint:
          type: string
          description: URL for collecting the results of the task
          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: array of tasks
            nullable: true
    KeywordsDataDataforseoTrendsExploreLiveRequestInfo:
      type: object
      properties:
        keywords:
          type: array
          items:
            type: string
          description: 'keywords

            required field

            the maximum number of keywords you can specify: 5

            learn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article'
        location_name:
          type: string
          description: 'full name of search engine location

            optional field

            if you don’t use this field, you will recieve global results

            if you use this field, you don’t need to specify location_code

            you 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/keywords_data/dataforseo_trends/locations

            note that the data will be provided for the country the specified location_name belongs to;

            example:

            United Kingdom'
          nullable: true
        location_code:
          type: integer
          description: 'search engine location code

            optional field

            if you don’t use this field, you will recieve global results

            if you use this field, you don’t need to specify location_name

            you can receive the list of available locations of the search engines with their location_code by making a separate request to https://api.dataforseo.com/v3/keywords_data/dataforseo_trends/locations

            note that the data will be provided for the country the specified location_code belongs to;

            example:

            2840'
          nullable: true
        type:
          type: string
          description: type of element
          nullable: true
        date_from:
          type: string
          description: 'starting date of the time range

            optional field

            if you don’t specify this field, the current day and month of the preceding year will be used by default

            minimal value for the web type: 2004-01-01

            minimal value for other types: 2008-01-01

            date format: "yyyy-mm-dd"

            example:

            "2019-01-15"'
          nullable: true
        date_to:
          type: string
          description: 'ending date of the time range

            optional field

            if you don’t specify this field, the today’s date will be used by default

            date format: "yyyy-mm-dd"

            example:

            "2019-01-15"'
          nullable: true
        time_range:
          type: string
          description: 'preset time ranges

            optional field

            if you specify date_from or date_to parameters, this field will be ignored when setting a task

            possible values for all type parameters:

            past_4_hours, past_day, past_7_days, past_30_days, past_90_days, past_12_months, past_5_years'
          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:
      - keywords:
        - iphone 14
        - samsung s23
        location_code: 2840
    DemographyItemValueInfo:
      type: object
      properties:
        type:
          type: string
          description: type of element
          nullable: true
        value:
          type: integer
          description: 'keyword popularity rate within the specified age range

            using this value you can understand how popular a keyword is within each age range;

            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);

            a value of 100 is the highest popularity for the term

            a value of 0 means there was not enough data for this term'
          nullable: true
    KeywordsDataBingKeywordsForKeywordsTaskPostTaskInfo:
      type: object
      allOf:
      - $ref: '#/components/schemas/BaseResponseTaskInfo'
      - type: object
        properties:
          result:
            type: object
            description: 'array of results

              in this case, the value will be null'
            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: 'demographic breakdown of keyword popularity data per each specified term

              conains keyword popularity data by age and gender'
            nullable: true
          demography_comparison:
            type: object
            oneOf:
            - $ref: '#/components/schemas/DemographyComparisonInfo'
            description: 'comparison of demographic data on keyword popularity for the specified parameters

              conains keyword popularity data by age and gender

              if you specified a single keyword, the value will be null'
            nullable: true
    KeywordsDataGoogleAdsStatusResultInfo:
      type: object
      properties:
        actual_data:
          type: boolean
          description: 'indicates whether Google updated keyword data for the previous month

            generally, Google updates keyword data in the middle of the month

            if the value is true, Google currently provides up-to-date data for the previous month

            if the value is false, we are not able to provide data for the previous month'
          nullable: true
        date_update:
          type: string
          description: 'date of the latest update of Google Ads data

            indicates the latest date when Google updated search volume, CPC, and other keyword metrics

            example:

            2020-05-15'
          nullable: true
        last_year_in_monthly_searches:
          type: integer
          description: the latest year for which search volume data is available
          nullable: true
        last_month_in_monthly_searches:
          type: integer
          description: the latest month for which search volume data is available
          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: array of tasks
            nullable: true
    KeywordsDataBingAudienceEstimationLiveRequestInfo:
      type: object
      properties:
        location_name:
          type: string
          description: 'full name of search engine location

            required field if you don’t specify location_code or location_coordinate

            if you use this field, you don’t need to specify location_code or location_coordinate

            you 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/keywords_data/bing/locations

            example:

            London,England,United Kingdom'
          nullable: true
        location_code:
          type: integer
          description: 'search engine location code

            required field if you don’t specify location_name or location_coordinate

            if you use this field, you don’t need to specify location_name or location_coordinate

            you can receive the list of available locations of the search engines with their location_code by making a separate request to https://api.dataforseo.com/v3/keywords_data/bing/locations

            example:

            2840'
          nullable: true
        location_coordinate:
          type: string
          description: 'GPS coordinates of a location

            required field if you don’t specify location_name or location_code

            if you use this field, you don’t need to specify location_name or location_code

            location_coordinate parameter should be specified in the “latitude,longitude,radius (in km)” format

            the data will be provided for the country the specified coordinates belong to

            example:

            29.6821525,-82.4098881,100'
          nullable: true
        age:
          type: array
          items:
            type: string
          description: 'selection of age ranges for targeting

            possible values: eighteen_to_twenty_four, fifty_to_sixty_four, sixty_five_and_above, thirteen_to_seventeen, thirty_five_to_forty_nine, twenty_five_to_thirty_four, unknown, zero_to_twelve'
          nullable: true
        bid:
          type: number
          description: 'desired bid setting value in USD

            maximum value: 1000'
          nullable: true
        daily_budget:
          type: number
          description: 'daily campaign budget value in USD

            maximum value: 10000'
          nullable: true
        gender:
          type: array
          items:
            type: string
          description: 'gender to target

            possible values: male, female, unknown'
          nullable: true
        industry:
          type: array
          items:
            type: string
          description: 'industry of LinkedIn profile targeting

            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

            example: 806301758'
          nullable: true
        job_function:
          type: array
          items:
            type: string
          description: 'job function of LinkedIn profile targeting

            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

            example: 806300451'
          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
    KeywordsDataGoogleAdsAdTrafficByKeywordsTaskPostTaskInfo:
      type: object
      allOf:
      - $ref: '#/components/schemas/BaseResponseTaskInfo'
      - type: object
        properties:
          result:
            type: object
            description: 'array of results

              in this case, the value will be null'
            nullable: true
    KeywordsDataGoogleAdsKeywordsForKeywordsTaskGetResultInfo:
      type: object
      properties:
        keyword:
          type: string
          description: keyword in a POST array
          nullable: true
        spell:
          type: string
          nullable: true
        location_code:
          type: integer
          description: 'location code in a POST array

            if there is no data, the value is null'
          nullable: true
        language_code:
          type: string
          description: 'language code in a POST array

            if there is no data, the value is null'
          nullable: true
        search_partners:
          type: boolean
          description: 'include Google search partners

            the value you specified when setting the task

            if true, the results are returned for owned, operated, and syndicated networks across Google and partner sites that host Google search;

            if false, the results are returned for Google search sites only'
          nullable: true
        competition:
          type: string
          description: 'competition

            represents the relative level of competition associated with the given keyword in paid SERP only

            possible values: LOW, MEDIUM, HIGH

            if competition level is unknown, the value is null;

            learn more about the metric in this help center article'
          nullable: true
        competition_index:
          type: integer
          description: 'competition index

            the competition index for the query indicating how competitive ad placement is for the keyword

            can take values from 0 to 100

            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

            if not enough data is available, the value is null;

            learn more about the metric in this help center article'
          nullable: true
        search_volume:
          type: integer
          description: 'monthly average search volume rate

            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

            if there is no data, the value is null'
          format: int64
          nullable: true
        low_top_of_page_bid:
          type: number
          description: 'minimum bid for the ad to be displayed at the top of the first page

            indicates the value greater than about 20% of the lowest bids for which ads were displayed (based on Google Ads statistics for advertisers)

            the value may differ depending on the location specified in a POST request'
          nullable: true
        high_top_of_page_bid:
          type: number
          description: 'maximum bid for the ad to be displayed at the top of the first page

            indicates the value greater than about 80% of the lowest bids for which ads were displayed (based on Google Ads statistics for advertisers)

            the value may differ depending on the location specified in a POST request'
          nullable: true
        cpc:
          type: number
          description: 'cost per click

            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: 'monthly searches

            represents the (approximate) number of searches on this keyword idea (as available for the past twelve months), targeted to the specified geographic locations

            if there is no data, the value is null'
          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: array of results
            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: array of tasks
            nullable: true
    KeywordsDataGoogleAdsAdTrafficByKeywordsLiveRequestInfo:
      type: object
      properties:
        keywords:
          type: array
          items:
            type: string
          description: 'keywords

            required field

            The maximum number of keywords you can specify: 1000

            The maximum number of characters for each keyword: 80

            The maximum number of words for each keyword phrase: 10

            the keywords you specify will be converted to a lowercase format

            Note: Google Ads may return no data for certain groups of keywords

            visit our Help Center to learn more

            Also note 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;

            to learn more about which symbols and characters can be used, please refer to this article

            learn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article'
        bid:
          type: integer
          description: 'the maximum custom bid

            required field

            the collected data will be based on this value

            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

            learn more in this help center article'
          format: int64
        match:
          type: string
          description: 'keywords match-type

            required field

            can take the following values: exact, broad, phrase'
        search_partners:
          type: boolean
          description: 'include Google search partners

            optional field

            if you specify true, the results will be delivered for owned, operated, and syndicated networks across Google and partner sites that host Google search;

            default value: false – results are returned for Google search sites'
          nullable: true
        location_name:
          type: string
          description: 'full name of search engine location

            optional field

            if you do not indicate the location, you will receive worldwide results, i.e., for all available locations;

            if you use this field, you don’t need to specify location_code or location_coordinate

            you 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/keywords_data/google_ads/locations

            example:

            London,England,United Kingdom'
          nullable: true
        location_code:
          type: integer
          description: 'search engine location code

            optional field

            if you do not indicate the location, you will receive worldwide results, i.e., for all available locations;

            if you use this field, you don’t need to specify location_name or location_coordinate;

            you can receive the list of available locations of the search engines with their location_code by making a separate request to https://api.dataforseo.com/v3/keywords_data/google_ads/locations

            example:

            2840'
          nullable: true
        location_coordinate:
          type: string
          description: 'GPS coordinates of a location

            optional field

            if you do not indicate the location, you will receive worldwide results, i.e., for all available locations;

            if you use this field, you don’t need to specify location_name or location_code;

            location_coordinate parameter should be specified in the “latitude,longitude” format;

            the data will be provided for the country the specified coordinates belong to;

            example:

            52.6178549,-155.352142'
          nullable: true
        language_name:
          type: string
          description: 'full name of search engine language

            optional field

            you can receive the list of available languages of the search engine with their language_name by making a separate request to https://api.dataforseo.com/v3/keywords_data/google_ads/languages

            example:

            English'
          nullable: true
        language_code:
          type: string
          description: 'search engine language code

            optional field

            you can receive the list of available languages of the search engine with their language_code by making a separate request to https://api.dataforseo.com/v3/keywords_data/google_ads/languages

            example:

            en'
          nullable: true
        date_from:
          type: string
          description: 'starting date of the forecasting time range

            required field if you specify date_to

            if you indicate date_from and date_to, you don’t need to specify date_interval

            minimum value is tomorrow’s date

            the value you specify in date_from shouldn’t be further than date_to

            date format: "yyyy-mm-dd"

            example:

            "2021-10-30"if Status endpoint returns false in the actual_data field, date_from can be set to the month before last and prior;

            if Status endpoint returns true in the actual_data field, date_from can be set to the last month and prior'
          nullable: true
        date_to:
          type: string
          description: 'ending date of the forecasting time range

            required field if you specify date_from

            if you indicate date_from and date_to, you don’t need to specify date_interval

            minimum value is date_from +1 day

            maximum value is current day and month of the next year

            date format: "yyyy-mm-dd"

            example:

            "2022-10-30"'
          nullable: true
        date_interval:
          type: string
          description: 'forecasting date interval

            optional field

            if you specify date_interval, you don’t need to indicate date_from and date_to

            possible values: next_week, next_month, next_quarter

            default value: next_month'
          nullable: true
        sort_by:
          type: string
          description: 'results sorting parameters

            optional field

            Use these parameters to sort the results by relevance, impressions, ctr, average_cpc, cost, or clicks in the descending order

            default value: relevance'
          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:
      - location_code: 2840
        language_code: en
        bid: 999
        match: exact
        keywords:
        - seo marketing
    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: array of tasks
            nullable: true
    KeywordsDataDataforseoTrendsMergedDataLiveRequestInfo:
      type: object
      properties:
        keywords:
          type: array
          items:
            type: string
          description: 'keywords

            required field

            the maximum number of keywords you can specify: 5

            avoid symbols and special characters (e.g., UTF symbols, emojis);

            specifying non-Latin characters, you’ll get data for the countries where they are used

            learn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article'
        location_name:
          type: string
          description: 'full name of search engine location

            optional field

            if you don’t use this field, you will recieve global results

            if you use this field, you don’t need to specify location_code

            you 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/keywords_data/dataforseo_trends/locations

            note that the data will be provided for the country the specified location_name belongs to;

            example:

            United Kingdom'
          nullable: true
        location_code:
          type: integer
          description: 'search engine location code

            optional field

            if you don’t use this field, you will recieve global results

            if you use this field, you don’t need to specify location_name

            you can receive the list of available locations of the search engines with their location_code by making a separate request to https://api.dataforseo.com/v3/keywords_data/dataforseo_trends/locations

            note that the data will be provided for the country the specified location_code belongs to;

            example:

            2840'
          nullable: true
        type:
          type: string
          description: type of element
          nullable: true
        date_from:
          type: string
          description: 'starting date of the time range

            optional field

            if you don’t specify this field, the current day and month of the preceding year will be used by default

            minimal value for the web type: 2004-01-01

            minimal value for other types: 2008-01-01

            date format: "yyyy-mm-dd"

            example:

            "2019-01-15"'
          nullable: true
        date_to:
          type: string
          description: 'ending date of the time range

            optional field

            if you don’t specify this field, the today’s date will be used by default

            date format: "yyyy-mm-dd"

            example:

            "2019-01-15"'
          nullable: true
        time_range:
          type: string
          description: 'preset time ranges

            optional field

            if you specify date_from or date_to parameters, this field will be ignored when setting a task

            possible values for all type parameters:

            past_4_hours, past_day, past_7_days, past_30_days, past_90_days, past_12_months, past_5_years'
          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:
      - keywords:
        - rugby
        - cricket
        date_from: '2026-01-15'
        date_to: '2026-03-15'
        type: web
        location_name: United States
    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: array of results
            nullable: true
    KeywordsDataErrorsRequestInfo:
      type: object
      properties:
        limit:
          type: integer
          description: 'the maximum number of returned tasks that responded with an error

            optional field

            default value: 1000

            maximum value: 1000'
          nullable: true
        offset:
          type: integer
          description: 'offset in the results array of returned tasks

            optional field

            default value: 0

            if you specify the 10 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: 'return tasks with a certain function

            use this field to obtain a list of tasks that returned an error filtered by a certain function

            you can filter the results by the values you receive in the function fields of the API response

            i.e., once you receive unfiltered results, you can call this API again to filter them by function

            example: keywords_data/keywords_for_site/task_post, postback_url, pingback_url'
          nullable: true
        datetime_from:
          type: string
          description: 'start time for filtering results

            optional field

            allows filtering results by the datetime parameter within the range of the last 7 days;

            must be specified in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”

            example:

            2021-11-15 12:57:46 +00:00'
          nullable: true
        datetime_to:
          type: string
          description: 'finish time for filtering results

            optional field

            allows filtering results by the datetime parameter within the range of the last 7 days;

            must be specified in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”

            example:

            2021-11-15 13:57:46 +00:00'
          nullable: true
      example:
      - limit: 10
        offset: 0
        filtered_function: pingback_url
    KeywordsDataBingAudienceEstimationTaskGetResultInfo:
      type: object
      properties:
        est_impressions:
          type: object
          oneOf:
          - $ref: '#/components/schemas/AudienceEstimationInfo'
          description: monthly estimated impressions range
          nullable: true
        est_audience_size:
          type: object
          oneOf:
          - $ref: '#/components/schemas/AudienceEstimationInfo'
          description: monthly estimated reach user count range
          nullable: true
        est_clicks:
          type: object
          oneOf:
          - $ref: '#/components/schemas/AudienceEstimationInfo'
          description: monthly estimated click count range
          nullable: true
        est_spend:
          type: object
          oneOf:
          - $ref: '#/components/schemas/AudienceEstimationInfo'
          description: monthly estimated spending range
          nullable: true
        est_cost_per_event:
          type: object
          oneOf:
          - $ref: '#/components/schemas/AudienceEstimationInfo'
          description: indicates the estimated cost per event with range result
          nullable: true
        est_ctr:
          type: object
          oneOf:
          - $ref: '#/components/schemas/AudienceEstimationInfo'
          description: estimated click-through rate range
          nullable: true
        suggested_bid:
          type: number
          description: suggested bid value under the current targeting
          nullable: true
        suggested_budget:
          type: number
          description: suggested daily budget value under the current targeting and bid
          format: double
          nullable: true
        events_lost_to_bid:
          type: integer
          description: indicates event lost count due to insufficient input bid
          format: int64
          nullable: true
        events_lost_to_budget:
          type: integer
          description: indicates the event lost count due to insufficient input budget
          nullable: true
        est_reach_audience_size:
          type: integer
          description: monthly estimated user count
          format: int64
          nullable: true
        est_reach_impressions:
          type: integer
          description: monthly estimated impressions
          format: int64
          nullable: true
        currency:
          type: string
          description: 'currency name

            example: USDollar'
          nullable: true
    KeywordsDataBingAudienceEstimationIndustriesResultInfo:
      type: object
      properties:
        industry_id:
          type: integer
          description: ID of the industry
          format: int64
          nullable: true
        industry_name:
          type: string
          description: name of the industry
          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: array of results
            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: array of tasks
            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: array of tasks
            nullable: true
    KeywordsDataGoogleTrendsLocationsResultInfo:
      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_code_parent:
          type: integer
          description: 'the code of the superordinate location

            example:

            "location_code": 9041134,

            "location_name": "Vienna International Airport,Lower Austria,Austria",

            "location_code_parent": 20044

            where location_code_parent corresponds to:

            "location_code": 20044,

            "location_name": "Lower Austria,Austria"'
          nullable: true
        country_iso_code:
          type: string
          description: ISO country code of the location
          nullable: true
        location_type:
          type: string
          description: 'location type

            possible values according to Google’s target types'
          nullable: true
        geo_id:
          type: string
          description: 'google trends location identifier

            you can use this field for matching obtained results with the location_code parameter specified in the request'
          nullable: true
    KeywordsDataGoogleAdsAdTrafficByKeywordsTaskGetResultInfo:
      type: object
      properties:
        keyword:
          type: string
          description: 'keyword in a POST array

            metrics are provided for all the keywords specified in the POST array'
          nullable: true
        location_code:
          type: integer
          description: 'location code in a POST array

            if there is no data, then the value is null'
          nullable: true
        language_code:
          type: string
          description: 'language code in a POST array

            if there is no data, then the value is null'
          nullable: true
        date_interval:
          type: string
          description: forecasting date interval in a POST array
          nullable: true
        search_partners:
          type: boolean
          description: 'include Google search partners

            the value you specified when setting the task

            if true, the results are returned for owned, operated, and syndicated networks across Google and partner sites that host Google search;

            if false, the results are returned for Google search sites only'
          nullable: true
        bid:
          type: number
          description: 'the maximum custom bid

            the bid you have specified when setting the task

            represents the price you are willing to pay for an ad

            the higher value you have specified, the higher metrics and cost you receive in response

            learn more in this help center article'
          nullable: true
        match:
          type: string
          description: 'keywords match-type

            can take the following values: exact, broad, phrase'
          nullable: true
        impressions:
          type: integer
          description: 'projected number of ad impressions

            number of impressions an ad is projected to get within the specified time period

            if there is no data, then the value is null

            learn more about impressions in this help center article'
          nullable: true
        ctr:
          type: number
          description: 'projected clickthrough rate (CTR) of the advertisement

            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

            if there is no data, then the value is null'
          format: double
          nullable: true
        average_cpc:
          type: number
          description: 'the average cost-per-click value

            represents the cost-per-click (USD) estimated for a keyword based on the specified time period and historical data;

            if there is no data, then the value is null'
          format: double
          nullable: true
        cost:
          type: number
          description: 'charge for an ad

            amount that will be charged for running an ad within the specified time period

            if there is no data, then the value is null'
          nullable: true
        clicks:
          type: number
          description: 'number of clicks on an ad

            number of clicks an ad is projected to get within the specified time period

            if there is no data, then the value is null'
          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: array of tasks
            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: array of tasks
            nullable: true
    KeywordsDataBingSearchVolumeHistoryTasksReadyResultInfo:
      type: object
      properties:
        id:
          type: string
          description: 'task identifier of the completed task

            unique task identifier in our system in the UUID format'
          nullable: true
        se:
          type: string
          description: search engine specified when setting the task
          nullable: true
        se_type:
          type: string
          nullable: true
        date_posted:
          type: string
          description: date when the task was posted (in the UTC format)
          nullable: true
        tag:
          type: string
          description: user-defined task identifier
          nullable: true
        endpoint:
          type: string
          description: URL for collecting the results of the task
          nullable: true
    KeywordsDataBingKeywordsForSiteTasksReadyResultInfo:
      type: object
      properties:
        id:
          type: string
          description: 'task identifier of the completed task

            unique task identifier in our system in the UUID format'
          nullable: true
        se:
          type: string
          description: search engine specified when setting the task
          nullable: true
        se_type:
          type: string
          nullable: true
        date_posted:
          type: string
          description: date when the task was posted (in the UTC format)
          nullable: true
        tag:
          type: string
          description: user-defined task identifier
          nullable: true
        endpoint:
          type: string
          description: URL for collecting the results of the task
          nullable: true
        function:
          type: string
          nullable: 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
    KeywordsDataGoogleAdsSearchVolumeLiveResultInfo:
      type: object
      properties:
        keyword:
          type: string
          description: 'keyword

            keyword is returned with decoded %## (plus character ‘+’ will be decoded to a space character)'
          nullable: true
        spell:
          type: string
          description: 'correct spelling of the keyword

            Note:if the keyword in the POST array appears to be misspelled, data will be returned for the correctly spelled keyword;

            we use the functionality of Google Ads API to check and validate the spelling of keywords, learn more by this link'
          nullable: true
        location_code:
          type: integer
          description: 'location code in a POST array

            if there is no data, then the value is null'
          nullable: true
        language_code:
          type: string
          description: 'language code in a POST array

            if there is no data, then the value is null'
          nullable: true
        search_partners:
          type: boolean
          description: indicates whether data from partner networks included in the response
          nullable: true
        competition:
          type: string
          description: 'competition

            represents the relative amount of competition associated with the given keyword in paid SERP only;

            this value is based on Google Ads data and can take the following values: HIGH, MEDIUM, LOW;

            if there is no data the value is null;

            learn more about the metric in this help center article'
          nullable: true
        competition_index:
          type: integer
          description: 'competition

            represents the relative amount of competition associated with the given keyword in paid SERP only;

            this value is based on Google Ads data and can be between 0 and 100 (inclusive);

            if there is no data the value is null;

            learn more about the metric in this help center article'
          nullable: true
        search_volume:
          type: integer
          description: monthly average search volume rate
          format: int64
          nullable: true
        low_top_of_page_bid:
          type: number
          description: 'minimum bid for the ad to be displayed at the top of the first page

            indicates the value greater than about 20% of the lowest bids for which ads were displayed (based on Google Ads statistics for advertisers);

            the value may differ depending on the location specified in a POST request'
          nullable: true
        high_top_of_page_bid:
          type: number
          description: 'maximum bid for the ad to be displayed at the top of the first page

            indicates the value greater than about 80% of the lowest bids for which ads were displayed (based on Google Ads statistics for advertisers);

            the value may differ depending on the location specified in a POST request'
          nullable: true
        cpc:
          type: number
          description: 'cost per click

            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: 'monthly searches

            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;

            if there is no data then the value is null'
          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: array of tasks
            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: array of tasks
            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: array of tasks
            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: array of tasks
            nullable: true
    KeywordsDataBingKeywordPerformanceLiveRequestInfo:
      type: object
      properties:
        keywords:
          type: array
          items:
            type: string
          description: 'keywords

            required field

            The maximum number of keywords you can specify: 1000

            The maximum number of characters for each keyword: 80

            The maximum number of words for each keyword phrase: 10

            the specified keywords will be converted to lowercase, data will be provided in a separate array

            learn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article'
        device:
          type: string
          description: 'device type

            optional field

            specify this field if you want to get the data for a particular device typepossible values: desktop, mobile, tablet, all

            default value: all'
          nullable: true
        match:
          type: string
          description: 'keywords match type

            optional field

            can take the following values:

            aggregate returns data across all match types;

            broad returns data for all user queries containing the specified keyword with varying word order;

            phrase returns data for all user queries containing the specified keyword with identical word order;

            exact returns data for user query that matches the specified keyword;Note: the aggregate match type is applied by default'
          nullable: true
        location_name:
          type: string
          description: 'full name of search engine location

            required field if you don’t specify location_code or location_coordinate

            if you use this field, you don’t need to specify location_code or location_coordinate

            you can receive the list of available locations and languages by making a separate request to https://api.dataforseo.com/v3/keywords_data/bing/keyword_performance/locations_and_languages

            example:

            "United States"'
          nullable: true
        location_code:
          type: integer
          description: 'search engine location code

            required field if you don’t specify location_name or location_coordinate

            if you use this field, you don’t need to specify location_name or location_coordinate

            you can receive the list of available locations and languages by making a separate request to https://api.dataforseo.com/v3/keywords_data/bing/keyword_performance/locations_and_languages

            example:

            2840'
          nullable: true
        location_coordinate:
          type: string
          description: 'GPS coordinates of a location

            required field if you don’t specify location_name or location_code

            if you use this field, you don’t need to specify location_name or location_code

            location_coordinate parameter should be specified in the “latitude,longitude” format

            the data will be provided for the country the specified coordinates belong to

            example:

            52.6178549,-155.352142'
          nullable: true
        language_name:
          type: string
          description: 'full name of search engine language

            required field if you don’t specify language_code

            if you use this field, you don’t need to specify language_code

            you can receive the list of available locations and languages by making a separate request to https://api.dataforseo.com/v3/keywords_data/bing/keyword_performance/locations_and_languages

            example:

            English'
          nullable: true
        language_code:
          type: string
          description: 'search engine language code

            required field if you don’t specify language_name

            you can receive the list of available locations and languages by making a separate request to https://api.dataforseo.com/v3/keywords_data/bing/keyword_performance/locations_and_languages

            example:

            "en"'
          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:
      - location_code: 2840
        language_code: en
        keywords:
        - dataforseo
        - seo
        - ranking
    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: array of tasks
            nullable: true
    KeywordsDataGoogleAdsSearchVolumeTasksReadyResultInfo:
      type: object
      properties:
        id:
          type: string
          description: 'task identifier of the completed task

            unique task identifier in our system in the UUID format'
          nullable: true
        se:
          type: string
          description: search engine specified when setting the task
          nullable: true
        se_type:
          type: string
          nullable: true
        date_posted:
          type: string
          description: date when the task was posted (in the UTC format)
          nullable: true
        tag:
          type: string
          description: user-defined task identifier
          nullable: true
        endpoint:
          type: string
          description: URL for collecting the results of the task
          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: array of results
            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: array of tasks
            nullable: true
    KeywordsDataGoogleAdsSearchVolumeLiveRequestInfo:
      type: object
      properties:
        keywords:
          type: array
          items:
            type: string
          description: 'keywords

            required field

            The maximum number of keywords you can specify: 1000

            The maximum number of characters for each keyword: 80

            The maximum number of words for each keyword phrase: 10

            the keywords you specify will be converted to a lowercase format

            Note #1: Google Ads may return no data for certain groups of keywords;

            Note #2: Google Ads provides combined search volume values for groups of similar keywords

            to obtain search volume for similar keywords, we recommend submitting such keywords in separate requests;

            Note #3: 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;

            to learn more about which symbols and characters can be used, please refer to this article

            learn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article'
        location_name:
          type: string
          description: 'full name of search engine location

            optional field

            if you do not indicate the location, you will receive worldwide results, i.e., for all available locations;

            if you use this field, you don’t need to specify location_code or location_coordinate

            you 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/keywords_data/google_ads/locations

            example:

            London,England,United Kingdom'
          nullable: true
        location_code:
          type: integer
          description: 'search engine location code

            optional field

            if you do not indicate the location, you will receive worldwide results, i.e., for all available locations;

            if you use this field, you don’t need to specify location_name or location_coordinate;

            you can receive the list of available locations of the search engines with their location_code by making a separate request to https://api.dataforseo.com/v3/keywords_data/google_ads/locations

            example:

            2840'
          nullable: true
        location_coordinate:
          type: string
          description: 'GPS coordinates of a location

            optional field

            if you do not indicate the location, you will receive worldwide results, i.e., for all available locations;

            if you use this field, you don’t need to specify location_name or location_code;

            location_coordinate parameter should be specified in the “latitude,longitude” format;

            the data will be provided for the country the specified coordinates belong to;

            example:

            52.6178549,-155.352142'
          nullable: true
        language_name:
          type: string
          description: 'full name of search engine language

            optional field

            you can receive the list of available languages of the search engine with their language_name by making a separate request to https://api.dataforseo.com/v3/keywords_data/google_ads/languages

            example:

            English'
          nullable: true
        language_code:
          type: string
          description: 'search engine language code

            optional field

            you can receive the list of available languages of the search engine with their language_code by making a separate request to https://api.dataforseo.com/v3/keywords_data/google_ads/languages

            example:

            en'
          nullable: true
        search_partners:
          type: boolean
          description: 'include Google search partners

            optional field

            if you specify true, the results will be delivered for owned, operated, and syndicated networks across Google and partner sites that host Google search;

            default value: false – results are returned for Google search sites'
          nullable: true
        date_from:
          type: string
          description: 'starting date of the time range

            optional field

            date format: "yyyy-mm-dd"

            minimal value: 4 years from the current date

            by default, data is returned for the past 12 months;

            Note: the indicated date cannot be greater than that specified in date_to and/or yesterday’s date;if Status endpoint returns false in the actual_data field, date_from can be set to the month before last and prior;

            if Status endpoint returns true in the actual_data field, date_from can be set to the last month and prior'
          nullable: true
        date_to:
          type: string
          description: 'ending date of the time range

            optional field

            Note: the indicated date cannot be greater than the past month, Google Ads does not return data on the current month;

            if you don’t specify this field, yesterday’s date will be used by default

            date format: "yyyy-mm-dd"

            example:

            "2022-11-30"'
          nullable: true
        include_adult_keywords:
          type: boolean
          description: 'include keywords associated with adult content

            optional field

            if set to true, adult keywords will be included in the response

            default value: false

            note that the API may return no data for such keywords due to Google Ads restrictions'
          nullable: true
        sort_by:
          type: string
          description: 'results sorting parameters

            optional field

            use these parameters to sort the results by relevance, search_volume, competition_index, low_top_of_page_bid, or high_top_of_page_bid in the descending order

            default value: relevance'
          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 array of the response'
          nullable: true
      example:
      - location_code: 2840
        keywords:
        - buy laptop
        - cheap laptops for sale
        - purchase laptop
        date_from: '2026-01-15'
        search_partners: 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: array of results
            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: array of tasks
            nullable: true
    KeywordsDataGoogleAdsKeywordsForSiteLiveResultInfo:
      type: object
      properties:
        keyword:
          type: string
          description: keyword in a POST array
          nullable: true
        spell:
          type: string
          nullable: true
        location_code:
          type: integer
          description: 'location code in a POST array

            if there is no data, the value is null'
          nullable: true
        language_code:
          type: string
          description: 'language code in a POST array

            if there is no data, the value is null'
          nullable: true
        search_partners:
          type: boolean
          description: 'include Google search partners

            the value you specified when setting the task

            if true, the results are returned for owned, operated, and syndicated networks across Google and partner sites that host Google search;

            if false, the results are returned for Google search sites only'
          nullable: true
        competition:
          type: string
          description: 'competition

            represents the relative level of competition associated with the given keyword in paid SERP only

            possible values: LOW, MEDIUM, HIGH

            if competition level is unknown, the value is null;

            learn more about the metric in this help center article'
          nullable: true
        competition_index:
          type: integer
          description: 'competition index

            the competition index for the query indicating how competitive ad placement is for the keyword

            can take values from 0 to 100

            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

            if not enough data is available, the value is null;

            learn more about the metric in this help center article'
          nullable: true
        search_volume:
          type: integer
          description: 'monthly average search volume rate

            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

            if there is no data, the value is null'
          format: int64
          nullable: true
        low_top_of_page_bid:
          type: number
          description: 'minimum bid for the ad to be displayed at the top of the first page

            indicates the value greater than about 20% of the lowest bids for which ads were displayed (based on Google Ads statistics for advertisers)

            the value may differ depending on the location specified in a POST request'
          nullable: true
        high_top_of_page_bid:
          type: number
          description: 'maximum bid for the ad to be displayed at the top of the first page

            indicates the value greater than about 80% of the lowest bids for which ads were displayed (based on Google Ads statistics for advertisers)

            the value may differ depending on the location specified in a POST request'
          nullable: true
        cpc:
          type: number
          description: 'cost per click

            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: 'monthly searches

            represents the (approximate) number of searches on this keyword idea (as available for the past twelve months), targeted to the specified geographic locations

            if there is no data, the value is null'
          nullable: true
    KeywordsDataBingSearchVolumeTaskPostRequestInfo:
      type: object
      properties:
        keywords:
          type: array
          items:
            type: string
          description: 'keywords

            required field

            The maximum number of keywords you can specify: 1000

            The maximum number of characters for each keyword: 100

            the specified keywords will be converted to lowercase, data will be provided in a separate array

            learn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article'
        location_name:
          type: string
          description: 'full name of search engine location

            required field if you don’t specify location_code or location_coordinate

            if you use this field, you don’t need to specify location_code or location_coordinate

            you 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/keywords_data/bing/locations

            example:

            London,England,United Kingdom'
          nullable: true
        location_code:
          type: integer
          description: 'search engine location code

            required field if you don’t specify location_name or location_coordinate

            if you use this field, you don’t need to specify location_name or location_coordinate

            you can receive the list of available locations of the search engines with their location_code by making a separate request to https://api.dataforseo.com/v3/keywords_data/bing/locations

            example:

            2840'
          nullable: true
        location_coordinate:
          type: string
          description: 'GPS coordinates of a location

            required field if you don’t specify location_name or location_code

            if you use this field, you don’t need to specify location_name or location_code

            location_coordinate parameter should be specified in the “latitude,longitude” format

            the data will be provided for the country the specified coordinates belong to

            example:

            52.6178549,-155.352142'
          nullable: true
        language_name:
          type: string
          description: 'full name of search engine language

            required field if you don’t specify language_code

            if you use this field, you don’t need to specify language_code

            supported languages:

            English, French, German'
          nullable: true
        language_code:
          type: string
          description: 'search engine language code

            required field if you don’t specify language_name

            if you use this field, you don’t need to specify language_name

            supported languages:

            en, fr, de'
          nullable: true
        device:
          type: string
          description: 'device type

            optional field

            specify this field if you want to get the data for a particular device typepossible values: all, mobile, desktop, tablet

            default value: all'
          nullable: true
        sort_by:
          type: string
          description: 'results sorting parameters

            optional field

            Use these parameters to sort the results by search_volume, cpc, competition or relevance in the descending order

            default value: relevance'
          nullable: true
        date_from:
          type: string
          description: 'starting date of the time range

            optional field

            if you don’t specify this field, data will be provided for the last 12 months

            minimal value: 24 months from today’s date

            date format: "yyyy-mm-dd"

            example:

            "2020-01-01"

            Note: we do not recommend using a custom time range for the past year’s dates'
          nullable: true
        date_to:
          type: string
          description: 'ending date of the time range

            optional field

            if you don’t specify this field, data will be provided for the last 12 months;

            minimum value: two years back from today’s date;

            maximum value: one month from today’s date;

            note: we do not recommend using a custom time range for the past year’s dates;

            date format: "yyyy-mm-dd"

            example:

            "2020-03-15"

            Note: we do not recommend using a custom time range for the past year’s dates'
          nullable: true
        postback_url:
          type: string
          description: 'URL for sending task results

            optional field

            once the task is completed, we will send a POST request with its results compressed in the gzip format to the postback_url you specified

            you 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=$id

            http://your-server.com/postbackscript?id=$id&tag=$tag

            Note: special characters in postback_url will be urlencoded;

            i.a., the # character will be encoded into %23

            learn more on our Help Center'
          nullable: true
        pingback_url:
          type: string
          description: 'notification URL of a completed task

            optional field

            when a task is completed we will notify you by GET request sent to the URL you have specified

            you 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=$id

            http://your-server.com/pingscript?id=$id&tag=$tag

            Note: special characters in pingback_url will be urlencoded;

            i.a., the # character will be encoded into %23

            learn more on our Help Center'
          nullable: true
        search_partners:
          type: boolean
          description: 'Bing search partners type

            optional field

            if you specify true, 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.

            default value: false – results are returned for Bing, AOL, and Yahoo search networks'
          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:
      - location_name: United States
        language_name: English
        keywords:
        - average page rpm adsense
        - adsense blank ads how long
        - leads and prospects
    KeywordsDataGoogleAdsKeywordsForKeywordsTaskPostTaskInfo:
      type: object
      allOf:
      - $ref: '#/components/schemas/BaseResponseTaskInfo'
      - type: object
        properties:
          result:
            type: object
            description: 'array of results

              in this case, the value will be null'
            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: array of tasks
            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: array of tasks
            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: array of results
            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: array of results
            nullable: true
    KeywordsDataBingAudienceEstimationTasksReadyResultInfo:
      type: object
      properties:
        id:
          type: string
          description: 'task identifier of the completed task

            unique task identifier in our system in the UUID format'
          nullable: true
        se:
          type: string
          description: search engine specified when setting the task
          nullable: true
        se_type:
          type: string
          nullable: true
        date_posted:
          type: string
          description: date when the task was posted (in the UTC format)
          nullable: true
        tag:
          type: string
          description: user-defined task identifier
          nullable: true
        endpoint:
          type: string
          description: URL for collecting the results of the task
          nullable: true
    DataforseoTrendsGraphDataTrendsGraphDataInfo:
      type: object
      properties:
        date_from:
          type: string
          description: 'start date of the corresponding time range

            in the UTC format: “yyyy-mm-dd”'
          nullable: true
        date_to:
          type: string
          description: 'end date of the corresponding time range

            in the UTC format: “yyyy-mm-dd”'
          nullable: true
        timestamp:
          type: integer
          description: a point in time in the Unix time format
          nullable: true
        values:
          type: array
          items:
            type: integer
            nullable: true
          description: 'relative keyword popularity rate at a specific timestamp

            represents the keyword popularity rate over the given time range

            if you specify more than one keyword, the values will be averaged to the highest value across all specified keywords

            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
    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: array of results
            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: array of tasks
            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: array of results
            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: array of tasks
            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: array of tasks
            nullable: true
    KeywordsDataBingSearchVolumeHistoryTaskGetResultInfo:
      type: object
      properties:
        keyword:
          type: string
          description: keyword in a POST array
          nullable: true
        location_code:
          type: integer
          description: 'location code in a POST array

            if there is no data, then the value is null'
          nullable: true
        language_code:
          type: string
          description: 'language code in a POST array

            if there is no data, then the value is null'
          nullable: true
        device:
          type: array
          items:
            type: string
            nullable: true
          nullable: true
        period:
          type: string
          description: 'time period

            indicates if returned data is aggregated to a certain time period

            default value monthly'
          nullable: true
        searches:
          type: object
          oneOf:
          - $ref: '#/components/schemas/SearchVolumeHistorySearchInfo'
          description: 'contains results distributed by device type

            if the device parameter is not specified, the data will be returned for all available device types'
          nullable: true
    KeywordsDataClickstreamDataGlobalSearchVolumeLiveItem:
      type: object
      properties:
        keyword:
          type: string
          description: 'keyword

            keyword is returned with decoded %## (plus symbol ‘+’ will be decoded to a space character)'
          nullable: true
        search_volume:
          type: integer
          description: 'clickstream-based average monthly search volume rate

            represents the (approximate) number of searches for the given keyword idea based on clickstream

            you can learn more about clickstream search volume in this Help Center article'
          format: int64
          nullable: true
        country_distribution:
          type: array
          items:
            type: object
            oneOf:
            - $ref: '#/components/schemas/CountryDistribution'
            nullable: true
          description: 'distribution of clickstream by countries

            represents clickstream-based search volume in available countries, as well as its respective percentage of global search volume'
          nullable: true
    KeywordsDataClickstreamDataLocationsAndLanguagesResultInfo:
      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_code_parent:
          type: string
          description: 'the code of the superordinate location

            the value will be null as Country is the only supported location_type for this API'
          nullable: true
        country_iso_code:
          type: string
          description: ISO country code of the location
          nullable: true
        location_type:
          type: string
          description: 'location type

            possible values:

            Country'
          nullable: true
        available_languages:
          type: array
          items:
            type: object
            oneOf:
            - $ref: '#/components/schemas/AvailableLanguages'
            nullable: true
          description: 'supported languages

            contains the languages which are supported for a specific location'
          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
    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: array of tasks
            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: array of tasks
            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: array of results
            nullable: true
    KeywordsDataClickstreamDataSearchVolumeLiveItem:
      type: object
      properties:
        keyword:
          type: string
          description: keyword provided in the POST array
          nullable: true
        search_volume:
          type: integer
          description: current search volume rate of a keyword
          format: int64
          nullable: true
        monthly_searches:
          type: array
          items:
            type: object
            oneOf:
            - $ref: '#/components/schemas/MonthlySearchesInfo'
            nullable: true
          description: 'monthly search volume rates

            array of objects with search volume rates in a certain month of a year'
          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: array of tasks
            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: array of results
            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: array of tasks
            nullable: true
    KeywordsDataGoogleAdsLocationsResultInfo:
      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_code_parent:
          type: integer
          description: 'the code of the superordinate location

            example:

            "location_code": 9041134,

            "location_name": "Vienna International Airport,Lower Austria,Austria",

            "location_code_parent": 20044

            where location_code_parent corresponds to:

            "location_code": 20044,

            "location_name": "Lower Austria,Austria"'
          nullable: true
        country_iso_code:
          type: string
          description: ISO country code of the location
          nullable: true
        location_type:
          type: string
          description: 'location type

            possible values according to Google’s target types'
          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: array of results
            nullable: true
    KeywordsDataBingAudienceEstimationLiveResultInfo:
      type: object
      properties:
        est_impressions:
          type: object
          oneOf:
          - $ref: '#/components/schemas/AudienceEstimationInfo'
          description: monthly estimated impressions range
          nullable: true
        est_audience_size:
          type: object
          oneOf:
          - $ref: '#/components/schemas/AudienceEstimationInfo'
          description: monthly estimated reach user count range
          nullable: true
        est_clicks:
          type: object
          oneOf:
          - $ref: '#/components/schemas/AudienceEstimationInfo'
          description: monthly estimated click count range
          nullable: true
        est_spend:
          type: object
          oneOf:
          - $ref: '#/components/schemas/AudienceEstimationInfo'
          description: monthly estimated spending range
          nullable: true
        est_cost_per_event:
          type: object
          oneOf:
          - $ref: '#/components/schemas/AudienceEstimationInfo'
          description: indicates the estimated cost per event with range result
          nullable: true
        est_ctr:
          type: object
          oneOf:
          - $ref: '#/components/schemas/AudienceEstimationInfo'
          description: estimated click-through rate range
          nullable: true
        suggested_bid:
          type: number
          description: suggested bid value under the current targeting
          nullable: true
        suggested_budget:
          type: number
          description: suggested daily budget value under the current targeting and bid
          format: double
          nullable: true
        events_lost_to_bid:
          type: integer
          description: indicates event lost count due to insufficient input bid
          format: int64
          nullable: true
        events_lost_to_budget:
          type: integer
          description: indicates the event lost count due to insufficient input budget
          nullable: true
        est_reach_audience_size:
          type: integer
          description: monthly estimated user count
          format: int64
          nullable: true
        est_reach_impressions:
          type: integer
          description: monthly estimated impressions
          format: int64
          nullable: true
        currency:
          type: string
          description: 'currency name

            example: USDollar'
          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: array of tasks
            nullable: true
    AudienceEstimationInfo:
      type: object
      properties:
        high:
          type: number
          description: indicates the upper bound of the range result
          format: double
          nullable: true
        low:
          type: number
          description: indicates the lower bound of the range result
          format: double
          nullable: true
    KeywordsDataClickstreamDataGlobalSearchVolumeLiveRequestInfo:
      type: object
      properties:
        keywords:
          type: array
          items:
            type: string
          description: 'target keywords

            required field

            UTF-8 encoding

            maximum number of keywords you can specify in this array: 1000;

            each keyword should be at least 3 characters long;

            the keywords will be converted to lowercase format;

            Note: certain symbols and characters (e.g., UTF symbols, emojis) are not allowed

            to learn more about which symbols and characters can be used, please refer to this article

            learn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article'
        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:
      - tag: test-tag
        keywords:
        - you tube
        - youtube
        - youtub
    KeywordsDataBingAudienceEstimationTaskPostTaskInfo:
      type: object
      allOf:
      - $ref: '#/components/schemas/BaseResponseTaskInfo'
      - type: object
        properties:
          result:
            type: object
            description: 'array of results

              in this case, the value will be null'
            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: array of results
            nullable: true
    KeywordsDataDataforseoTrendsLocationsResultInfo:
      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_code_parent:
          type: integer
          description: 'the code of the superordinate location

            example:

            "location_code": 9041134,

            "location_name": "Vienna International Airport,Lower Austria,Austria",

            "location_code_parent": 20044

            where location_code_parent corresponds to:

            "location_code": 20044,

            "location_name": "Lower Austria,Austria"'
          nullable: true
        country_iso_code:
          type: string
          description: ISO country code of the location
          nullable: true
        location_type:
          type: string
          description: 'location type

            possible values according to Google’s target types'
          nullable: true
        geo_id:
          type: string
          description: 'DataForSEO trends location identifier

            you can use this field for matching obtained results with the location_code parameter specified in the request'
          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: array of tasks
            nullable: true
    KeywordsDataGoogleTrendsCategoriesResultInfo:
      type: object
      properties:
        category_code:
          type: integer
          description: unique google trends category identifier
          nullable: true
        category_name:
          type: string
          description: name of the google trends category
          nullable: true
        category_code_parent:
          type: integer
          description: 'the code of the superordinate category

            example:

            "category_code": 1100,

            "category_name": "Superhero Films",

            "category_code_parent": 1097

            where category_code_parent corresponds to:

            "category_code": 1097,

            "category_name": "Action & Adventure Films"'
          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: array of tasks
            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: array of results
            nullable: true
    KeywordsDataDataforseoTrendsMergedDataLiveResultInfo:
      type: object
      properties:
        keywords:
          type: array
          items:
            type: string
            nullable: true
          description: keywords in a POST array
          nullable: true
        type:
          type: string
          description: type of element
          nullable: true
        location_code:
          type: integer
          description: 'location code in a POST array

            if there is no data, then the value is null'
          nullable: true
        language_code:
          type: string
          description: 'language code in a POST array

            if there is no data, then the value is null'
          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
        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/BaseKeywordDataDataforseoTrendsItem'
            nullable: true
          description: 'keyword popularity values per location

            values in this array represent percentages relative to the maximum value within each region'
          nullable: true
    KeywordsDataBingKeywordPerformanceTasksReadyResultInfo:
      type: object
      properties:
        id:
          type: string
          description: 'task identifier of the completed task

            unique task identifier in our system in the UUID format'
          nullable: true
        se:
          type: string
          description: search engine specified when setting the task
          nullable: true
        se_type:
          type: string
          nullable: true
        date_posted:
          type: string
          description: date when the task was posted (in the UTC format)
          nullable: true
        tag:
          type: string
          description: user-defined task identifier
          nullable: true
        endpoint:
          type: string
          description: URL for collecting the results of the task
          nullable: true
        function:
          type: string
          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: array of tasks
            nullable: true
    KeywordsDataBingKeywordPerformanceLocationsAndLanguagesResultInfo:
      type: object
      properties:
        language_name:
          type: string
          description: language name
          nullable: true
        language_code:
          type: string
          description: language code
          nullable: true
        available_locations:
          type: array
          items:
            type: object
            oneOf:
            - $ref: '#/components/schemas/AvailableLocations'
            nullable: true
          description: 'supported locations

            contains locations supported in combination with a specific language'
          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: array of results
            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: array of tasks
            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: array of results
            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: array of results
            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: array of results
            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: array of results
            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: array of results
            nullable: true
    BaseKeywordDataGoogleTrendsItem:
      type: object
      properties:
        type:
          type: string
          description: type of element
          nullable: true
        position:
          type: integer
          description: 'the alignment of the element in Google Trends

            can take the following values: 1, 2, 3, 4, etc.'
          nullable: true
        title:
          type: string
          description: title of the element in Google Trends
          nullable: true
        keywords:
          type: array
          items:
            type: string
            nullable: true
          description: 'relevant keywords

            the data included in the google_trends_graph 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'
    KeywordsDataClickstreamDataDataforseoSearchVolumeLiveResultInfo:
      type: object
      properties:
        location_code:
          type: integer
          description: 'location code in a POST array

            if there is no data, then the value is null'
          nullable: true
        language_code:
          type: string
          description: 'language code in a POST array


            Note:if the keyword in the POST array appears to be misspelled, data will be returned for the correctly spelled keyword;

            we use the functionality of Google Ads API to check and validate the spelling of keywords, learn more by this link'
          nullable: true
        use_clickstream:
          type: boolean
          description: 'indicates if the use_clickstream parameter is active

            possible values: true, false'
          nullable: true
        items_count:
          type: integer
          description: ithe number of results returned in the items array
          nullable: true
        items:
          type: array
          items:
            type: object
            oneOf:
            - $ref: '#/components/schemas/KeywordsDataClickstreamDataSearchVolumeLiveItem'
            nullable: true
          description: 'array of keywords

            contains keywords and their search volume rates'
          nullable: true
    KeywordsDataGoogleAdsKeywordsForSiteTaskGetResultInfo:
      type: object
      properties:
        keyword:
          type: string
          description: keyword in a POST array
          nullable: true
        spell:
          type: string
          nullable: true
        location_code:
          type: integer
          description: 'location code in a POST array

            if there is no data, the value is null'
          nullable: true
        language_code:
          type: string
          description: 'language code in a POST array

            if there is no data, the value is null'
          nullable: true
        search_partners:
          type: boolean
          description: 'include Google search partners

            the value you specified when setting the task

            if true, the results are returned for owned, operated, and syndicated networks across Google and partner sites that host Google search;

            if false, the results are returned for Google search sites only'
          nullable: true
        competition:
          type: string
          description: 'competition

            represents the relative level of competition associated with the given keyword in paid SERP only

            possible values: LOW, MEDIUM, HIGH

            if competition level is unknown, the value is null;

            learn more about the metric in this help center article'
          nullable: true
        competition_index:
          type: integer
          description: 'competition index

            the competition index for the query indicating how competitive ad placement is for the keyword

            can take values from 0 to 100

            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

            if not enough data is available, the value is null;

            learn more about the metric in this help center article'
          nullable: true
        search_volume:
          type: integer
          description: 'monthly average search volume rate

            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

            if there is no data, the value is null'
          format: int64
          nullable: true
        low_top_of_page_bid:
          type: number
          description: 'minimum bid for the ad to be displayed at the top of the first page

            indicates the value greater than about 20% of the lowest bids for which ads were displayed (based on Google Ads statistics for advertisers)

            the value may differ depending on the location specified in a POST request'
          nullable: true
        high_top_of_page_bid:
          type: number
          description: 'maximum bid for the ad to be displayed at the top of the first page

            indicates the value greater than about 80% of the lowest bids for which ads were displayed (based on Google Ads statistics for advertisers)

            the value may differ depending on the location specified in a POST request'
          nullable: true
        cpc:
          type: number
          description: 'cost per click

            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: 'monthly searches

            represents the (approximate) number of searches on this keyword idea (as available for the past twelve months), targeted to the specified geographic locations

            if there is no data, the value is null'
          nullable: true
    KeywordsDataGoogleTrendsLanguagesResultInfo:
      type: object
      properties:
        language_name:
          type: string
          description: language name
          nullable: true
        language_code:
          type: string
          description: language code according to ISO 639-1
          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: array of tasks
            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: array of tasks
            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: array of results
            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: array of tasks
            nullable: true
    KeywordsDataBingSearchVolumeLiveRequestInfo:
      type: object
      properties:
        keywords:
          type: array
          items:
            type: string
          description: 'keywords

            required field

            The maximum number of keywords you can specify: 1000

            The maximum number of characters for each keyword: 100

            the specified keywords will be converted to lowercase, data will be provided in a separate array

            learn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article'
        location_name:
          type: string
          description: 'full name of search engine location

            required field if you don’t specify location_code or location_coordinate

            if you use this field, you don’t need to specify location_code or location_coordinate

            you 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/keywords_data/bing/locations

            example:

            London,England,United Kingdom'
          nullable: true
        location_code:
          type: integer
          description: 'search engine location code

            required field if you don’t specify location_name or location_coordinate

            if you use this field, you don’t need to specify location_name or location_coordinate

            you can receive the list of available locations of the search engines with their location_code by making a separate request to https://api.dataforseo.com/v3/keywords_data/bing/locations

            example:

            2840'
          nullable: true
        location_coordinate:
          type: string
          description: 'GPS coordinates of a location

            required field if you don’t specify location_name or location_code

            if you use this field, you don’t need to specify location_name or location_code

            location_coordinate parameter should be specified in the “latitude,longitude” format

            the data will be provided for the country the specified coordinates belong to

            example:

            52.6178549,-155.352142'
          nullable: true
        language_name:
          type: string
          description: 'full name of search engine language

            required field if you don’t specify language_code

            if you use this field, you don’t need to specify language_code

            supported languages:

            English, French, German'
          nullable: true
        language_code:
          type: string
          description: 'search engine language code

            required field if you don’t specify language_name

            if you use this field, you don’t need to specify language_name

            supported languages:

            en, fr, de'
          nullable: true
        device:
          type: string
          description: 'device type

            optional field

            specify this field if you want to get the data for a particular device type;

            possible values: all, mobile, desktop, tablet

            default value: all'
          nullable: true
        sort_by:
          type: string
          description: 'results sorting parameters

            optional field

            Use these parameters to sort the results by search_volume, cpc, competition or relevance in the descending order

            default value: relevance'
          nullable: true
        date_from:
          type: string
          description: 'starting date of the time range

            optional field

            minimal value: 24 months from today’s date

            if you don’t specify this field, data will be provided for the last 12 months

            minimum value: two years back from today’s date

            date format: "yyyy-mm-dd"

            example:

            "2020-01-01"

            Note: we do not recommend using a custom time range for the past year’s dates'
          nullable: true
        date_to:
          type: string
          description: 'ending date of the time range

            optional field

            if you don’t specify this field, data will be provided for the last 12 months;

            minimum value: two years back from today’s date;

            maximum value: one month from today’s date;

            note: we do not recommend using a custom time range for the past year’s dates;

            date format: "yyyy-mm-dd"

            example:

            "2020-03-15"

            Note: we do not recommend using a custom time range for the past year’s dates'
          nullable: true
        search_partners:
          type: boolean
          description: 'Bing search partners type

            optional field

            if you specify true, 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.

            default value: false – results are returned for Bing, AOL, and Yahoo search networks'
          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:
      - location_name: United States
        language_code: en
        keywords:
        - tom and jerry
        - silicon valley
        - spider man
    KeywordsDataBingSearchVolumeTaskPostTaskInfo:
      type: object
      allOf:
      - $ref: '#/components/schemas/BaseResponseTaskInfo'
      - type: object
        properties:
          result:
            type: object
            description: 'array of results

              in this case, the value will be null'
            nullable: true
    KeywordsDataGoogleTrendsLocationsCountryResultInfo:
      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_code_parent:
          type: integer
          description: 'the code of the superordinate location

            example:

            "location_code": 9041134,

            "location_name": "Vienna International Airport,Lower Austria,Austria",

            "location_code_parent": 20044

            where location_code_parent corresponds to:

            "location_code": 20044,

            "location_name": "Lower Austria,Austria"'
          nullable: true
        country_iso_code:
          type: string
          description: ISO country code of the location
          nullable: true
        location_type:
          type: string
          description: 'location type

            possible values according to Google’s target types'
          nullable: true
        geo_id:
          type: string
          description: 'google trends location identifier

            you can use this field for matching obtained results with the location_code parameter specified in the request'
          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: array of results
            nullable: true
    DataforseoTrendsDataInfo:
      type: object
      properties:
        keyword:
          type: string
          description: relevant keyword for which demographic data is provided
          nullable: true
        values:
          type: array
          items:
            type: object
            oneOf:
            - $ref: '#/components/schemas/DemographyItemValueInfo'
            nullable: true
          description: contains age range and corresponding keyword popularity values
          nullable: true
    SearchVolumeHistorySearchInfo:
      type: object
      properties:
        desktop:
          type: array
          items:
            type: object
            oneOf:
            - $ref: '#/components/schemas/SearchVolumeHistoryItemInfo'
            nullable: true
          description: 'device type = desktop

            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: 'device type = non-smartphones

            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: 'device type = mobile

            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: 'device type = tablet

            contains historical search volume data for searches made from tablets'
          nullable: true
    KeywordsDataBingKeywordsForSiteLiveResultInfo:
      type: object
      properties:
        keyword:
          type: string
          description: keyword 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
        search_partners:
          type: boolean
          description: indicates whether data from partner networks included in the response
          nullable: true
        device:
          type: string
          description: 'device type in a POST array

            if there is no data, then the value is null'
          nullable: true
        competition:
          type: number
          description: 'competition

            represents the relative amount of competition associated with the given keyword in paid SERP only. This value is based on Bing Ads data.

            Possible values: 0.1, 0.5,0.90.1 – low competition,

            0.5 – medium competition,

            0.9 – high competition;

            if there is no data the value is null'
          nullable: true
        cpc:
          type: number
          description: 'cost-per-click

            represents the average cost per click (USD) historically paid for the keyword.

            if there is no data, then the value is null'
          nullable: true
        search_volume:
          type: integer
          description: 'monthly average search volume rate

            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 null'
          format: int64
          nullable: true
        categories:
          type: array
          items:
            type: string
            nullable: true
          description: 'product and service categories

            legacy field, the value will always be null'
          nullable: true
        monthly_searches:
          type: array
          items:
            type: object
            oneOf:
            - $ref: '#/components/schemas/MonthlySearchesInfo'
            nullable: true
          description: 'monthly searches

            represents the (approximate) number of searches on this keyword (as available for the past twelve months), targeted to the specified geographic locations.

            if there is no data, then the value is null'
          nullable: true
    KeywordsDataBingLanguagesResultInfo:
      type: object
      properties:
        language_name:
          type: string
          description: language name
          nullable: true
        language_code:
          type: string
          description: language code according to ISO 639-1
          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: array of results
            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: array of results
            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: array of tasks
            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: array of tasks
            nullable: true
    KeywordsDataIdListRequestInfo:
      type: object
      properties:
        datetime_from:
          type: string
          description: 'start time for filtering results

            required field

            if include_metadata is set to true, maximum value: a month from current datetime;

            if include_metadata is set to false, maximum value: six months from current datetime;

            must be specified in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”

            example:

            2023-01-15 12:57:46 +00:00'
        datetime_to:
          type: string
          description: 'finish time for filtering results

            required field

            maximum value: current datetime;

            must be specified in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”

            example:

            2023-01-31 13:57:46 +00:00'
        limit:
          type: integer
          description: 'the maximum number of returned task IDs

            optional field

            default value: 1000

            maximum value: 1000'
          nullable: true
        offset:
          type: integer
          description: 'offset in the results array of returned task IDs

            optional field

            default value: 0

            if you specify the 10 value, the first ten tasks in the results array will be omitted'
          nullable: true
        sort:
          type: string
          description: 'sorting by task execution time

            optional field

            possible values: "asc", "desc"

            default value: "asc"'
          nullable: true
        include_metadata:
          type: boolean
          description: 'include task metadata in the respond

            optional field

            default value: false'
          nullable: true
      example:
      - datetime_from: '2026-04-12 04:39:39 +00:00'
        datetime_to: '2026-04-14 04:39:39 +00:00'
        limit: 100
        offset: 0
        sort: desc
        include_metadata: true
    KeywordsDataGoogleTrendsExploreTaskPostTaskInfo:
      type: object
      allOf:
      - $ref: '#/components/schemas/BaseResponseTaskInfo'
      - type: object
        properties:
          result:
            type: object
            description: 'array of results

              in this case, the value will be null'
            nullable: true
    KeywordsDataBingKeywordsForKeywordsLiveResultInfo:
      type: object
      properties:
        keyword:
          type: string
          description: keyword in a POST array
          nullable: true
        location_code:
          type: integer
          description: 'location code in a POST array

            if there is no data, then the value is null'
          nullable: true
        language_code:
          type: string
          description: 'language code in a POST array

            if there is no data, then the value is null'
          nullable: true
        search_partners:
          type: boolean
          description: indicates whether data from partner networks is included in the response
          nullable: true
        device:
          type: string
          description: 'device type

            indicates for what device type the data is provided;

            possible values: all, mobile, desktop, tablet'
          nullable: true
        competition:
          type: number
          description: 'competition

            represents the relative amount of competition associated with the given keyword in paid SERP only. This value is based on Bing Ads data.

            Possible values: 0.1, 0.5,0.90.1 – low competition,

            0.5 – medium competition,

            0.9 – high competition;

            if there is no data the value is null'
          nullable: true
        cpc:
          type: number
          description: 'cost-per-click

            represents the average cost per click (USD) historically paid for the keyword.

            if there is no data, then the value is null'
          nullable: true
        search_volume:
          type: integer
          description: 'monthly average search volume rate

            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

            if there is no data, then the value is null'
          format: int64
          nullable: true
        categories:
          type: array
          items:
            type: string
            nullable: true
          description: 'product and service categories

            legacy field, the value will always be null'
          nullable: true
        monthly_searches:
          type: array
          items:
            type: object
            oneOf:
            - $ref: '#/components/schemas/MonthlySearchesInfo'
            nullable: true
          description: 'monthly searches

            represents the (approximate) number of searches on this keyword (as available for the past twelve months), targeted to the specified geographic locations.

            if there is no data, then the value is null'
          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: array of results
            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: array of results
            nullable: true
    KeywordsDataDataforseoTrendsDemographyLiveResultInfo:
      type: object
      properties:
        keywords:
          type: array
          items:
            type: string
            nullable: true
          description: keywords in a POST array
          nullable: true
        type:
          type: string
          description: type of element
          nullable: true
        location_code:
          type: integer
          description: 'location code in a POST array

            if there is no data, then the value is null'
          nullable: true
        language_code:
          type: string
          description: 'language code in a POST array

            if there is no data, then the value is null'
          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
        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/DataforseoTrendsDemographyElementItem'
            nullable: true
          description: contains keyword popularity and related data
          nullable: true
    SearchVolumeHistoryItemInfo:
      type: object
      properties:
        year:
          type: integer
          description: year
          nullable: true
        month:
          type: integer
          description: month
          nullable: true
        day:
          type: integer
          description: day of the month
          nullable: true
        search_volume:
          type: integer
          description: search volume rate
          format: int64
          nullable: true
      description: 'device type = desktop

        contains historical search volume data for searches made from desktop devices'
    KeywordsDataBingKeywordsForSiteTaskGetResultInfo:
      type: object
      properties:
        keyword:
          type: string
          description: keyword in a POST array
          nullable: true
        location_code:
          type: integer
          description: 'location code in a POST array

            if there is no data the value is null'
          nullable: true
        language_code:
          type: string
          description: 'language code in a POST array

            if there is no data the value is null'
          nullable: true
        search_partners:
          type: boolean
          description: indicates whether data from partner networks included in the response
          nullable: true
        device:
          type: string
          description: 'device type in a POST array

            if there is no data, then the value is null'
          nullable: true
        competition:
          type: number
          description: "competition\nrepresents the relative amount of competition associated with the given keyword in paid SERP only. This value is based on Bing Ads data.\nPossible values: 0.1, 0.5,0.9 \n0.1 – low competition,\n0.5 – medium competition,\n0.9 – high competition;\nif there is no data the value is null"
          nullable: true
        cpc:
          type: number
          description: 'cost-per-click

            represents the average cost per click (USD) historically paid for the keyword.

            if there is no data the value is null'
          nullable: true
        search_volume:
          type: integer
          description: 'monthly average search volume rate

            represents the (approximate) number of searches for the given keyword idea on Bing search engine depending on the user’s targeting

            if there is no data then the value is null'
          format: int64
          nullable: true
        categories:
          type: array
          items:
            type: string
            nullable: true
          description: 'product and service categories

            legacy field, the value will always be null'
          nullable: true
        monthly_searches:
          type: array
          items:
            type: object
            oneOf:
            - $ref: '#/components/schemas/MonthlySearchesInfo'
            nullable: true
          description: 'monthly searches

            represents the (approximate) number of searches on this keyword idea (as available for the past twelve months), targeted to the specified geographic locations

            search volume is rounded to the closest decimal values

            if there is no data the value is null'
          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: array of results
            nullable: true
    KeywordsDataGoogleTrendsExploreTaskGetResultInfo:
      type: object
      properties:
        keywords:
          type: array
          items:
            type: string
            nullable: true
          description: keywords in a POST array
          nullable: true
        type:
          type: string
          description: type of element
          nullable: true
        location_code:
          type: integer
          description: 'location code in a POST array

            if there is no data, then the value is null'
          nullable: true
        language_code:
          type: string
          description: 'language code in a POST array

            if there is no data, then the value is null'
          nullable: true
        check_url:
          type: string
          description: 'direct URL to the Google Trends 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
        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/BaseKeywordDataGoogleTrendsItem'
            nullable: true
          description: items on the Google Trends page
          nullable: true
    KeywordsDataGoogleAdsKeywordsForSiteTaskPostRequestInfo:
      type: object
      properties:
        target:
          type: string
          description: 'domain or page

            required field

            the domain name of the target website or the url of the target page;

            note: to obtain keywords for the target website, use the target_type parameter'
        target_type:
          type: string
          description: 'search keywords for site or url

            optional field

            possible values: site, page;

            default value: page

            if set to site, keywords will be provided for the entire site;

            if set to page, keywords will be provided for the specified webpage'
          nullable: true
        location_name:
          type: string
          description: 'full name of search engine location

            optional field

            if you do not indicate the location, you will receive worldwide results, i.e., for all available locations;

            if you use this field, you don’t need to specify location_code or location_coordinate

            you 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/keywords_data/google_ads/locations

            example:

            London,England,United Kingdom'
          nullable: true
        location_code:
          type: integer
          description: 'search engine location code

            optional field

            if you do not indicate the location, you will receive worldwide results, i.e., for all available locations;

            if you use this field, you don’t need to specify location_name or location_coordinate;

            you can receive the list of available locations of the search engines with their location_code by making a separate request to https://api.dataforseo.com/v3/keywords_data/google_ads/locations

            example:

            2840'
          nullable: true
        location_coordinate:
          type: string
          description: 'GPS coordinates of a location

            optional field

            if you do not indicate the location, you will receive worldwide results, i.e., for all available locations;

            if you use this field, you don’t need to specify location_name or location_code;

            location_coordinate parameter should be specified in the “latitude,longitude” format;

            the data will be provided for the country the specified coordinates belong to;

            example:

            52.6178549,-155.352142'
          nullable: true
        language_name:
          type: string
          description: 'full name of search engine language

            optional field

            you can receive the list of available languages of the search engine with their language_name by making a separate request to https://api.dataforseo.com/v3/keywords_data/google_ads/languages

            example:

            English'
          nullable: true
        language_code:
          type: string
          description: 'search engine language code

            optional field

            you can receive the list of available languages of the search engine with their language_code by making a separate request to https://api.dataforseo.com/v3/keywords_data/google_ads/languages

            example:

            en'
          nullable: true
        search_partners:
          type: boolean
          description: 'include Google search partners

            optional field

            if you specify true, the results will be delivered for owned, operated, and syndicated networks across Google and partner sites that host Google search;

            default value: false – results are returned for Google search sites'
          nullable: true
        date_from:
          type: string
          description: 'starting date of the time range

            optional field

            date format: "yyyy-mm-dd"

            minimal value: 4 years from the current date

            by default, data is returned for the past 12 months;

            Note: the indicated date cannot be greater than that specified in date_to and/or yesterday’s date;if Status endpoint returns false in the actual_data field, date_from can be set to the month before last and prior;

            if Status endpoint returns true in the actual_data field, date_from can be set to the last month and prior'
          nullable: true
        date_to:
          type: string
          description: 'ending date of the time range

            optional field

            Note: the indicated date cannot be greater than yesterday’s date;

            if you don’t specify this field, yesterday’s date will be used by default

            date format: "yyyy-mm-dd"

            example:

            "2022-11-30"'
          nullable: true
        include_adult_keywords:
          type: boolean
          description: 'include keywords associated with adult content

            optional field

            if set to true, adult keywords will be included in the response

            default value: false

            note that the API may return no data for such keywords due to Google Ads restrictions'
          nullable: true
        sort_by:
          type: string
          description: 'results sorting parameters

            optional field

            Use these parameters to sort the results by relevance, search_volume, competition_index, low_top_of_page_bid, or high_top_of_page_bid in descending order

            default value: relevance'
          nullable: true
        postback_url:
          type: string
          description: 'URL for sending task results

            optional field

            once the task is completed, we will send a POST request with its results compressed in the gzip format to the postback_url you specified

            you 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=$id

            http://your-server.com/postbackscript?id=$id&tag=$tag

            Note: special characters in postback_url will be urlencoded;

            i.a., the # character will be encoded into %23

            learn more on our Help Center'
          nullable: true
        pingback_url:
          type: string
          description: 'notification URL of a completed task

            optional field

            when a task is completed we will notify you by GET request sent to the URL you have specified

            you 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=$id

            http://your-server.com/pingscript?id=$id&tag=$tag

            Note: special characters in pingback_url will be urlencoded;

            i.a., the # character will be encoded into %23

            learn more on our Help Center'
          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:
      - location_code: 2840
        target: dataforseo.com
    KeywordKpiItemInfo:
      type: object
      properties:
        ad_position:
          type: string
          description: 'represents the position of the relevant ad in SERP

            can take the following values:

            FirstPage1: The first ad to appear on the right side of the first search results page

            FirstPage2: The second ad to appear on the right side of the first search results page

            FirstPage3: The third ad to appear on the right side of the first search results page

            FirstPage4: The fourth ad to appear on the right side of the first search results page

            FirstPage5: The fifth ad to appear on the right side of the first search results page

            FirstPage6: The sixth ad to appear on the right side of the first search results page

            FirstPage7: The seventh ad to appear on the right side of the first search results page

            FirstPage8: The eighth ad to appear on the right side of the first search results page

            FirstPage9: The ninth ad to appear on the right side of the first search results page

            FirstPage10: The tenth ad to appear on the right side of the first search results page

            MainLine1: The first ad to appear at the top of the search results page

            MainLine2: The second ad to appear at the top of the search results page

            MainLine3: The third ad to appear at the top of the search results page

            MainLine4: The fourth ad to appear at the top of the search results page'
          nullable: true
        clicks:
          type: integer
          description: 'ad clicks

            the number of clicks that the keyword and match type generated during the last month'
          nullable: true
        impressions:
          type: integer
          description: 'ad impressions

            the number of impressions that the keyword and match type generated during the last month'
          nullable: true
        average_cpc:
          type: number
          description: 'average cost per click, USD

            calculated by dividing the cost of all clicks by the number of clicks'
          format: double
          nullable: true
        ctr:
          type: number
          description: 'click-through rate as a percentage

            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: 'total cost of an ad, USD

            the cost of using the specified keyword and match type during the last month'
          format: int64
          nullable: true
        average_bid:
          type: number
          description: average bid of the keyword
          format: double
          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: array of tasks
            nullable: true
    AvailableLocations:
      type: object
      properties:
        location_code:
          type: integer
          description: location code
          nullable: true
        location_name:
          type: string
          description: location name
          nullable: true
        country_iso_code:
          type: string
          description: ISO country code of the location
          nullable: true
        location_type:
          type: string
          description: 'location type

            possible values:

            Country, Region'
          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: array of results
            nullable: true
    KeywordsDataBingSearchVolumeTasksReadyResultInfo:
      type: object
      properties:
        id:
          type: string
          description: 'task identifier of the completed task

            unique task identifier in our system in the UUID format'
          nullable: true
        se:
          type: string
          description: search engine specified when setting the task
          nullable: true
        se_type:
          type: string
          nullable: true
        date_posted:
          type: string
          description: date when the task was posted (in the UTC format)
          nullable: true
        tag:
          type: string
          description: user-defined task identifier
          nullable: true
        endpoint:
          type: string
          description: URL for collecting the results of the task
          nullable: true
        function:
          type: string
          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: array of results
            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: array of tasks
            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: array of tasks
            nullable: true
    KeywordsDataGoogleTrendsExploreTasksReadyResultInfo:
      type: object
      properties:
        id:
          type: string
          description: 'task identifier of the completed task

            unique task identifier in our system in the UUID format'
          nullable: true
        se:
          type: string
          description: search engine specified when setting the task
          nullable: true
        se_type:
          type: string
          nullable: true
        date_posted:
          type: string
          description: date when the task was posted (in the UTC format)
          nullable: true
        tag:
          type: string
          description: user-defined task identifier
          nullable: true
        endpoint:
          type: string
          description: URL for collecting the results of the task
          nullable: true
    KeywordsDataBingSearchVolumeTaskGetResultInfo:
      type: object
      properties:
        keyword:
          type: string
          description: keyword 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
        search_partners:
          type: boolean
          description: indicates whether data from partner networks included in the response
          nullable: true
        device:
          type: string
          description: 'device type in a POST array

            if there is no data, then the value is null'
          nullable: true
        competition:
          type: number
          description: "competition\nrepresents the relative amount of competition associated with the given keyword in paid SERP only. This value is based on Bing Ads data.\nPossible values: 0.1, 0.5,0.9 \n0.1 – low competition,\n0.5 – medium competition,\n0.9 – high competition;\nif there is no data the value is null"
          nullable: true
        cpc:
          type: number
          description: 'cost-per-click

            represents the average cost per click (USD) historically paid for the keyword.

            if there is no data then the value is null'
          nullable: true
        search_volume:
          type: integer
          description: 'monthly average search volume rate

            search volume is rounded to the nearest tens'
          format: int64
          nullable: true
        categories:
          type: array
          items:
            type: string
            nullable: true
          description: 'product and service categories

            our API doesn’t return categories for this endpoint: the parameter will always equal null'
          nullable: true
        monthly_searches:
          type: array
          items:
            type: object
            oneOf:
            - $ref: '#/components/schemas/MonthlySearchesInfo'
            nullable: true
          description: 'monthly searches

            represents the (approximate) number of searches on this keyword idea (as available for the past twelve months), targeted to the specified geographic locations

            if there is no data then the value is null'
          nullable: true
    KeywordsDataClickstreamDataDataforseoSearchVolumeLiveRequestInfo:
      type: object
      properties:
        keywords:
          type: array
          items:
            type: string
          description: 'target keywords

            required field

            UTF-8 encoding

            maximum number of keywords you can specify in this array: 1000

            the keywords will be converted to lowercase format

            Note: certain symbols and characters (e.g., UTF symbols, emojis) are not allowed

            to learn more about which symbols and characters can be used, please refer to this article

            learn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article'
        location_name:
          type: string
          description: "full name of search engine location\nrequired field if you don’t specify location_code \nyou can receive the list of available locations with location_name by making a separate request to https://api.dataforseo.com/v3/keywords_data/clickstream_data/locations_and_languages\nexample:\nUnited Kingdom"
          nullable: true
        location_code:
          type: integer
          description: 'search engine location code

            required field if you don’t specify location_name

            if you use this field, you can receive the list of available locations with location_code by making a separate request to the https://api.dataforseo.com/v3/keywords_data/clickstream_data/locations_and_languages

            example:

            2826'
          nullable: true
        language_name:
          type: string
          description: 'full name of search engine language

            required field if don’t specify 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/keywords_data/clickstream_data/locations_and_languages

            example:

            English'
          nullable: true
        language_code:
          type: string
          description: 'search engine language code

            required field if don’t specify language_name

            you can receive the list of available languages with their language_code by making a separate request to the https://api.dataforseo.com/v3/keywords_data/clickstream_data/locations_and_languages

            example:

            en'
          nullable: true
        use_clickstream:
          type: boolean
          description: 'use clickstream data to provide results

            optional field

            if set to true, you will get DataForSEO search volume values based on clickstream data;

            if set to false, Bing search volume data will be used to calculate DataForSEO search volume;

            default value: true;

            Note: Bing search volume is available for locations provided in Bing Search Volume History Locations and Bing Ads Locations endpoints; search volume values for any other location are calculated based on clickstream data even if you set this parameter to false'
          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:
      - location_code: 2840
        language_code: en
        tag: test-tag
        keywords:
        - you tube
        - youtube
        - youtub
    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: array of tasks
            nullable: true
    KeywordsDataIdListResultInfo:
      type: object
      properties:
        id:
          type: string
          description: id of the task
          nullable: true
        url:
          type: string
          description: 'URL of the task

            URL you used for making an API call'
          nullable: true
        datetime_posted:
          type: string
          description: 'date and time when the task was made

            in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”

            example:

            2023-01-15 12:57:46 +00:00'
          nullable: true
        datetime_done:
          type: string
          description: 'date and time when the task was completed

            in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”

            example:

            2023-01-15 12:57:46 +00:00'
          nullable: true
        status:
          type: string
          description: 'informational message of the task

            you can find the full list of general informational messages here'
          nullable: true
        cost:
          type: number
          description: cost of the task, USD
          nullable: true
        metadata:
          type: object
          additionalProperties:
            type: object
            nullable: true
          description: contains parameters you specified in the POST request
          nullable: true
    KeywordsDataBingAudienceEstimationTaskPostRequestInfo:
      type: object
      properties:
        location_name:
          type: string
          description: 'full name of search engine location

            required field if you don’t specify location_code or location_coordinate

            if you use this field, you don’t need to specify location_code or location_coordinate

            you 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/keywords_data/bing/locations

            example:

            London,England,United Kingdom'
          nullable: true
        location_code:
          type: integer
          description: 'search engine location code

            required field if you don’t specify location_name or location_coordinate

            if you use this field, you don’t need to specify location_name or location_coordinate

            you can receive the list of available locations of the search engines with their location_code by making a separate request to https://api.dataforseo.com/v3/keywords_data/bing/locations

            example:

            2840'
          nullable: true
        location_coordinate:
          type: string
          description: 'GPS coordinates of a location

            required field if you don’t specify location_name or location_code

            if you use this field, you don’t need to specify location_name or location_code

            location_coordinate parameter should be specified in the “latitude,longitude,radius (in km)” format

            the data will be provided for the country the specified coordinates belong to

            example:

            29.6821525,-82.4098881,100'
          nullable: true
        age:
          type: array
          items:
            type: string
          description: 'selection of age ranges for targeting

            possible values: eighteen_to_twenty_four, fifty_to_sixty_four, sixty_five_and_above, thirteen_to_seventeen, thirty_five_to_forty_nine, twenty_five_to_thirty_four, unknown, zero_to_twelve'
          nullable: true
        bid:
          type: number
          description: 'desired bid setting value in USD

            maximum value: 1000'
          nullable: true
        daily_budget:
          type: number
          description: 'daily campaign budget value in USD

            maximum value: 10000'
          nullable: true
        gender:
          type: array
          items:
            type: string
          description: 'gender to target

            possible values: male, female, unknown'
          nullable: true
        industry:
          type: array
          items:
            type: string
          description: 'industry of LinkedIn profile targeting

            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

            example: 806301758'
          nullable: true
        job_function:
          type: array
          items:
            type: string
          description: 'job function of LinkedIn profile targeting

            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

            example: 806300451'
          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
    BaseKeywordDataDataforseoTrendsItem:
      type: object
      properties:
        type:
          type: string
          description: type of element
          nullable: true
        position:
          type: integer
          description: 'the alignment of the element

            can take the following values: 1, 2, 3, 4, etc.'
          nullable: true
        keywords:
          type: array
          items:
            type: string
            nullable: true
          description: 'relevant keywords

            the data included in the dataforseo_trends_graph element is based on the keywords listed in this array'
          nullable: true
      additionalProperties: false
      discriminator:
        propertyName: type
        mapping:
          dataforseo_trends_graph: '#/components/schemas/DataforseoTrendsDataforseoTrendsGraphElementItem'
          subregion_interests: '#/components/schemas/DataforseoTrendsSubregionInterestsElementItem'
          demography: '#/components/schemas/DataforseoTrendsDemographyElementItem'
    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: array of tasks
            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: array of tasks
            nullable: true
    KeywordsDataGoogleTrendsExploreLiveRequestInfo:
      type: object
      properties:
        keywords:
          type: array
          items:
            type: string
          description: 'keywords

            required field

            the maximum number of keywords you can specify: 5

            the maximum number of characters you can specify in a keyword: 100

            the minimum number of characters must be greater than 1

            comma characters (,) in the specified keywords will be unset and ignored

            Note: keywords cannot consist of a combination of the following characters: < > | \ " - + = ~ ! : * ( ) [ ] { }

            Note: to obtain google_trends_topics_list and google_trends_queries_list items, specify no more than 1 keyword

            learn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article'
        location_name:
          type: string
          description: 'full name of search engine location

            optional field

            if you don’t use this field, you will recieve global results

            if you use this field, you don’t need to specify location_code

            you can use this field as an array to set several locations, each corresponding to a specific keyword – learn more;

            you 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/keywords_data/google_trends/locations

            example:

            United Kingdom'
          nullable: true
        location_code:
          type: string
          description: 'search engine location code

            optional field

            if you don’t use this field, you will recieve global results

            if you use this field, you don’t need to specify location_name

            you can use this field as an array to set several locations, each corresponding to a specific keyword – learn more;

            you can receive the list of available locations of the search engines with their location_code by making a separate request to https://api.dataforseo.com/v3/keywords_data/google_trends/locations

            example:

            2840'
          nullable: true
        language_name:
          type: string
          description: 'full name of search engine language

            optional field

            default value: English

            if you use this field, you don’t need to specify language_code

            you can receive the list of available languages of the search engine with their language_name by making a separate request to https://api.dataforseo.com/v3/keywords_data/google_trends/languages

            example:

            English'
          nullable: true
        language_code:
          type: string
          description: 'search engine language code

            optional field

            default value: en

            if you use this field, you don’t need to specify language_name

            you can receive the list of available languages of the search engine with their language_code by making a separate request to https://api.dataforseo.com/v3/keywords_data/google_trends/languages

            example:

            en'
          nullable: true
        type:
          type: string
          description: type of element
          nullable: true
        category_code:
          type: integer
          description: 'google trends search category

            optional field

            if you don’t specify this field, the 0 value will be applied by default and the search will be carried out across all available categories

            you can receive the list of available categories with their category_code by making a separate request to the https://api.dataforseo.com/v3/keywords_data/google_trends/categories'
          nullable: true
        date_from:
          type: string
          description: 'starting date of the time range

            optional field

            if you don’t specify this field, the current day and month of the preceding year will be used by default

            minimal value for the web type: 2004-01-01

            minimal value for other types: 2008-01-01

            date format: "yyyy-mm-dd"

            example:

            "2019-01-15"'
          nullable: true
        date_to:
          type: string
          description: 'ending date of the time range

            optional field

            if you don’t specify this field, the today’s date will be used by default

            date format: "yyyy-mm-dd"

            example:

            "2019-01-15"'
          nullable: true
        time_range:
          type: string
          description: 'preset time ranges

            optional field

            if you specify date_from or date_to parameters, this field will be ignored when setting a task

            possible values for all type parameters:

            past_hour, past_4_hours, past_day, past_7_days, past_30_days, past_90_days, past_12_months, past_5_years

            possible values for web only:

            2004_present

            possible values for news, youtube, images, froogle:

            2008_present'
          nullable: true
        item_types:
          type: array
          items:
            type: string
          description: 'types of items returned

            optional field

            to speed up the execution of the request, specify one item at a time;

            possible values:

            "google_trends_graph", "google_trends_map", "google_trends_topics_list","google_trends_queries_list"

            default value:

            "google_trends_graph"

            Note: to obtain google_trends_topics_list and google_trends_queries_list items, specify no more than 1 keyword in the keywords field'
          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:
      - location_name: United States
        date_from: '2026-01-15'
        date_to: '2026-03-15'
        type: youtube
        category_code: 3
        keywords:
        - rugby
        - cricket
    KeywordsDataErrorsResultInfo:
      type: object
      properties:
        id:
          type: string
          description: id of the task
          nullable: true
        datetime:
          type: string
          description: 'date and time when an error occurred

            in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”

            example:

            2019-11-15 12:57:46 +00:00'
          nullable: true
        function:
          type: string
          description: corresponding API function
          nullable: true
        error_code:
          type: integer
          description: error code
          nullable: true
        error_message:
          type: string
          description: 'error message or error URL

            error message (see full list) or URL that caused an error'
          nullable: true
        http_url:
          type: string
          description: 'URL that caused an error

            URL you used for making an API call or pingback/postback URL'
          nullable: true
        http_method:
          type: string
          description: HTTP method
          nullable: true
        http_code:
          type: integer
          description: HTTP status code
          nullable: true
        http_time:
          type: number
          description: 'time taken by HTTP request

            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: 'HTTP response

            server response'
          nullable: true
    KeywordsDataBingAudienceEstimationJobFunctionsResultInfo:
      type: object
      properties:
        job_function_id:
          type: integer
          description: ID of the job function
          format: int64
          nullable: true
        job_function_name:
          type: string
          description: name of the job function
          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: array of results
            nullable: true
    InterestsComparison:
      type: object
      properties:
        items:
          type: array
          items:
            type: object
            oneOf:
            - $ref: '#/components/schemas/AbsoluteItems'
            nullable: true
          description: contains keyword popularity and related data
          nullable: true
        absolute_items:
          type: array
          items:
            type: object
            oneOf:
            - $ref: '#/components/schemas/AbsoluteItems'
            nullable: true
          description: 'keyword popularity rates across all locations

            values in this array represent percentages relative to the maximum value across all locations'
          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: array of results
            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: array of results
            nullable: true
    KeywordsDataGoogleAdsSearchVolumeTaskPostTaskInfo:
      type: object
      allOf:
      - $ref: '#/components/schemas/BaseResponseTaskInfo'
      - type: object
        properties:
          result:
            type: object
            description: 'array of results

              in this case, the value will be null'
            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: array of results
            nullable: true
    KeywordsDataClickstreamDataBulkSearchVolumeLiveResultInfo:
      type: object
      properties:
        location_code:
          type: integer
          description: location code in a POST array
          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/KeywordsDataClickstreamDataSearchVolumeLiveItem'
            nullable: true
          description: contains keywords and related data
          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: array of results
            nullable: true
    KeywordsDataBingSearchVolumeHistoryTaskPostRequestInfo:
      type: object
      properties:
        keywords:
          type: array
          items:
            type: string
          description: 'keywords

            required field

            The maximum number of keywords you can specify: 1000

            The maximum number of characters for each keyword: 100

            the specified keywords will be converted to lowercase, data will be provided in a separate array

            learn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article'
        location_name:
          type: string
          description: 'full name of search engine location

            required field if you don’t specify location_code or location_coordinate

            if you use this field, you don’t need to specify location_code or location_coordinate

            you 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/keywords_data/bing/search_volume_history/locations_and_languages

            example:

            London,England,United Kingdom'
          nullable: true
        location_code:
          type: integer
          description: 'search engine location code

            required field if you don’t specify location_name or location_coordinate

            if you use this field, you don’t need to specify location_name or location_coordinate

            you can receive the list of available locations of the search engines with their location_code by making a separate request to https://api.dataforseo.com/v3/keywords_data/bing/search_volume_history/locations_and_languages

            example:

            2840'
          nullable: true
        location_coordinate:
          type: string
          description: 'GPS coordinates of a location

            required field if you don’t specify location_name or location_code

            if you use this field, you don’t need to specify location_name or location_code

            location_coordinate parameter should be specified in the “latitude,longitude” format

            the data will be provided for the country the specified coordinates belong to

            example:

            52.6178549,-155.352142'
          nullable: true
        language_name:
          type: string
          description: 'full name of search engine language

            required field if you don’t specify language_code

            if you use this field, you don’t need to specify language_code

            you can receive the list of available languages of the search engines with their language_code by making a separate request to https://api.dataforseo.com/v3/keywords_data/bing/search_volume_history/locations_and_languages'
          nullable: true
        language_code:
          type: string
          description: 'search engine language code

            required field if you don’t specify language_name

            if you use this field, you don’t need to specify language_name

            you can receive the list of available languages of the search engines with their language_code by making a separate request to https://api.dataforseo.com/v3/keywords_data/bing/search_volume_history/locations_and_languages'
          nullable: true
        device:
          type: array
          items:
            type: string
          description: 'device types

            optional field

            specify this field if you want to get the data for a particular device types

            possible values: mobile, desktop, tablet, non_smartphones

            default value:  ["mobile", "desktop", "tablet", "non_smartphones"]'
          nullable: true
        period:
          type: string
          description: 'aggregates the returned data to a certain time period

            optional field

            specify this field if you want to get the data in monthly, weekly or daily format

            possible values: monthly, weekly, daily

            monthly – returns data up to past 24 months

            weekly – returns data up to past 15 weeks

            daily – returns data up to past 45 days

            default value:  monthly'
          nullable: true
        date_from:
          type: string
          description: 'starting date of the time range

            optional field

            minimum value: two years back from today’s date

            maximum value: one day from today’s date

            date format: "yyyy-mm-dd"

            example:

            "2020-01-01"

            Note: we do not recommend using a custom time range

            Note 2: if date_from and date_to parameters are not specified, the data will be returned for the past 24 months

            if you specify the period parameter:

            with value weekly, you will get results for the past 15 weeks

            with value daily, you will get results for the past 45 days'
          nullable: true
        date_to:
          type: string
          description: 'ending date of the time range

            optional field

            minimum value: two years back from today’s date;

            maximum value: one day from today’s date;

            date format: "yyyy-mm-dd"

            example:

            "2020-03-15"

            Note: we do not recommend using a custom time range

            Note 2: if date_from and date_to parameters are not specified, the data will be returned for the past 24 months

            if you specify the period parameter:

            with value weekly, you will get results for the past 15 weeks

            with value daily, you will get results for the past 45 days'
          nullable: true
        postback_url:
          type: string
          description: 'URL for sending task results

            optional field

            once the task is completed, we will send a POST request with its results compressed in the gzip format to the postback_url you specified

            you 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=$id

            http://your-server.com/postbackscript?id=$id&tag=$tag

            Note: special characters in postback_url will be urlencoded;

            i.a., the # character will be encoded into %23

            learn more on our Help Center'
          nullable: true
        pingback_url:
          type: string
          description: 'notification URL of a completed task

            optional field

            when a task is completed we will notify you by GET request sent to the URL you have specified

            you 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=$id

            http://your-server.com/pingscript?id=$id&tag=$tag

            Note: special characters in pingback_url will be urlencoded;

            i.a., the # character will be encoded into %23

            learn more on our Help Center'
          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:
      - location_code: 2840
        language_code: en
        keywords:
        - 10 minute timer
    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: array of tasks
            nullable: true
    AbsoluteItems:
      type: object
      properties:
        geo_id:
          type: string
          description: 'location identifier

            you can use this field for matching obtained results with location parameters specified in the request

            see the full list of available locations with their geo_id here or by making a separate request to https://api.dataforseo.com/v3/keywords_data/dataforseo_trends/locations

            example:

            US-NY'
          nullable: true
        geo_name:
          type: string
          description: 'location name

            you can use this field for matching obtained results with location parameters specified in the request

            see the full list of available locations with their geo_name here or by making a separate request to https://api.dataforseo.com/v3/keywords_data/dataforseo_trends/locations

            example:

            Andorra'
          nullable: true
        values:
          type: array
          items:
            type: string
            nullable: true
          description: 'keyword popularity rates within a given location

            represents location-specific keyword popularity rate over the specified time range;

            using these values, you can understand which of the specified keywords is more popular in the related location;

            the first value in the array is provided for the first term from the keywords array, the second value is provided for the second keyword, and so on;

            calculation: we determine the highest popularity value across all specified keywords within a given location, and then express the popularity values of each keyword as a percentage of the highest value (100);

            a value of 100 is the peak popularity for the term

            a value of 50 means that the term is half as popular

            a value of 0 means there was not enough data for this term'
          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: array of tasks
            nullable: true
    KeywordsDataGoogleAdsKeywordsForSiteTasksReadyResultInfo:
      type: object
      properties:
        id:
          type: string
          description: 'task identifier of the completed task

            unique task identifier in our system in the UUID format'
          nullable: true
        se:
          type: string
          description: search engine specified when setting the task
          nullable: true
        se_type:
          type: string
          nullable: true
        date_posted:
          type: string
          description: date when the task was posted (in the UTC format)
          nullable: true
        tag:
          type: string
          description: user-defined task identifier
          nullable: true
        endpoint:
          type: string
          description: URL for collecting the results of the task
          nullable: true
    KeywordsDataBingKeywordsForKeywordsLiveRequestInfo:
      type: object
      properties:
        keywords:
          type: array
          items:
            type: string
          description: 'keywords

            required field

            you can specify the maximum of 200 keywords with each keyword containing no more than 100 characters;

            the specified keywords will be converted to lowercase, data will be provided in a separate array

            learn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article'
        location_name:
          type: string
          description: 'full name of search engine location

            required field if you don’t specify location_code or location_coordinate

            if you use this field, you don’t need to specify location_code or location_coordinate

            you 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/keywords_data/bing/locations

            example:

            London,England,United Kingdom'
          nullable: true
        location_code:
          type: integer
          description: 'search engine location code

            required field if you don’t specify location_name or location_coordinate

            if you use this field, you don’t need to specify location_name or location_coordinate

            you can receive the list of available locations of the search engines with their location_code by making a separate request to https://api.dataforseo.com/v3/keywords_data/bing/locations

            example:

            2840'
          nullable: true
        location_coordinate:
          type: string
          description: 'GPS coordinates of a location

            required field if you don’t specify location_name or location_code

            if you use this field, you don’t need to specify location_name or location_code

            location_coordinate parameter should be specified in the “latitude,longitude” format

            the data will be provided for the country the specified coordinates belong to

            example:

            52.6178549,-155.352142'
          nullable: true
        language_name:
          type: string
          description: 'full name of search engine language

            required field if you don’t specify language_code

            if you use this field, you don’t need to specify language_code

            supported languages:

            English, French, German'
          nullable: true
        language_code:
          type: string
          description: 'search engine language code

            required field if you don’t specify language_name

            if you use this field, you don’t need to specify language_name

            supported languages:

            en, fr, de'
          nullable: true
        sort_by:
          type: string
          description: 'results sorting parameters

            optional field

            Use these parameters to sort the results by search_volume, cpc, competition or relevance in the descending order

            default value: relevance'
          nullable: true
        keywords_negative:
          type: array
          items:
            type: string
          description: 'keywords negative array

            optional field

            These keywords will be ignored in the results array;

            You can specify a maximum of 200 terms that you want to exclude from the results;

            the specified keywords will be converted to lowercase format'
          nullable: true
        device:
          type: string
          description: 'device type

            optional field

            specify this field if you want to get the data for a particular device type;

            possible values: all, mobile, desktop, tablet

            default value: all'
          nullable: true
        date_from:
          type: string
          description: 'starting date of the time range

            optional field

            minimal value: 24 months from today’s date;

            if you don’t specify this field, data will be provided for the last 12 months

            date format: "yyyy-mm-dd"

            example:

            "2020-01-01"

            Note: we do not recommend using a custom time range for the past year’s dates'
          nullable: true
        date_to:
          type: string
          description: 'ending date of the time range

            optional field

            if you don’t specify this field, data will be provided for the last 12 months;

            minimum value: two years back from today’s date;

            maximum value: one month from today’s date;

            date format: "yyyy-mm-dd"

            example:

            "2020-03-15"

            Note: we do not recommend using a custom time range for the past year’s dates'
          nullable: true
        search_partners:
          type: boolean
          description: 'Bing search partners type

            optional field

            if you specify true, 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.

            default value: false – results are returned for Bing, AOL, and Yahoo search networks'
          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:
      - location_name: United States
        language_name: English
        keywords:
        - average page rpm adsense
        - adsense blank ads how long
        - leads and prospects
    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: array of results
            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: array of results
            nullable: true
    KeywordsDataGoogleAdsAdTrafficByKeywordsLiveResultInfo:
      type: object
      properties:
        keyword:
          type: string
          description: keyword in a POST array
          nullable: true
        location_code:
          type: integer
          description: 'location code in a POST array

            if there is no data, then the value is null'
          nullable: true
        language_code:
          type: string
          description: 'language code in a POST array

            if there is no data, then the value is null'
          nullable: true
        date_interval:
          type: string
          description: forecasting date interval in a POST array
          nullable: true
        search_partners:
          type: boolean
          description: 'include Google search partners

            the value you specified when setting the task

            if true, the results are returned for owned, operated, and syndicated networks across Google and partner sites that host Google search;

            if false, the results are returned for Google search sites only'
          nullable: true
        bid:
          type: number
          description: 'the maximum custom bid

            the bid you have specified when setting the task

            represents the price you are willing to pay for an ad

            the higher value you have specified, the higher metrics and cost you receive in response

            learn more in this help center article'
          format: int64
          nullable: true
        match:
          type: string
          description: 'keywords match-type

            can take the following values: exact, broad, phrase'
          nullable: true
        impressions:
          type: integer
          description: 'projected number of ad impressions

            number of impressions an ad is projected to get within the specified time period

            if there is no data, then the value is null

            learn more about impressions in this help center article'
          nullable: true
        ctr:
          type: number
          description: 'projected click through rate (CTR) of the advertisement

            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

            if there is no data, then the value is null'
          format: double
          nullable: true
        average_cpc:
          type: number
          description: 'the average cost-per-click value

            represents the cost-per-click (USD) estimated for a keyword based on the specified time period and historical data;

            if there is no data, then the value is null'
          format: double
          nullable: true
        cost:
          type: number
          description: 'charge for an ad

            amount that will be charged for running an ad within the specified time period

            if there is no data, then the value is null'
          nullable: true
        clicks:
          type: number
          description: 'number of clicks on an ad

            number of clicks an ad is projected to get within the specified time period

            if there is no data, then the value is null'
          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: array of tasks
            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: array of results
            nullable: true
    KeywordsDataBingKeywordsForSiteTaskPostTaskInfo:
      type: object
      allOf:
      - $ref: '#/components/schemas/BaseResponseTaskInfo'
      - type: object
        properties:
          result:
            type: object
            description: 'array of results

              in this case, the value will be null'
            nullable: true
    KeywordsDataGoogleAdsKeywordsForKeywordsLiveRequestInfo:
      type: object
      properties:
        keywords:
          type: array
          items:
            type: string
          description: 'keywords

            required field

            The maximum number of keywords you can specify: 20

            The maximum number of characters for each keyword: 80

            the keywords you specify will be converted to a lowercase format

            Note: Google Ads may return no data for certain groups of keywords

            visit our Help Center to learn more

            Also note 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;

            to learn more about which symbols and characters can be used, please refer to this article

            learn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article'
        location_name:
          type: string
          description: 'full name of search engine location

            optional field

            if you do not indicate the location, you will receive worldwide results, i.e., for all available locations;

            if you use this field, you don’t need to specify location_code or location_coordinate

            you 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/keywords_data/google_ads/locations

            example:

            London,England,United Kingdom'
          nullable: true
        location_code:
          type: integer
          description: 'search engine location code

            optional field

            if you do not indicate the location, you will receive worldwide results, i.e., for all available locations;

            if you use this field, you don’t need to specify location_name or location_coordinate;

            you can receive the list of available locations of the search engines with their location_code by making a separate request to https://api.dataforseo.com/v3/keywords_data/google_ads/locations

            example:

            2840'
          nullable: true
        location_coordinate:
          type: string
          description: 'GPS coordinates of a location

            optional field

            if you do not indicate the location, you will receive worldwide results, i.e., for all available locations;

            if you use this field, you don’t need to specify location_name or location_code;

            location_coordinate parameter should be specified in the “latitude,longitude” format;

            the data will be provided for the country the specified coordinates belong to;

            example:

            52.6178549,-155.352142'
          nullable: true
        language_name:
          type: string
          description: 'full name of search engine language

            optional field

            you can receive the list of available languages of the search engine with their language_name by making a separate request to https://api.dataforseo.com/v3/keywords_data/google_ads/languages

            example:

            English'
          nullable: true
        language_code:
          type: string
          description: 'search engine language code

            optional field

            you can receive the list of available languages of the search engine with their language_code by making a separate request to https://api.dataforseo.com/v3/keywords_data/google_ads/languages

            example:

            en'
          nullable: true
        search_partners:
          type: boolean
          description: 'include Google search partners

            optional field

            if you specify true, the results will be delivered for owned, operated, and syndicated networks across Google and partner sites that host Google search;

            default value: false – results are returned for Google search sites'
          nullable: true
        date_from:
          type: string
          description: 'starting date of the time range

            optional field

            date format: "yyyy-mm-dd"

            minimal value: 4 years from the current date

            by default, data is returned for the past 12 months;

            Note: the indicated date cannot be greater than that specified in date_to and/or yesterday’s date;if Status endpoint returns false in the actual_data field, date_from can be set to the month before last and prior;

            if Status endpoint returns true in the actual_data field, date_from can be set to the last month and prior'
          nullable: true
        date_to:
          type: string
          description: 'ending date of the time range

            optional field

            Note: the indicated date cannot be greater than yesterday’s date;

            if you don’t specify this field, yesterday’s date will be used by default

            date format: "yyyy-mm-dd"

            example:

            "2022-11-30"'
          nullable: true
        sort_by:
          type: string
          description: 'results sorting parameters

            optional field

            Use these parameters to sort the results by relevance, search_volume, competition_index, low_top_of_page_bid, or high_top_of_page_bid in descending order

            default value: relevance'
          nullable: true
        include_adult_keywords:
          type: boolean
          description: 'include keywords associated with adult content

            optional field

            if set to true, adult keywords will be included in the response

            default value: false

            note that the API may return no data for such keywords due to Google Ads restrictions'
          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:
      - location_code: 2840
        keywords:
        - phone
        - cellphone
    KeywordsDataGoogleTrendsExploreLiveResultInfo:
      type: object
      properties:
        keywords:
          type: array
          items:
            type: string
            nullable: true
          description: keywords in a POST array
          nullable: true
        type:
          type: string
          description: type of element
          nullable: true
        location_code:
          type: integer
          description: 'location code in a POST array

            if there is no data, then the value is null'
          nullable: true
        language_code:
          type: string
          description: 'language code in a POST array

            if there is no data, then the value is null'
          nullable: true
        check_url:
          type: string
          description: 'direct URL to the Google Trends 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
        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/BaseKeywordDataGoogleTrendsItem'
            nullable: true
          description: items on the Google Trends page
          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: array of tasks
            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: array of tasks
            nullable: true
    KeywordsDataBingKeywordsForSiteTaskPostRequestInfo:
      type: object
      properties:
        target:
          type: string
          description: 'domain or URL

            required field

            the URL of the webpage or the domain to scan for possible keywords'
        location_name:
          type: string
          description: 'full name of search engine location

            required field if you don’t specify location_code or location_coordinate

            if you use this field, you don’t need to specify location_code or location_coordinate

            you 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/keywords_data/bing/locations

            example:

            London,England,United Kingdom'
          nullable: true
        location_code:
          type: integer
          description: 'search engine location code

            required field if you don’t specify location_name or location_coordinate

            if you use this field, you don’t need to specify location_name or location_coordinate

            you can receive the list of available locations of the search engines with their location_code by making a separate request to https://api.dataforseo.com/v3/keywords_data/bing/locations

            example:

            2840'
          nullable: true
        location_coordinate:
          type: string
          description: 'GPS coordinates of a location

            required field if you don’t specify location_name or location_code

            if you use this field, you don’t need to specify location_name or location_code

            location_coordinate parameter should be specified in the “latitude,longitude” format

            the data will be provided for the country the specified coordinates belong to

            example:

            52.6178549,-155.352142'
          nullable: true
        language_name:
          type: string
          description: 'full name of search engine language

            required field if you don’t specify language_code

            if you use this field, you don’t need to specify language_code

            supported languages:

            English, French, German'
          nullable: true
        language_code:
          type: string
          description: 'search engine language code

            required field if you don’t specify language_name

            if you use this field, you don’t need to specify language_name

            supported languages:

            en, fr, de'
          nullable: true
        keywords_negative:
          type: array
          items:
            type: string
          description: 'keywords negative array

            optional field

            These keywords will be ignored in the results array;

            You can specify a maximum of 200 terms that you want to exclude from the results;

            the specified keywords will be converted to lowercase format'
          nullable: true
        device:
          type: string
          description: 'device type

            optional field

            specify this field if you want to get the data for a particular device type

            possible values: all, mobile, desktop, tablet

            default value: all'
          nullable: true
        sort_by:
          type: string
          description: 'results sorting parameters

            optional field

            Use these parameters to sort the results by search_volume, cpc, competition or relevance in the descending order

            default value: relevance'
          nullable: true
        date_from:
          type: string
          description: 'starting date of the time range

            optional field

            minimal value: 24 months from today’s date;

            if you don’t specify this field, data will be provided for the last 12 months

            date format: "yyyy-mm-dd"

            example:

            "2020-01-01"

            Note: we do not recommend using a custom time range for the past year’s dates'
          nullable: true
        date_to:
          type: string
          description: 'ending date of the time range

            optional field

            if you don’t specify this field, data will be provided for the last 12 months;

            minimum value: two years back from today’s date;

            maximum value: one month from today’s date;

            date format: "yyyy-mm-dd"

            example:

            "2020-03-15"

            Note: we do not recommend using a custom time range for the past year’s dates'
          nullable: true
        postback_url:
          type: string
          description: 'URL for sending task results

            optional field

            once the task is completed, we will send a POST request with its results compressed in the gzip format to the postback_url you specified

            you 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=$id

            http://your-server.com/postbackscript?id=$id&tag=$tag

            Note: special characters in postback_url will be urlencoded;

            i.a., the # character will be encoded into %23

            learn more on our Help Center'
          nullable: true
        pingback_url:
          type: string
          description: 'notification URL of a completed task

            optional field

            when a task is completed we will notify you by GET request sent to the URL you have specified

            you 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=$id

            http://your-server.com/pingscript?id=$id&tag=$tag

            Note: special characters in pingback_url will be urlencoded;

            i.a., the # character will be encoded into %23

            learn more on our Help Center'
          nullable: true
        search_partners:
          type: boolean
          description: 'Bing search partners type

            optional field

            if you specify true, 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.

            default value: false – results are returned for Bing, AOL, and Yahoo search networks'
          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:
      - language_code: en
        location_code: 2840
        target: dataforseo.com
    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: subregional keyword popuarity data for each specified term
            nullable: true
          interests_comparison:
            type: object
            oneOf:
            - $ref: '#/components/schemas/InterestsComparison'
            description: 'comparison of data on subregional keyword popularity for the specified parameters

              if you specified a single keyword, the value will be null'
            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: array of results
            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: array of results
            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: array of results
            nullable: true
    KeywordsDataDataforseoTrendsSubregionInterestsLiveRequestInfo:
      type: object
      properties:
        keywords:
          type: array
          items:
            type: string
          description: 'keywords

            required field

            the maximum number of keywords you can specify: 5

            avoid symbols and special characters (e.g., UTF symbols, emojis);

            specifying non-Latin characters, you’ll get data for the countries where they are used

            learn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article'
        location_name:
          type: string
          description: 'full name of search engine location

            optional field

            if you don’t use this field, you will recieve global results

            if you use this field, you don’t need to specify location_code

            you 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/keywords_data/dataforseo_trends/locations

            note that the data will be provided for the country the specified location_name belongs to;

            example:

            United Kingdom'
          nullable: true
        location_code:
          type: integer
          description: 'search engine location code

            optional field

            if you don’t use this field, you will recieve global results

            if you use this field, you don’t need to specify location_name

            you can receive the list of available locations of the search engines with their location_code by making a separate request to https://api.dataforseo.com/v3/keywords_data/dataforseo_trends/locations

            note that the data will be provided for the country the specified location_code belongs to;

            example:

            2840'
          nullable: true
        type:
          type: string
          description: type of element
          nullable: true
        date_from:
          type: string
          description: 'starting date of the time range

            optional field

            if you don’t specify this field, the current day and month of the preceding year will be used by default

            minimal value for the web type: 2004-01-01

            minimal value for other types: 2008-01-01

            date format: "yyyy-mm-dd"

            example:

            "2019-01-15"'
          nullable: true
        date_to:
          type: string
          description: 'ending date of the time range

            optional field

            if you don’t specify this field, the today’s date will be used by default

            date format: "yyyy-mm-dd"

            example:

            "2019-01-15"'
          nullable: true
        time_range:
          type: string
          description: 'preset time ranges

            optional field

            if you specify date_from or date_to parameters, this field will be ignored when setting a task

            possible values for all type parameters:

            past_4_hours, past_day, past_7_days, past_30_days, past_90_days, past_12_months, past_5_years'
          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:
      - keywords:
        - rugby
        - cricket
        date_from: '2026-01-15'
        date_to: '2026-03-15'
        type: web
        location_name: United States
    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: array of tasks
            nullable: true
    KeywordsDataDataforseoTrendsSubregionInterestsLiveResultInfo:
      type: object
      properties:
        keywords:
          type: array
          items:
            type: string
            nullable: true
          description: keywords in a POST array
          nullable: true
        type:
          type: string
          description: type of element
          nullable: true
        location_code:
          type: integer
          description: 'location code in a POST array

            if there is no data, then the value is null'
          nullable: true
        language_code:
          type: string
          description: 'language code in a POST array

            if there is no data, then the value is null'
          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
        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/DataforseoTrendsSubregionInterestsElementItem'
            nullable: true
          description: 'keyword popularity values per location

            values in this array represent percentages relative to the maximum value within each region'
          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: array of tasks
            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: array of results
            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: array of results
            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: DataForSEO Trends data for the specified parameters
            nullable: true
          averages:
            type: array
            items:
              type: integer
              nullable: true
            description: keyword popularity values averaged over the whole time range
            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: array of tasks
            nullable: true
    KeywordsDataGoogleTrendsExploreTaskPostRequestInfo:
      type: object
      properties:
        keywords:
          type: array
          items:
            type: string
          description: 'keywords

            required field

            the maximum number of keywords you can specify: 5

            the maximum number of characters you can specify in a keyword: 100

            the minimum number of characters must be greater than 1

            comma characters (,) in the specified keywords will be unset and ignored

            Note: keywords cannot consist of a combination of the following characters: < > | \ " - + = ~ ! : * ( ) [ ] { }

            Note: to obtain google_trends_topics_list and google_trends_queries_list items, specify no more than 1 keyword

            learn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article'
        location_name:
          type: string
          description: 'full name of search engine location

            optional field

            if you don’t use this field, you will recieve global results

            if you use this field, you don’t need to specify location_code

            you can use this field as an array to set several locations, each corresponding to a specific keyword – learn more;

            you 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/keywords_data/google_trends/locations

            example:

            United Kingdom'
          nullable: true
        location_code:
          type: string
          description: 'search engine location code

            optional field

            if you don’t use this field, you will recieve global results

            if you use this field, you don’t need to specify location_name

            you can use this field as an array to set several locations, each corresponding to a specific keyword – learn more;

            you can receive the list of available locations of the search engines with their location_code by making a separate request to https://api.dataforseo.com/v3/keywords_data/google_trends/locations

            example:

            2840'
          nullable: true
        language_name:
          type: string
          description: 'full name of search engine language

            optional field

            default value: English

            if you use this field, you don’t need to specify language_code

            you can receive the list of available languages of the search engine with their language_name by making a separate request to https://api.dataforseo.com/v3/keywords_data/google_trends/languages

            example:

            English'
          nullable: true
        language_code:
          type: string
          description: 'search engine language code

            optional field

            default value: en

            if you use this field, you don’t need to specify language_name

            you can receive the list of available languages of the search engine with their language_code by making a separate request to https://api.dataforseo.com/v3/keywords_data/google_trends/languages

            example:

            en'
          nullable: true
        type:
          type: string
          description: type of element
          nullable: true
        category_code:
          type: integer
          description: 'google trends search category

            optional field

            if you don’t specify this field, the 0 value will be applied by default and the search will be carried out across all available categories

            you can receive the list of available categories with their category_code by making a separate request to the https://api.dataforseo.com/v3/keywords_data/google_trends/categories'
          nullable: true
        date_from:
          type: string
          description: 'starting date of the time range

            optional field

            if you don’t specify this field, the current day and month of the preceding year will be used by default

            minimal value for the web type: 2004-01-01

            minimal value for other types: 2008-01-01

            date format: "yyyy-mm-dd"

            example:

            "2019-01-15"'
          nullable: true
        date_to:
          type: string
          description: 'ending date of the time range

            optional field

            if you don’t specify this field, the today’s date will be used by default

            date format: "yyyy-mm-dd"

            example:

            "2019-01-15"'
          nullable: true
        time_range:
          type: string
          description: 'preset time ranges

            optional field

            if you specify date_from or date_to parameters, this field will be ignored when setting a task

            possible values for all type parameters:

            past_hour, past_4_hours, past_day, past_7_days, past_30_days, past_90_days, past_12_months, past_5_years

            possible values for web only:

            2004_present

            possible values for news, youtube, images, froogle:

            2008_present'
          nullable: true
        item_types:
          type: array
          items:
            type: string
          description: 'types of items returned

            optional field

            to speed up the execution of the request, specify one item at a time;

            possible values:

            "google_trends_graph", "google_trends_map", "google_trends_topics_list","google_trends_queries_list"

            default value:

            "google_trends_graph"

            Note: to obtain google_trends_topics_list and google_trends_queries_list items, specify no more than 1 keyword in the keywords field'
          nullable: true
        postback_url:
          type: string
          description: 'URL for sending task results

            optional field

            once the task is completed, we will send a POST request with its results compressed in the gzip format to the postback_url you specified

            you 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=$id

            http://your-server.com/postbackscript?id=$id&tag=$tag

            Note: special characters in postback_url will be urlencoded;

            i.a., the # character will be encoded into %23

            learn more on our Help Center'
          nullable: true
        pingback_url:
          type: string
          description: 'notification URL of a completed task

            optional field

            when a task is completed we will notify you by GET request sent to the URL you have specified

            you 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=$id

            http://your-server.com/pingscript?id=$id&tag=$tag

            Note: special characters in pingback_url will be urlencoded;

            i.a., the # character will be encoded into %23

            learn more on our Help Center'
          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:
      - date_from: '2026-01-15'
        date_to: '2026-03-15'
        type: youtube
        category_code: 3
        keywords:
        - seo api
        - rank api
    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: array of results
            nullable: true
    KeywordsDataGoogleAdsAdTrafficByKeywordsTaskPostRequestInfo:
      type: object
      properties:
        keywords:
          type: array
          items:
            type: string
          description: 'keywords

            required field

            The maximum number of keywords you can specify: 1000

            The maximum number of characters for each keyword: 80

            The maximum number of words for each keyword phrase: 10

            the keywords you specify will be converted to a lowercase format

            Note #1: Google Ads may return no data for certain groups of keywords;

            Note #2: Google Ads provides combined search volume values for groups of similar keywords

            to obtain search volume for similar keywords, we recommend submitting such keywords in separate requests;

            Note #3: 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;

            to learn more about which symbols and characters can be used, please refer to this article

            learn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article'
        bid:
          type: number
          description: 'the maximum custom bid

            required field

            the collected data will be based on this value

            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

            learn more in this help center article'
        match:
          type: string
          description: 'keywords match-type

            required field

            can take the following values: exact, broad, phrase'
        search_partners:
          type: boolean
          description: 'include Google search partners

            optional field

            if you specify true, the results will be delivered for owned, operated, and syndicated networks across Google and partner sites that host Google search;

            default value: false – results are returned for Google search sites'
          nullable: true
        location_name:
          type: string
          description: 'full name of search engine location

            optional field

            if you do not indicate the location, you will receive worldwide results, i.e., for all available locations;

            if you use this field, you don’t need to specify location_code or location_coordinate

            you 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/keywords_data/google_ads/locations

            example:

            London,England,United Kingdom'
          nullable: true
        location_code:
          type: integer
          description: 'search engine location code

            optional field

            if you do not indicate the location, you will receive worldwide results, i.e., for all available locations;

            if you use this field, you don’t need to specify location_name or location_coordinate;

            you can receive the list of available locations of the search engines with their location_code by making a separate request to https://api.dataforseo.com/v3/keywords_data/google_ads/locations

            example:

            2840'
          nullable: true
        location_coordinate:
          type: string
          description: 'GPS coordinates of a location

            optional field

            if you do not indicate the location, you will receive worldwide results, i.e., for all available locations;

            if you use this field, you don’t need to specify location_name or location_code;

            location_coordinate parameter should be specified in the “latitude,longitude” format;

            the data will be provided for the country the specified coordinates belong to;

            example:

            52.6178549,-155.352142'
          nullable: true
        language_name:
          type: string
          description: 'full name of search engine language

            optional field

            you can receive the list of available languages of the search engine with their language_name by making a separate request to https://api.dataforseo.com/v3/keywords_data/google_ads/languages

            example:

            English'
          nullable: true
        language_code:
          type: string
          description: 'search engine language code

            optional field

            you can receive the list of available languages of the search engine with their language_code by making a separate request to https://api.dataforseo.com/v3/keywords_data/google_ads/languages

            example:

            en'
          nullable: true
        date_from:
          type: string
          description: 'starting date of the forecasting time range

            required field if you specify date_to

            if you indicate date_from and date_to, you don’t need to specify date_interval

            minimum value is tomorrow’s date

            the value you specify in date_from shouldn’t be further than date_to

            date format: "yyyy-mm-dd"

            example:

            "2021-10-30"if Status endpoint returns false in the actual_data field, date_from can be set to the month before last and prior;

            if Status endpoint returns true in the actual_data field, date_from can be set to the last month and prior'
          nullable: true
        date_to:
          type: string
          description: 'ending date of the forecasting time range

            required field if you specify date_from

            if you indicate date_from and date_to, you don’t need to specify date_interval

            minimum value is date_from +1 day

            maximum value is current day and month of the next year

            date format: "yyyy-mm-dd"

            example:

            "2022-10-30"'
          nullable: true
        date_interval:
          type: string
          description: 'forecasting date interval

            optional field

            if you specify date_interval, you don’t need to indicate date_from and date_to

            possible values: next_week, next_month, next_quarter

            default value: next_month'
          nullable: true
        sort_by:
          type: string
          description: 'results sorting parameters

            optional field

            Use these parameters to sort the results by relevance, impressions, ctr, average_cpc, cost, or clicks in the descending order

            default value: relevance'
          nullable: true
        postback_url:
          type: string
          description: 'URL for sending task results

            optional field

            once the task is completed, we will send a POST request with its results compressed in the gzip format to the postback_url you specified

            you 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=$id

            http://your-server.com/postbackscript?id=$id&tag=$tag

            Note: special characters in postback_url will be urlencoded;

            i.a., the # character will be encoded into %23

            learn more on our Help Center'
          nullable: true
        pingback_url:
          type: string
          description: 'notification URL of a completed task

            optional field

            when a task is completed we will notify you by GET request sent to the URL you have specified

            you 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=$id

            http://your-server.com/pingscript?id=$id&tag=$tag

            Note: special characters in pingback_url will be urlencoded;

            i.a., the # character will be encoded into %23

            learn more on our Help Center'
          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:
      - language_code: en
        location_code: 2840
        bid: 999
        match: exact
        keywords:
        - seo marketing
    KeywordsDataGoogleAdsKeywordsForSiteTaskPostTaskInfo:
      type: object
      allOf:
      - $ref: '#/components/schemas/BaseResponseTaskInfo'
      - type: object
        properties:
          result:
            type: object
            description: 'array of results

              in this case, the value will be null'
            nullable: true
    KeywordsDataBingKeywordsForSiteLiveRequestInfo:
      type: object
      properties:
        target:
          type: string
          description: 'domain or URL

            required field

            the domain name or URL of the target website'
        location_name:
          type: string
          description: 'full name of search engine location

            required field if you don’t specify location_code or location_coordinate

            if you use this field, you don’t need to specify location_code or location_coordinate

            you 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/keywords_data/bing/locations

            example:

            London,England,United Kingdom'
          nullable: true
        location_code:
          type: integer
          description: 'search engine location code

            required field if you don’t specify location_name or location_coordinate

            if you use this field, you don’t need to specify location_name or location_coordinate

            you can receive the list of available locations of the search engines with their location_code by making a separate request to https://api.dataforseo.com/v3/keywords_data/bing/locations

            example:

            2840'
          nullable: true
        location_coordinate:
          type: string
          description: 'GPS coordinates of a location

            required field if you don’t specify location_name or location_code

            if you use this field, you don’t need to specify location_name or location_code

            location_coordinate parameter should be specified in the “latitude,longitude” format

            the data will be provided for the country the specified coordinates belong to

            example:

            52.6178549,-155.352142'
          nullable: true
        language_name:
          type: string
          description: 'full name of search engine language

            required field if you don’t specify language_code

            if you use this field, you don’t need to specify language_code

            supported languages:

            English, French, German'
          nullable: true
        language_code:
          type: string
          description: 'search engine language code

            required field if you don’t specify language_name

            if you use this field, you don’t need to specify language_name

            supported languages:

            en, fr, de'
          nullable: true
        keywords_negative:
          type: array
          items:
            type: string
          description: 'keywords negative array

            optional field

            These keywords will be ignored in the results array;

            You can specify a maximum of 200 terms that you want to exclude from the results;

            the specified keywords will be converted to lowercase format'
          nullable: true
        device:
          type: string
          description: 'device type

            optional field

            specify this field if you want to get the data for a particular device typepossible values: all, mobile, desktop, tablet

            default value: all'
          nullable: true
        date_from:
          type: string
          description: 'starting date of the time range

            optional field

            minimal value: 24 months from today’s date;

            if you don’t specify this field, data will be provided for the last 12 months

            date format: "yyyy-mm-dd"

            example:

            "2020-01-01"

            Note: we do not recommend using a custom time range for the past year’s dates'
          nullable: true
        date_to:
          type: string
          description: 'ending date of the time range

            optional field

            if you don’t specify this field, data will be provided for the last 12 months;

            minimum value: two years back from today’s date;

            maximum value: one month from today’s date;

            note: we do not recommend using a custom time range for the past year’s dates;

            date format: "yyyy-mm-dd"

            example:

            "2020-03-15"

            Note: we do not recommend using a custom time range for the past year’s dates'
          nullable: true
        sort_by:
          type: string
          description: 'results sorting parameters

            optional field

            Use these parameters to sort the results by search_volume, cpc, competition or relevance in the descending order

            default value: relevance'
          nullable: true
        search_partners:
          type: boolean
          description: 'Bing search partners type

            optional field

            if you specify true, 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.

            default value: false – results are returned for Bing, AOL, and Yahoo search networks'
          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:
      - language_code: en
        location_code: 2840
        target: dataforseo.com
    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: array of results
            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: array of tasks
            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: array of tasks
            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: array of results
            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: array of results
            nullable: true
    KeywordsDataBingKeywordPerformanceTaskGetResultInfo:
      type: object
      properties:
        keyword:
          type: string
          description: keyword in a POST array
          nullable: true
        location_code:
          type: integer
          description: 'location code in a POST array

            if there is no data, then the value is null'
          nullable: true
        language_code:
          type: string
          description: 'language code in a POST array

            if there is no data, then the value is null'
          nullable: true
        year:
          type: integer
          description: 'indicates the year for which the data is provided for

            example:

            2020'
          nullable: true
        month:
          type: integer
          description: 'indicates the month for which the data is provided for

            example:

            10'
          nullable: true
        keyword_kpi:
          type: object
          oneOf:
          - $ref: '#/components/schemas/KeywordKpi'
          description: 'object containing keyword metrics

            if there is no data, then the value is null'
          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: array of tasks
            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: array of tasks
            nullable: true
    BaseResponseInfo:
      properties:
        version:
          type: string
          description: the current version of the API
          nullable: true
        status_code:
          type: integer
          description: 'general status code

            you can find the full list of the response codes here'
          nullable: true
        status_message:
          type: string
          description: 'general informational message

            you 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
    KeywordsDataBingSearchVolumeHistoryTaskPostTaskInfo:
      type: object
      allOf:
      - $ref: '#/components/schemas/BaseResponseTaskInfo'
      - type: object
        properties:
          result:
            type: object
            description: 'array of results

              in this case, the value will be null'
            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: array of results
            nullable: true
    KeywordsDataGoogleAdsKeywordsForSiteLiveRequestInfo:
      type: object
      properties:
        target:
          type: string
          description: 'domain or page

            required field

            the domain name of the target website or the url of the target page;

            note: to obtain keywords for the target website, use the target_type parameter'
        target_type:
          type: string
          description: 'search keywords for site or for url

            optional field

            possible values: site, page;

            default value: page;

            if set to site, keywords will be provided for the entire site;

            if set to page, keywords will be provided for the specified webpage'
          nullable: true
        location_name:
          type: string
          description: 'full name of search engine location

            optional field

            if you do not indicate the location, you will receive worldwide results, i.e., for all available locations;

            if you use this field, you don’t need to specify location_code or location_coordinate

            you 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/keywords_data/google_ads/locations

            example:

            London,England,United Kingdom'
          nullable: true
        location_code:
          type: integer
          description: 'search engine location code

            optional field

            if you do not indicate the location, you will receive worldwide results, i.e., for all available locations;

            if you use this field, you don’t need to specify location_name or location_coordinate;

            you can receive the list of available locations of the search engines with their location_code by making a separate request to https://api.dataforseo.com/v3/keywords_data/google_ads/locations

            example:

            2840'
          nullable: true
        location_coordinate:
          type: string
          description: 'GPS coordinates of a location

            optional field

            if you do not indicate the location, you will receive worldwide results, i.e., for all available locations;

            if you use this field, you don’t need to specify location_name or location_code;

            location_coordinate parameter should be specified in the “latitude,longitude” format;

            the data will be provided for the country the specified coordinates belong to;

            example:

            52.6178549,-155.352142'
          nullable: true
        language_name:
          type: string
          description: 'full name of search engine language

            optional field

            you can receive the list of available languages of the search engine with their language_name by making a separate request to https://api.dataforseo.com/v3/keywords_data/google_ads/languages

            example:

            English'
          nullable: true
        language_code:
          type: string
          description: 'search engine language code

            optional field

            you can receive the list of available languages of the search engine with their language_code by making a separate request to https://api.dataforseo.com/v3/keywords_data/google_ads/languages

            example:

            en'
          nullable: true
        search_partners:
          type: boolean
          description: 'include Google search partners

            optional field

            if you specify true, the results will be delivered for owned, operated, and syndicated networks across Google and partner sites that host Google search;

            default value: false – results are returned for Google search sites'
          nullable: true
        date_from:
          type: string
          description: 'starting date of the time range

            optional field

            date format: "yyyy-mm-dd"

            minimal value: 4 years from the current date

            by default, data is returned for the past 12 months;

            Note: the indicated date cannot be greater than that specified in date_to and/or yesterday’s date;if Status endpoint returns false in the actual_data field, date_from can be set to the month before last and prior;

            if Status endpoint returns true in the actual_data field, date_from can be set to the last month and prior'
          nullable: true
        date_to:
          type: string
          description: 'ending date of the time range

            optional field

            Note: the indicated date cannot be greater than yesterday’s date;

            if you don’t specify this field, yesterday’s date will be used by default

            date format: "yyyy-mm-dd"

            example:

            "2022-11-30"'
          nullable: true
        include_adult_keywords:
          type: boolean
          description: 'include keywords associated with adult content

            optional field

            if set to true, adult keywords will be included in the response

            default value: false

            note that the API may return no data for such keywords due to Google Ads restrictions'
          nullable: true
        sort_by:
          type: string
          description: 'results sorting parameters

            optional field

            Use these parameters to sort the results by relevance, search_volume, competition_index, low_top_of_page_bid, or high_top_of_page_bid in descending order

            default value: relevance'
          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:
      - location_code: 2840
        target: dataforseo.com
    KeywordsDataBingSearchVolumeHistoryLocationsAndLanguagesResultInfo:
      type: object
      properties:
        language_name:
          type: string
          description: language name
          nullable: true
        language_code:
          type: string
          description: language code according to ISO 639-1
          nullable: true
        available_locations:
          type: array
          items:
            type: object
            oneOf:
            - $ref: '#/components/schemas/AvailableLocations'
            nullable: true
          description: array of available locations for a certain language
          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: array of tasks
            nullable: true
    KeywordsDataBingSearchVolumeHistoryLiveResultInfo:
      type: object
      properties:
        keyword:
          type: string
          description: keyword in a POST array
          nullable: true
        location_code:
          type: integer
          description: 'location code in a POST array

            if there is no data, then the value is null'
          nullable: true
        language_code:
          type: string
          description: 'language code in a POST array

            if there is no data, then the value is null'
          nullable: true
        device:
          type: array
          items:
            type: string
            nullable: true
          nullable: true
        period:
          type: string
          description: 'time period

            indicates if returned data is aggregated to a certain time period

            default value monthly'
          nullable: true
        searches:
          type: object
          oneOf:
          - $ref: '#/components/schemas/SearchVolumeHistorySearchInfo'
          description: 'contains results distributed by device type

            if the device parameter is not specified, the data will be returned for all available device types'
          nullable: true
    KeywordsDataClickstreamDataBulkSearchVolumeLiveRequestInfo:
      type: object
      properties:
        keywords:
          type: array
          items:
            type: string
          description: 'target keywords

            required field

            UTF-8 encoding

            maximum number of keywords you can specify in this array: 1000;

            each keyword should be at least 3 characters long;

            the keywords will be converted to lowercase format;

            Note: certain symbols and characters (e.g., UTF symbols, emojis) are not allowed

            to learn more about which symbols and characters can be used, please refer to this article

            learn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article'
        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/keywords_data/clickstream_data/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/keywords_data/clickstream_data/locations_and_languages

            example:

            2840'
          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:
      - location_code: 2840
        tag: test-tag
        keywords:
        - you tube
        - youtube
        - youtub
    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: array of results
            nullable: true
    KeywordsDataGoogleAdsKeywordsForKeywordsLiveResultInfo:
      type: object
      properties:
        keyword:
          type: string
          description: keyword in a POST array
          nullable: true
        spell:
          type: string
          nullable: true
        location_code:
          type: integer
          description: 'location code in a POST array

            if there is no data, the value is null'
          nullable: true
        language_code:
          type: string
          description: 'language code in a POST array

            if there is no data, the value is null'
          nullable: true
        search_partners:
          type: boolean
          description: 'include Google search partners

            the value you specified when setting the task

            if true, the results are returned for owned, operated, and syndicated networks across Google and partner sites that host Google search;

            if false, the results are returned for Google search sites only'
          nullable: true
        competition:
          type: string
          description: 'competition

            represents the relative level of competition associated with the given keyword in paid SERP only

            possible values: LOW, MEDIUM, HIGH

            if competition level is unknown, the value is null;

            learn more about the metric in this help center article'
          nullable: true
        competition_index:
          type: integer
          description: 'competition index

            the competition index for the query indicating how competitive ad placement is for the keyword

            can take values from 0 to 100

            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

            if not enough data is available, the value is null;

            learn more about the metric in this help center article'
          nullable: true
        search_volume:
          type: integer
          description: 'monthly average search volume rate

            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

            if there is no data, the value is null'
          format: int64
          nullable: true
        low_top_of_page_bid:
          type: number
          description: 'minimum bid for the ad to be displayed at the top of the first page

            indicates the value greater than about 20% of the lowest bids for which ads were displayed (based on Google Ads statistics for advertisers)

            the value may differ depending on the location specified in a POST request'
          nullable: true
        high_top_of_page_bid:
          type: number
          description: 'maximum bid for the ad to be displayed at the top of the first page

            indicates the value greater than about 80% of the lowest bids for which ads were displayed (based on Google Ads statistics for advertisers)

            the value may differ depending on the location specified in a POST request'
          nullable: true
        cpc:
          type: number
          description: 'cost per click

            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: 'monthly searches

            represents the (approximate) number of searches on this keyword idea (as available for the past twelve months), targeted to the specified geographic locations

            if there is no data, the value is null'
          nullable: true
    KeywordsDataGoogleAdsKeywordsForKeywordsTaskPostRequestInfo:
      type: object
      properties:
        keywords:
          type: array
          items:
            type: string
          description: 'keywords

            required field

            The maximum number of keywords you can specify: 20

            The maximum number of characters for each keyword: 80

            the keywords you specify will be converted to a lowercase format

            Note: Google Ads may return no data for certain groups of keywords

            visit our Help Center to learn more

            Also note 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;

            to learn more about which symbols and characters can be used, please refer to this article

            learn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article'
        target:
          type: string
          description: 'target website

            optional field

            specify a website or URL to get a list of keywords relevant to it;

            Note: if a website url is specified, you will still get keywords relevant for the entire website'
          nullable: true
        location_name:
          type: string
          description: 'full name of search engine location

            optional field

            if you do not indicate the location, you will receive worldwide results, i.e., for all available locations;

            if you use this field, you don’t need to specify location_code or location_coordinate

            you 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/keywords_data/google_ads/locations

            example:

            London,England,United Kingdom'
          nullable: true
        location_code:
          type: integer
          description: 'search engine location code

            optional field

            if you do not indicate the location, you will receive worldwide results, i.e., for all available locations;

            if you use this field, you don’t need to specify location_name or location_coordinate;

            you can receive the list of available locations of the search engines with their location_code by making a separate request to https://api.dataforseo.com/v3/keywords_data/google_ads/locations

            example:

            2840'
          nullable: true
        location_coordinate:
          type: string
          description: 'GPS coordinates of a location

            optional field

            if you do not indicate the location, you will receive worldwide results, i.e., for all available locations;

            if you use this field, you don’t need to specify location_name or location_code;

            location_coordinate parameter should be specified in the “latitude,longitude” format;

            the data will be provided for the country the specified coordinates belong to;

            example:

            52.6178549,-155.352142'
          nullable: true
        language_name:
          type: string
          description: 'full name of search engine language

            optional field

            you can receive the list of available languages of the search engine with their language_name by making a separate request to https://api.dataforseo.com/v3/keywords_data/google_ads/languages

            example:

            English'
          nullable: true
        language_code:
          type: string
          description: 'search engine language code

            optional field

            you can receive the list of available languages of the search engine with their language_code by making a separate request to https://api.dataforseo.com/v3/keywords_data/google_ads/languages

            example:

            en'
          nullable: true
        search_partners:
          type: boolean
          description: 'include Google search partners

            optional field

            if you specify true, the results will be delivered for owned, operated, and syndicated networks across Google and partner sites that host Google search;

            default value: false – results are returned for Google search sites'
          nullable: true
        date_from:
          type: string
          description: 'starting date of the time range

            optional field

            date format: "yyyy-mm-dd"

            minimal value: 4 years from the current date

            by default, data is returned for the past 12 months;

            Note: the indicated date cannot be greater than that specified in date_to and/or yesterday’s date;if Status endpoint returns false in the actual_data field, date_from can be set to the month before last and prior;

            if Status endpoint returns true in the actual_data field, date_from can be set to the last month and prior'
          nullable: true
        date_to:
          type: string
          description: 'ending date of the time range

            optional field

            Note: the indicated date cannot be greater than yesterday’s date;

            if you don’t specify this field, yesterday’s date will be used by default

            date format: "yyyy-mm-dd"

            example:

            "2022-11-30"'
          nullable: true
        sort_by:
          type: string
          description: 'results sorting parameters

            optional field

            Use these parameters to sort the results by relevance, search_volume, competition_index, low_top_of_page_bid, or high_top_of_page_bid in descending order

            default value: relevance'
          nullable: true
        include_adult_keywords:
          type: boolean
          description: 'include keywords associated with adult content

            optional field

            if set to true, adult keywords will be included in the response

            default value: false

            note that the API may return no data for such keywords due to Google Ads restrictions'
          nullable: true
        postback_url:
          type: string
          description: 'URL for sending task results

            optional field

            once the task is completed, we will send a POST request with its results compressed in the gzip format to the postback_url you specified

            you 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=$id

            http://your-server.com/postbackscript?id=$id&tag=$tag

            Note: special characters in postback_url will be urlencoded;

            i.a., the # character will be encoded into %23

            learn more on our Help Center'
          nullable: true
        pingback_url:
          type: string
          description: 'notification URL of a completed task

            optional field

            when a task is completed we will notify you by GET request sent to the URL you have specified

            you 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=$id

            http://your-server.com/pingscript?id=$id&tag=$tag

            Note: special characters in pingback_url will be urlencoded;

            i.a., the # character will be encoded into %23

            learn more on our Help Center'
          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:
      - location_code: 2840
        keywords:
        - phone
        - cellphone
    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: array of tasks
            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: array of tasks
            nullable: true
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic