version |
string |
the current version of the API |
status_code |
integer |
general status code
you can find the full list of the response codes here
Note: we strongly recommend designing a necessary system for handling related exceptional or error conditions |
status_message |
string |
general informational message
you can find the full list of general informational messages here |
time |
string |
execution time, seconds |
cost |
float |
total tasks cost, USD |
tasks_count |
integer |
the number of tasks in the tasks array |
tasks_error |
integer |
the number of tasks in the tasks array returned with an error |
tasks |
array |
array of tasks |
id |
string |
task identifier
unique task identifier in our system in the UUID format |
status_code |
integer |
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 |
status_message |
string |
informational message of the task
you can find the full list of general informational messages here |
time |
string |
execution time, seconds |
cost |
float |
cost of the task, USD |
result_count |
integer |
number of elements in the result array |
path |
array |
URL path |
data |
object |
contains the same parameters that you specified in the POST request |
result |
array |
array of results |
keyword |
string |
keyword received in a POST array
the keyword is returned with decoded %## (plus character ‘+’ will be decoded to a space character) |
se_domain |
string |
search engine domain in a POST array |
location_code |
integer |
location code in a POST array |
language_code |
string |
language code in a POST array |
check_url |
string |
direct URL to search engine results
you can use it to make sure that we provided accurate results |
datetime |
string |
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 |
spell |
object |
autocorrection of the search engine
if the search engine provided results for a keyword that was corrected, we will specify the keyword corrected by the search engine and the type of autocorrection |
refinement_chips |
object |
search refinement chips
equals null |
item_types |
array |
types of search results in SERP
contains types of search results (items) found in SERP.
possible item types:
youtube_channel, youtube_video, youtube_video_paid, youtube_playlist |
se_results_count |
integer |
total number of results in SERP |
items_count |
integer |
the number of results returned in the items array |
items |
array |
elements of search results found in SERP |
| ‘youtube_channel’ element |
|
|
type |
string |
type of element = ‘youtube_channel’
YouTube channel related to the specified search term |
rank_group |
integer |
group rank in SERP
position within a group of elements with identical type values
positions of elements with different type values are omitted from rank_group |
rank_absolute |
integer |
absolute rank in SERP for the target domain
absolute position among all the elements in SERP |
block_rank |
integer |
block rank in SERP
position among all the blocks in SERP |
block_name |
string |
name of the block in SERP
example:
"People also watched"
|
channel_id |
string |
ID of the channel |
name |
string |
name of the channel |
url |
string |
URL of the channel |
logo |
string |
the URL of the page where the logo image is hosted |
video_count |
integer |
the number of videos counted on the channel |
is_verified |
boolean |
indicates whether the channel has a “verified” label |
description |
string |
description of the channel |
highlighted |
array |
highlighted keywords in the description |
‘youtube_video’ element |
|
|
type |
string |
type of element = ‘youtube_video’ |
rank_group |
integer |
group rank in SERP
position within a group of elements with identical type values
positions of elements with different type values are omitted from rank_group |
rank_absolute |
integer |
absolute rank in SERP for the target domain
absolute position among all the elements in SERP |
block_rank |
integer |
block rank in SERP
position among all the blocks in SERP |
block_name |
string |
name of the block in SERP
example:
"People also watched"
|
title |
string |
title of the video |
url |
string |
URL of the video |
video_id |
string |
ID of the video |
thumbnail_url |
string |
the URL of the page where the thumbnail is hosted |
channel_id |
string |
the ID of the channel where the video is published |
channel_name |
string |
the name of the channel where the video is published |
channel_url |
string |
the URL of the channel where the video is published |
channel_logo |
string |
the URL of the page where the logo image of the channel is hosted |
description |
string |
description of the video |
highlighted |
array |
highlighted keywords in the description |
badges |
array |
video badges
example:
New, CC, 4K
|
is_live |
boolean |
indicates whether the video is a live broadcast |
is_shorts |
boolean |
indicates whether the video is shorts |
is_movie |
boolean |
indicates whether the video is a movie |
views_count |
integer |
number of views of the video |
publication_date |
string |
the date when the video is published |
timestamp |
string |
date and time when the result is published
in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
example:
2022-11-15 12:57:46 +00:00
|
duration_time |
string |
duration of the video |
duration_time_seconds |
integer |
duration of the video in seconds |
‘youtube_video_paid’ element |
|
|
type |
string |
type of element = ‘youtube_video_paid’ |
rank_group |
integer |
group rank in SERP
position within a group of elements with identical type values
positions of elements with different type values are omitted from rank_group |
rank_absolute |
integer |
absolute rank in SERP for the target domain
absolute position among all the elements in SERP |
block_rank |
integer |
block rank in SERP
position among all the blocks in SERP |
block_name |
string |
name of the block in SERP
example:
"People also watched"
|
title |
string |
title of the video |
url |
string |
URL of the video |
video_id |
string |
ID of the video |
thumbnail_url |
string |
the URL of the page where the thumbnail is hosted |
channel_id |
string |
the ID of the channel where the video is published |
channel_name |
string |
the name of the channel where the video is published |
channel_url |
string |
the URL of the channel where the video is published |
channel_logo |
string |
the URL of the page where the logo image of the channel is hosted |
description |
string |
description of the video |
highlighted |
array |
highlighted keywords in the description |
badges |
array |
video badges
example:
New, CC, 4K
|
is_live |
boolean |
indicates whether the video is a live broadcast |
is_shorts |
boolean |
indicates whether the video is shorts |
is_movie |
boolean |
indicates whether the video is a movie |
views_count |
integer |
number of views of the video |
publication_date |
string |
the date when the video is published |
timestamp |
string |
date and time when the result is published
in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
example:
2022-11-15 12:57:46 +00:00
|
duration_time |
string |
duration of the video |
duration_time_seconds |
integer |
duration of the video in seconds |
‘youtube_playlist’ element |
|
|
type |
string |
type of element = ‘youtube_playlist’ |
rank_group |
integer |
group rank in SERP
position within a group of elements with identical type values
positions of elements with different type values are omitted from rank_group |
rank_absolute |
integer |
absolute rank in SERP for the target domain
absolute position among all the elements in SERP |
block_rank |
integer |
block rank in SERP
position among all the blocks in SERP |
block_name |
string |
name of the block in SERP
example:
"People also watched"
|
title |
string |
title of the video |
url |
string |
URL of the video |
playlist_id |
string |
ID of the video |
thumbnail_url |
string |
the URL of the page where the thumbnail is hosted |
channel_id |
string |
the ID of the channel where the video is published |
channel_name |
string |
the name of the channel where the video is published |
channel_url |
string |
the URL of the channel where the video is published |
channel_logo |
string |
the URL of the page where the logo image of the channel is hosted |
videos_count |
integer |
the number of videos in playlist |
preview_videos |
array |
information about preview videos
array of objects containing information about videos in the preview block of the playlist element |
video_id |
string |
ID of the video |
title |
string |
title of the video |
url |
string |
URL of the video |
duration_time |
string |
duration of the video |
duration_time_seconds |
integer |
duration of the video in seconds |