# Live YouTube Comments Advanced

**API:** Data API

**Endpoint:** `POST /v1/beta/dataforseo/serp/youtube/video_comments/live/advanced`

**Tags:** DataForSEO

Returns the comments on one YouTube video on YouTube, synchronously. Returns `keyword`, `type`, `se_domain`, `location_code`, `language_code`, `check_url`, `datetime`, `spell`, `refinement_chips`, `item_types`, `items_count` and `items`. `advanced` is the default choice; take `regular` when only the ranked list matters and `html` only to check what the parser dropped. Wrapped in DataForSEO's envelope: data in `tasks[0].result`, outcome in `tasks[0].status_code` - a rejected request still returns HTTP 200.

### Pricing reference

- Metering: Reported response cost.
- Reference request estimate: USD 0.004.
- Reference customer multiplier: 1.0. Do not apply it again to a settled customer amount.

Reference metadata only, not an account quote, a guaranteed price or a spending cap. Resource credits are not Felo credits. Final charges follow Felo billing records.

## Base URL

- `https://openapi.felo.ai`

## Authentication

- `FeloBearerAuth` (http bearer, bearer format Felo API Key)
- `FeloApiKey` (apiKey in header `X-API-Key`)

## Request body

Required: **no**

### application/json

Schema:

```json
{
  "type": "array",
  "items": {
    "type": [
      "object",
      "null"
    ],
    "oneOf": [
      {
        "type": "object",
        "properties": {
          "video_id": {
            "type": "string",
            "description": "<em>ID of the video</em><br><strong>required field</strong><br>you can find video ID in the URL or 'youtube_video' item of <a href=\"/v3/serp/youtube/organic/live/advanced/\" rel=\"noopener noreferrer\" target=\"_blank\">YouTube Organic</a> result<br>example:<br><code>vQXvyV0zIP4</code>"
          },
          "location_name": {
            "type": "string",
            "description": "<em>full name of search engine location</em><br><strong>required field if you don't specify</strong> <code>location_code</code><br><strong>if you use this field, you don't need to specify <code>location_code</code></strong><br>you can receive the list of available locations of the search engine with their <code>location_name</code> by making a separate request to the <code>https://api.dataforseo.com/v3/serp/youtube/locations</code><br>example:<br><code class=\"long-string\">United States</code>"
          },
          "location_code": {
            "type": "integer",
            "description": "<em>search engine location code</em><br><strong>required field if you don't specify</strong> <code>location_name</code>_<br><strong>if you use this field, you don't need to specify <code>location_name</code></strong><br>you can receive the list of available locations of the search engines with their <code>location_code</code> by making a separate request to the <code>https://api.dataforseo.com/v3/serp/youtube/locations</code><br>example:<br><code class=\"long-string\">2840</code>n"
          },
          "language_name": {
            "type": "string",
            "description": "<em>full name of search engine language</em><br><strong>required field if you don't specify</strong> <code>language_code</code><br><strong>if you use this field, you don't need to specify <code>language_code</code></strong><br>you can receive the list of available languages of the search engine with their <code>language_name</code> by making a separate request to the <code>https://api.dataforseo.com/v3/serp/youtube/languages</code><br>example:<br><code class=\"long-string\">English</code>"
          },
          "language_code": {
            "type": "string",
            "description": "<em>search engine language code</em><br><strong>required field if you don't specify</strong> <code>language_name</code><br><strong>if you use this field, you don't need to specify <code>language_name</code></strong><br>you can receive the list of available languages of the search engine with their <code>language_code</code>_by making a separate request to the <code>https://api.dataforseo.com/v3/serp/youtube/languages</code><em><br></em>example:<em><br></em><code class=\"long-string\">en</code>n"
          },
          "device": {
            "type": [
              "string",
              "null"
            ],
            "description": "<em>device type</em><br>optional field<br>only value: <code>desktop</code>"
          },
          "os": {
            "type": [
              "string",
              "null"
            ]
          },
          "depth": {
            "type": [
              "integer",
              "null"
            ],
            "description": "<em>parsing depth</em><br>optional field<br>number of results in SERP<br>default value: <code>20</code><br>max value: <code>200</code><br><strong>Note:</strong> your account will be billed per each SERP containing up to 20 results;<br>thus, setting a depth above <code>20</code> may result in additional charges if the search engine returns more than 20 results;<br>if the specified depth is higher than the number of results in the response, the difference will be refunded automatically to your account balance"
          },
          "tag": {
            "type": [
              "string",
              "null"
            ],
            "description": "<em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response"
          }
        },
        "example": [
          {
            "language_code": "en",
            "location_code": 2840,
            "video_id": "vQXvyV0zIP4"
          }
        ]
      }
    ]
  },
  "example": [
    {
      "language_code": "en",
      "location_code": 2840,
      "video_id": "vQXvyV0zIP4"
    }
  ]
}
```

## Responses

### 200 — Successful operation

Headers:
- `X-Request-Id` (string) — Request identifier to include when contacting Felo support.

