Skip to content

omnireach/plausible API reference

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

Read from the package's own PHP files at the commit b4209dd29826: 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\Plausible

  • PlausibleFactory class

    Plausible, from its options:

    3 options · 1 method

  • PlausibleProvider class

    Plausible's Stats API v2 (https://plausible.io/docs/stats-api): POST /api/v2/query with a bearer key - metrics, a date range, dimensions, "is" filters, pages of results.

    5 methods

Omnireach\Plausible

PlausibleFactory class

final class PlausibleFactory extends ProviderFactory PlausibleFactory.php:18

Plausible, from its options:

api_key a Stats API key (account settings, "API Keys") site the site's domain as Plausible knows it ("example.org") url https://plausible.io, or a self-hosted Community Edition

Options

OptionDefault
url'https://plausible.io'
api_keyrequired
siterequired

PlausibleFactory::__construct()

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

PlausibleProvider class

final class PlausibleProvider implements AudienceInterface PlausibleProvider.php:20

Plausible's Stats API v2 (https://plausible.io/docs/stats-api): POST /api/v2/query with a bearer key - metrics, a date range, dimensions, "is" filters, pages of results.

PlausibleProvider::__construct()

public function __construct(HttpClientInterface $http, readonly string $apiKey, readonly string $site, readonly string $url = 'https://plausible.io')

PlausibleProvider::getName()

public function getName(): string

PlausibleProvider::getTitle()

public function getTitle(): string

PlausibleProvider::capabilities()

public function capabilities(): Capabilities

PlausibleProvider::audience()

public function audience(ReachQuery $query): Report