Skip to content

Added updated list of dimensions #952

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
oleksandr-mykhailenko merged 1 commit into from
Mar 25, 2026
Merged

Added updated list of dimensions #952

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 22 additions & 2 deletions src/Api/Metrics.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,27 @@
*/
class Metrics extends HttpApi
{
/**
* Valid dimensions for metrics queries
* @see https://documentation.mailgun.com/docs/mailgun/user-manual/reporting/dimensions
*/
private const VALID_DIMENSIONS = [
'bot',
'country',
'time',
'domain',
'ip',
'ip_pool',
'recipient_domain',
'recipient_provider',
'tag',
'subaccount',
'device',
'browser',
'os',
'mailbox_provider',
];

/**
* Query metrics for the total account.
*
Expand Down Expand Up @@ -58,9 +79,8 @@ public function loadMetrics(array $payload = [], array $requestHeaders = []): Me
// Validate dimensions (must be an array and contain only valid values)
if (isset($payload['dimensions'])) {
Assert::isArray($payload['dimensions'], 'Dimensions must be an array');
$validDimensions = ['time', 'domain', 'ip', 'ip_pool', 'recipient_domain', 'tag', 'country', 'subaccount'];
foreach ($payload['dimensions'] as $dimension) {
Assert::oneOf($dimension, $validDimensions, "Invalid dimension: $dimension");
Assert::oneOf($dimension, self::VALID_DIMENSIONS, "Invalid dimension: $dimension");
}
}

Expand Down
Loading