**application/json**

Schema: object | null

```json
{
  "type": [
    "object",
    "null"
  ],
  "oneOf": [
    {
      "$ref": "#/components/schemas/Response36Afe1097B20_SerpYoutubeVideoCommentsLiveAdvancedResponseInfo"
    }
  ]
}
```

### 400 — The request could not be processed. Check the request parameters.

### 401 — A valid Felo API key is required.

### 402 — The request cannot proceed because a billing requirement is not met.

### 403 — The account is not permitted to perform this operation.

### 429 — A request or spending limit has been reached.

### 502 — The service could not complete the request.

### 503 — The API or billing service is temporarily unavailable.

### 504 — The service timed out while processing the request.

### default — Error response; upstream passthrough responses may use provider formats

**application/json**

Schema:

```json
{}
```

## Schema definitions

### Response36Afe1097B20_BaseResponseInfo

`#/components/schemas/Response36Afe1097B20_BaseResponseInfo`

```json
{
  "properties": {
    "version": {
      "type": [
        "string",
        "null"
      ],
      "description": "the current version of the API"
    },
    "status_code": {
      "type": [
        "integer",
        "null"
      ],
      "description": "general status code\nyou can find the full list of the response codes here"
    },
    "status_message": {
      "type": [
        "string",
        "null"
      ],
      "description": "general informational message\nyou can find the full list of general informational messages here"
    },
    "time": {
      "type": [
        "string",
        "null"
      ],
      "description": "total execution time, seconds"
    },
    "cost": {
      "type": [
        "number",
        "null"
      ],
      "description": "total tasks cost, USD",
      "format": "double"
    },
    "tasks_count": {
      "type": [
        "integer",
        "null"
      ],
      "description": "the number of tasks in the tasks array",
      "format": "int64"
    },
    "tasks_error": {
      "type": [
        "integer",
        "null"
      ],
      "description": "the number of tasks in the tasks array returned with an error",
      "format": "int64"
    }
  }
}
```

### Response36Afe1097B20_BaseResponseTaskInfo

`#/components/schemas/Response36Afe1097B20_BaseResponseTaskInfo`

```json
{
  "properties": {
    "id": {
      "type": [
        "string",
        "null"
      ],
      "description": "task identifier\nunique task identifier in our system in the UUID format"
    },
    "status_code": {
      "type": [
        "integer",
        "null"
      ],
      "description": "status code of the task\ngenerated by DataForSEO, can be within the following range: 10000-60000\nyou can find the full list of the response codes here"
    },
    "status_message": {
      "type": [
        "string",
        "null"
      ],
      "description": "informational message of the task\nyou can find the full list of general informational messages here"
    },
    "time": {
      "type": [
        "string",
        "null"
      ],
      "description": "execution time, seconds"
    },
    "cost": {
      "type": [
        "number",
        "null"
      ],
      "description": "total tasks cost, USD",
      "format": "double"
    },
    "result_count": {
      "type": [
        "integer",
        "null"
      ],
      "description": "number of elements in the result array",
      "format": "int64"
    },
    "path": {
      "type": [
        "array",
        "null"
      ],
      "items": {
        "type": [
          "string",
          "null"
        ]
      },
      "description": "URL path"
    },
    "data": {
      "type": [
        "object",
        "null"
      ],
      "additionalProperties": {
        "type": [
          "object",
          "null"
        ]
      },
      "description": "contains the same parameters that you specified in the POST request"
    }
  }
}
```

### Response36Afe1097B20_SerpYoutubeVideoCommentsLiveAdvancedResponseInfo

`#/components/schemas/Response36Afe1097B20_SerpYoutubeVideoCommentsLiveAdvancedResponseInfo`

```json
{
  "type": "object",
  "allOf": [
    {
      "$ref": "#/components/schemas/Response36Afe1097B20_BaseResponseInfo"
    },
    {
      "type": "object",
      "properties": {
        "tasks": {
          "type": [
            "array",
            "null"
          ],
          "items": {
            "type": [
              "object",
              "null"
            ],
            "oneOf": [
              {
                "$ref": "#/components/schemas/Response36Afe1097B20_SerpYoutubeVideoCommentsLiveAdvancedTaskInfo"
              }
            ]
          },
          "description": "<em>array of tasks</em>"
        }
      }
    }
  ]
}
```

### Response36Afe1097B20_SerpYoutubeVideoCommentsLiveAdvancedResultInfo

`#/components/schemas/Response36Afe1097B20_SerpYoutubeVideoCommentsLiveAdvancedResultInfo`

