Skip to content

omnireach/bing-webmaster API reference

Floor
Provider · Omnireach
Version
1.x
Conformance suite
not wired
Verified for real
Verified in part
Licence
MIT
composer require omnireach/bing-webmaster:1.x-dev

Read from the package's own PHP files at the commit 02a2944213b9: its namespaces, classes, interfaces and enums, their public constants, properties and methods with their PHPDoc, and the options its factories take. Nothing of it is run.

Omnireach\BingWebmaster

  • BingWebmasterFactory class

    Bing Webmaster Tools, from its options:

    3 options · 1 method

  • BingWebmasterProvider class

    The Bing Webmaster API (https://learn.microsoft.com/en-us/dotnet/api/microsoft.bing.webmaster.api.interfaces.iwebmasterapi): GET GetQueryStats, GetPageStats and GetRankAndTrafficStats with the site's URL and the API key. Bing answers with its own periods (a row per week, about six months back); the rows in the query's days are kept, summed over the period unless the date is asked for.

    5 methods

Omnireach\BingWebmaster

BingWebmasterFactory class

final class BingWebmasterFactory extends ProviderFactory BingWebmasterFactory.php:18

Bing Webmaster Tools, from its options:

api_key the API key (Bing Webmaster Tools, Settings, API access) site the site as verified there ("https://example.org/") url https://ssl.bing.com/webmaster/api.svc/json

Options

OptionDefault
url'https://ssl.bing.com/webmaster/api.svc/json'
api_keyrequired
siterequired

BingWebmasterFactory::__construct()

public function __construct(readonly ?HttpClientInterface $http = null)

BingWebmasterProvider class

final class BingWebmasterProvider implements SearchPerformanceInterface BingWebmasterProvider.php:24

The Bing Webmaster API (https://learn.microsoft.com/en-us/dotnet/api/microsoft.bing.webmaster.api.interfaces.iwebmasterapi): GET GetQueryStats, GetPageStats and GetRankAndTrafficStats with the site's URL and the API key. Bing answers with its own periods (a row per week, about six months back); the rows in the query's days are kept, summed over the period unless the date is asked for.

BingWebmasterProvider::__construct()

public function __construct(HttpClientInterface $http, readonly string $apiKey, readonly string $site, readonly string $url = 'https://ssl.bing.com/webmaster/api.svc/json')

BingWebmasterProvider::getName()

public function getName(): string

BingWebmasterProvider::getTitle()

public function getTitle(): string

BingWebmasterProvider::capabilities()

public function capabilities(): Capabilities

BingWebmasterProvider::searchPerformance()

public function searchPerformance(ReachQuery $query): Report