Overview of API resources

API resources

The table below shows the list of the Yandex.Webmaster API resources and operations with them:

URI GET POST DELETE
/user/ Getting the user ID
/user/{user-id}/hosts/ Getting the list of the user's sites Adding a site
/user/{user-id}/hosts/{host-id}/ Getting site information Deleting a site
/user/{user-id}/hosts/{host-id}/summary/ Getting site statistics
/user/{user-id}/hosts/{host-id}/important-urls/ Monitoring important pages
/user/{user-id}/hosts/{host-id}/important-urls/history/ Getting the history of changes to an important page
/user/{user-id}/hosts/{host-id}/verification/ Getting the site verification information Starting the rights verification process
/user/{user-id}/hosts/{host-id}/owners/ Getting a list of users who verified their rights to manage the site
/user/{user-id}/hosts/{host-id}/sitemaps/ Getting the list of Sitemap files
/user/{user-id}/hosts/{host-id}/sitemaps/{sitemap-id}/ Getting information about the Sitemap file
/user/{user-id}/hosts/{host-id}/user-added-sitemaps/ Getting the list of Sitemap files added by the user Adding a Sitemap file
/user/{user-id}/hosts/{host-id}/user-added-sitemaps/{sitemap-id}/ Getting information about the Sitemap added by the user Removing a Sitemap file
/user/{user-id}/hosts/{host-id}/sqi_history/ Getting the history of SQI changes
/user/{user-id}/hosts/{host-id}/search-queries/popular/ Getting information about popular search queries
/user/{user-id}/hosts/{host-id}/search-queries/all/history/

Getting general statistics for all search queries

/user/{user-id}/hosts/{host-id}/search-queries/{query-id}/history/ Getting general statistics for a search query
/user/{user-id}/hosts/{host-id}/recrawl/queue/ Getting a list of tasks for reindexing Sending a page for reindexing
/user/{user-id}/hosts/{host-id}/recrawl/quota/ Checking the reindexing quota
/user/{user-id}/hosts/{host-id}/recrawl/queue/{task-id}/ Checking the reindexing task status
/user/{user-id}/hosts/{host-id}/diagnostics/ Site diagnostics
/user/{user-id}/hosts/{host-id}/indexing/history/ Getting the site indexing history
/user/{user-id}/hosts/{host-id}/indexing/samples/ Viewing examples of downloaded pages
/user/{user-id}/hosts/{host-id}/search-urls/in-search/history/ Getting the history of changes in the number of pages in search
/user/{user-id}/hosts/{host-id}/search-urls/in-search/samples/ Viewing example pages in search
/user/{user-id}/hosts/{host-id}/search-urls/events/history/ Getting the history of pages added to and removed from search results
/user/{user-id}/hosts/{host-id}/search-urls/events/samples/ Viewing examples of pages that appeared in search or were removed from search
/user/{user-id}/hosts/{host-id}/links/internal/broken/samples/ Getting information about broken internal links on the site
/user/{user-id}/hosts/{host-id}/links/internal/broken/history/ Getting the history of changes in the number of broken internal links on the site
/user/{user-id}/hosts/{host-id}/links/external/samples/ Getting information about external links to the site
/user/{user-id}/hosts/{host-id}/links/external/history/ Getting the history of changes in the number of external links to the site
URI GET POST DELETE
/user/ Getting the user ID
/user/{user-id}/hosts/ Getting the list of the user's sites Adding a site
/user/{user-id}/hosts/{host-id}/ Getting site information Deleting a site
/user/{user-id}/hosts/{host-id}/summary/ Getting site statistics
/user/{user-id}/hosts/{host-id}/important-urls/ Monitoring important pages
/user/{user-id}/hosts/{host-id}/important-urls/history/ Getting the history of changes to an important page
/user/{user-id}/hosts/{host-id}/verification/ Getting the site verification information Starting the rights verification process
/user/{user-id}/hosts/{host-id}/owners/ Getting a list of users who verified their rights to manage the site
/user/{user-id}/hosts/{host-id}/sitemaps/ Getting the list of Sitemap files
/user/{user-id}/hosts/{host-id}/sitemaps/{sitemap-id}/ Getting information about the Sitemap file
/user/{user-id}/hosts/{host-id}/user-added-sitemaps/ Getting the list of Sitemap files added by the user Adding a Sitemap file
/user/{user-id}/hosts/{host-id}/user-added-sitemaps/{sitemap-id}/ Getting information about the Sitemap added by the user Removing a Sitemap file
/user/{user-id}/hosts/{host-id}/sqi_history/ Getting the history of SQI changes
/user/{user-id}/hosts/{host-id}/search-queries/popular/ Getting information about popular search queries
/user/{user-id}/hosts/{host-id}/search-queries/all/history/

Getting general statistics for all search queries

/user/{user-id}/hosts/{host-id}/search-queries/{query-id}/history/ Getting general statistics for a search query
/user/{user-id}/hosts/{host-id}/recrawl/queue/ Getting a list of tasks for reindexing Sending a page for reindexing
/user/{user-id}/hosts/{host-id}/recrawl/quota/ Checking the reindexing quota
/user/{user-id}/hosts/{host-id}/recrawl/queue/{task-id}/ Checking the reindexing task status
/user/{user-id}/hosts/{host-id}/diagnostics/ Site diagnostics
/user/{user-id}/hosts/{host-id}/indexing/history/ Getting the site indexing history
/user/{user-id}/hosts/{host-id}/indexing/samples/ Viewing examples of downloaded pages
/user/{user-id}/hosts/{host-id}/search-urls/in-search/history/ Getting the history of changes in the number of pages in search
/user/{user-id}/hosts/{host-id}/search-urls/in-search/samples/ Viewing example pages in search
/user/{user-id}/hosts/{host-id}/search-urls/events/history/ Getting the history of pages added to and removed from search results
/user/{user-id}/hosts/{host-id}/search-urls/events/samples/ Viewing examples of pages that appeared in search or were removed from search
/user/{user-id}/hosts/{host-id}/links/internal/broken/samples/ Getting information about broken internal links on the site
/user/{user-id}/hosts/{host-id}/links/internal/broken/history/ Getting the history of changes in the number of broken internal links on the site
/user/{user-id}/hosts/{host-id}/links/external/samples/ Getting information about external links to the site
/user/{user-id}/hosts/{host-id}/links/external/history/ Getting the history of changes in the number of external links to the site