```json
{
  "type": "object",
  "properties": {
    "video_id": {
      "type": [
        "string",
        "null"
      ],
      "description": "<em>ID of the video received in a POST array</em>"
    },
    "se_domain": {
      "type": [
        "string",
        "null"
      ],
      "description": "<em>search engine domain in a POST array</em>"
    },
    "location_code": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>location code in a POST array</em>"
    },
    "language_code": {
      "type": [
        "string",
        "null"
      ],
      "description": "<em>language code in a POST array</em>"
    },
    "check_url": {
      "type": [
        "string",
        "null"
      ],
      "description": "<em>direct URL to search engine results<br></em>you can use it to make sure that we provided accurate results"
    },
    "datetime": {
      "type": [
        "string",
        "null"
      ],
      "description": "<em>date and time when the result was received</em><br>in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”<br>example:<br><code class=\"long-string\">2019-11-15 12:57:46 +00:00</code>"
    },
    "spell": {
      "type": [
        "object",
        "null"
      ],
      "oneOf": [
        {
          "$ref": "#/components/schemas/Response36Afe1097B20_SpellInfo"
        }
      ],
      "description": "<em>autocorrection of the search engine</em><br>if the search engine provided results for a keyword that was corrected, we will specify the keyword corrected by the search engine and the type of autocorrection"
    },
    "item_types": {
      "type": [
        "array",
        "null"
      ],
      "items": {
        "type": [
          "string",
          "null"
        ]
      },
      "description": "<em>types of search results in SERP</em><br>contains types of search results (<code>items</code>) found in SERP.<br>possible item:<br><code>youtube_comment</code>"
    },
    "title": {
      "type": [
        "string",
        "null"
      ],
      "description": "<em>title of the video</em>"
    },
    "comments_count": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>number of comments on the video</em>",
      "format": "int64"
    },
    "items_count": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>the number of results returned in the <strong><code>items</code></strong> array</em>",
      "format": "int64"
    },
    "items": {
      "type": [
        "array",
        "null"
      ],
      "items": {
        "type": [
          "object",
          "null"
        ],
        "oneOf": [
          {
            "$ref": "#/components/schemas/Response36Afe1097B20_YoutubeComment"
          }
        ]
      },
      "description": "<em>elements of search results found in SERP</em>"
    }
  }
}
```

### Response36Afe1097B20_SerpYoutubeVideoCommentsLiveAdvancedTaskInfo

`#/components/schemas/Response36Afe1097B20_SerpYoutubeVideoCommentsLiveAdvancedTaskInfo`

```json
{
  "type": "object",
  "allOf": [
    {
      "$ref": "#/components/schemas/Response36Afe1097B20_BaseResponseTaskInfo"
    },
    {
      "type": "object",
      "properties": {
        "result": {
          "type": [
            "array",
            "null"
          ],
          "items": {
            "type": [
              "object",
              "null"
            ],
            "oneOf": [
              {
                "$ref": "#/components/schemas/Response36Afe1097B20_SerpYoutubeVideoCommentsLiveAdvancedResultInfo"
              }
            ]
          },
          "description": "<em>array of results</em>"
        }
      }
    }
  ]
}
```

### Response36Afe1097B20_SpellInfo

`#/components/schemas/Response36Afe1097B20_SpellInfo`

```json
{
  "properties": {
    "keyword": {
      "type": [
        "string",
        "null"
      ],
      "description": "keyword obtained as a result of search engine autocorrection\n the results will be provided for the corrected keyword"
    },
    "type": {
      "type": [
        "string",
        "null"
      ],
      "description": "type of autocorrection\n possible values:\n did_you_mean, showing_results_for, no_results_found_for, including_results_for\n note: Yahoo and Yandex support only the following autocorrection type:\n including_results_for"
    }
  }
}
```

### Response36Afe1097B20_YoutubeComment

`#/components/schemas/Response36Afe1097B20_YoutubeComment`

```json
{
  "type": "object",
  "properties": {
    "type": {
      "type": [
        "string",
        "null"
      ],
      "description": "type of element"
    },
    "rank_group": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>group rank in SERP</em><br>position within a group of elements with identical <code>type</code> values<br>positions of elements with different <code>type</code> values are omitted from <code>rank_group</code>"
    },
    "rank_absolute": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em> absolute rank in SERP for the target domain</em><br>absolute position among all the elements in SERP"
    },
    "author_name": {
      "type": [
        "string",
        "null"
      ],
      "description": "<em>name of the author of the comment</em>"
    },
    "author_thumbnail": {
      "type": [
        "string",
        "null"
      ],
      "description": "<em>the URL of the page where the author's channel logo is hosted</em>"
    },
    "author_url": {
      "type": [
        "string",
        "null"
      ],
      "description": "<em>URL of the author's channel</em>"
    },
    "text": {
      "type": [
        "string",
        "null"
      ],
      "description": "<em>text of the comment</em>"
    },
    "publication_date": {
      "type": [
        "string",
        "null"
      ],
      "description": "<em>displayed publication date</em>"
    },
    "timestamp": {
      "type": [
        "string",
        "null"
      ],
      "description": "<em>date and time when the result was published</em><br>in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”<br>example:<br><code>2022-11-15 12:57:46 +00:00</code>"
    },
    "likes_count": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>number of likes on the comment</em>",
      "format": "int64"
    },
    "reply_count": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>number of replies on the comment</em>",
      "format": "int64"
    }
  }
}
```