Instead of ‘login’ and ‘password’ use your credentials from https://app.dataforseo.com/api-access
<?php // You can download this file from here https://cdn.dataforseo.com/v3/examples/php/php_RestClient.zip require('RestClient.php'); $api_url = 'https://api.dataforseo.com/'; try { // Instead of 'login' and 'password' use your credentials from https://app.dataforseo.com/api-access $client = new RestClient($api_url, null, 'login', 'password'); } catch (RestClientException $e) { echo "n"; print "HTTP code: {$e->getHttpCode()}n"; print "Error code: {$e->getCode()}n"; print "Message: {$e->getMessage()}n"; print $e->getTraceAsString(); echo "n"; exit(); } try { $result = array(); // #1 - using this method you can get a list of completed tasks // GET /v3/serp/youtube/organic/tasks_ready // in addition to 'youtube' and 'organic' you can also set other search engine and type parameters // the full list of possible parameters is available in documentation $tasks_ready = $client->get('/v3/serp/youtube/organic/tasks_ready'); // you can find the full list of the response codes here https://docs.dataforseo.com/v3/appendix/errors if (isset($tasks_ready['status_code']) AND $tasks_ready['status_code'] === 20000) { foreach ($tasks_ready['tasks'] as $task) { if (isset($task['result'])) { foreach ($task['result'] as $task_ready) { // #2 - using this method you can get results of each completed task // GET /v3/serp/youtube/organic/task_get/advanced/$id if (isset($task_ready['endpoint_advanced'])) { $result[] = $client->get($task_ready['endpoint_advanced']); } // #3 - another way to get the task results by id // GET /v3/serp/youtube/organic/task_get/advanced/$id /* if (isset($task_ready['id'])) { $result[] = $client->get('/v3/serp/youtube/organic/task_get/advanced/' . $task_ready['id']); } */ } } } } print_r($result); // do something with result } catch (RestClientException $e) { echo "n"; print "HTTP code: {$e->getHttpCode()}n"; print "Error code: {$e->getCode()}n"; print "Message: {$e->getMessage()}n"; print $e->getTraceAsString(); echo "n"; } $client = null; ?>
The above command returns JSON structured like this:
{ "version": "0.1.20221214", "status_code": 20000, "status_message": "Ok.", "time": "0.0791 sec.", "cost": 0, "tasks_count": 1, "tasks_error": 0, "tasks": [ { "id": "12301635-1535-0066-0000-93599fca9d02", "status_code": 20000, "status_message": "Ok.", "time": "0.0276 sec.", "cost": 0, "result_count": 1, "path": [ "v3", "serp", "youtube", "organic", "task_get", "advanced", "12301635-1535-0066-0000-93599fca9d02" ], "data": { "api": "serp", "function": "task_get", "se": "youtube", "se_type": "organic", "language_code": "en", "location_code": 2840, "keyword": "audi", "priority": 2, "device": "desktop", "os": "windows" }, "result": [ { "keyword": "audi", "se_domain": "youtube.com", "location_code": 2840, "language_code": "en", "check_url": "https://www.youtube.com/results?search_query=audi", "datetime": "2022-12-30 14:43:11 +00:00", "spell": null, "refinement_chips": null, "item_types": [ "youtube_video", "youtube_channel" ], "se_results_count": 32447281, "items_count": 66, "items": [ { "type": "youtube_video", "rank_group": 1, "rank_absolute": 1, "block_rank": 1, "block_name": null, "title": "The 2023 Audi Q7 55 TFSI Is An Ultra Quiet & Comfortable Luxury 3-Row SUV", "url": "https://www.youtube.com/watch?v=lrPvFuz8Leg", "video_id": "lrPvFuz8Leg", "thumbnail_url": "https://i.ytimg.com/vi/lrPvFuz8Leg/hq720.jpg?sqp=-oaymwEcCNAFEJQDSFXyq4qpAw4IARUAAIhCGAFwAcABBg==&rs=AOn4CLC4RyEK7ntuK_hkLAMXOdFmcZNz6w", "channel_id": "UC2MrtVb1dT4FhcbOlW736kA", "channel_name": "Redline Reviews", "channel_url": "https://www.youtube.com/@theredline", "channel_logo": "https://yt3.ggpht.com/R90alWqdmbF6Z_Hj6qZ3KaI7HDRMfFIfrdOgwLyXCii6GUuiW1YJs-2JDyRiDKoc8R-_X0nGPdQ=s68-c-k-c0x00ffffff-no-rj", "description": "When you need an # Audi vehicle with 3-rows of seating, the #AudiQ7 is the only vehicle in the lineup that can fit that bill. For 2023 ...", "highlighted": [ "Audi" ], "badges": [ "New", "4K" ], "is_live": false, "is_shorts": false, "is_movie": null, "views_count": 1004, "publication_date": "43 minutes ago", "timestamp": "2022-12-30 14:12:23 +00:00", "duration_time": "23:26", "duration_time_seconds": 1406 }, { "type": "youtube_channel", "rank_group": 1, "rank_absolute": 9, "block_rank": 1, "block_name": null, "channel_id": "UCO5ujNeWRIwP4DbCZqZWcLw", "name": "Audi", "url": "https://www.youtube.com/@Audi", "logo": "https://yt3.googleusercontent.com/ytc/AMLnZu_iyn_apm6S6bi0P-nBUNil4mgAum9opQJGWeea=s176-c-k-c0x00ffffff-no-rj-mo", "video_count": 0, "is_verified": true, "description": "The official Audi YouTube Channel. From the beginning, advanced technology has been at the very heart of the Audi DNA.", "highlighted": [ "Audi", "Audi" ] }, { "type": "youtube_playlist", "rank_group": 2, "rank_absolute": 3, "block_rank": 3, "block_name": null, "title": "McQueen Car Assembly Surprise Soccer Ball | Street Vehicle with Learn Colors for Kids", "url": "https://www.youtube.com/playlist?list=PLeeA6TGUlbkZBi7TYks-CbPnFMsjjB5Be", "playlist_id": "PLeeA6TGUlbkZBi7TYks-CbPnFMsjjB5Be", "thumbnail_url": "https://i.ytimg.com/vi/i2mV0LApDTA/hqdefault.jpg?sqp=-oaymwEXCNACELwBSFryq4qpAwkIARUAAIhCGAE=&rs=AOn4CLAbEK6cprhXavg6sjhL92EleU9O9w", "channel_id": "UCxaux2CGJvqAkGn5ohSQxdA", "channel_name": "Tech Editing info Master", "channel_url": "https://www.youtube.com/channel/UCxaux2CGJvqAkGn5ohSQxdA", "channel_logo": null, "videos_count": 81, "preview_videos": [ { "video_id": "i2mV0LApDTA", "title": "McQueen Car Assembly Surprise Soccer Ball | Street Vehicle with Learn Colors for Kids", "url": "https://www.youtube.com/watch?v=i2mV0LApDTA&list=PLeeA6TGUlbkZBi7TYks-CbPnFMsjjB5Be", "duration_time": "10:08", "duration_time_second": 608 }, { "video_id": "-tAQGxcRaaI", "title": "Learn Colors with Dump truck & Soccer Balls | Learning Videos for Children | Cartoons for Kids", "url": "https://www.youtube.com/watch?v=-tAQGxcRaaI&list=PLeeA6TGUlbkZBi7TYks-CbPnFMsjjB5Be", "duration_time": "2:01", "duration_time_second": 121 } ] } ] } ] } ] }
Description of the fields for sending a request:
Field name | Type | Description |
---|---|---|
id |
string | 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 |
As a response of the API server, you will receive JSON-encoded data containing a tasks
array with the information specific to the set tasks.
You can also get all available SERP features and possible extra elements by making a request to the following Sandbox URL:
https://sandbox.dataforseo.com/v3/serp/youtube/organic/task_get/advanced/00000000-0000-0000-0000-000000000000
The response will include all available items in the YouTube Organic SERP Advanced endpoint with the fields containing dummy data.
You won’t be charged for using Sandbox endpoints.
Description of the fields in the results array:
Field name | Type | Description |
---|---|---|
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 symbol ‘+’ 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 |
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 valuespositions 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 valuespositions 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 valuespositions 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 valuespositions 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 |