Get tenant-wide email reports overview

GET https://emails.routeon.io/api/v1/reports/overview

Parameters

range string query

Time range (default 30d)

7d 30d 90d

Responses

200 OK
401 Missing/invalid credentials. For API-key/session-guarded endpoints, meta.details.code is one of: missing_authorization_header (no/malformed Authorization header), jwt_invalid (expired or otherwise invalid JWT), api_key_unknown (unknown prefix, inactive/revoked key, or bad hash); the login, refresh and logout operations return 401 without details.
422 Body/query/params failed validation. meta.reason=VALIDATION_ERROR, meta.validation_error[] carries {field, message} per failure ('' field = show the message as-is). Always 422 — a request that parsed but broke a rule is never 400. Sender resolution reports through meta.details.code: invalid_from_address (the `from` string is not `local@domain` or `Name <local@domain>`), from_domain_mismatch (its domain is not a verified domain of the tenant), domain_required (neither `domain_id` nor `from` was given), sender_not_configured (no route and no default profile resolves for this send) and sender_not_found (the referenced profile id is unknown to the tenant). content_moderation_rejected: POST /transactional/send and /transactional/send-batch verify the template's active version before accepting the send, and a rejected verdict fails the request. The check cannot be switched off.

Example response · 200

{
    "status": "success",
    "http_code": 200,
    "payload": {
        "range": "7d",
        "totals": {
            "sent": 0,
            "delivered": 0,
            "opened": 0,
            "clicked": 0,
            "bounced": 0,
            "complained": 0
        },
        "series": [
            {
                "date": "2024-01-01",
                "sent": 0,
                "delivered": 0,
                "opened": 0,
                "clicked": 0,
                "bounced": 0,
                "complained": 0
            }
        ],
        "by_provider": [
            {
                "sent": 0,
                "delivered": 0,
                "opened": 0,
                "clicked": 0,
                "bounced": 0,
                "complained": 0,
                "name": "string",
                "deferred": 0
            }
        ]
    }
}

Example response · 401

{
    "status": "error",
    "http_code": 0,
    "payload": [],
    "meta": {
        "reason": "VALIDATION_ERROR",
        "validation_error": [
            {
                "field": "string",
                "message": "string"
            }
        ],
        "details": []
    }
}

Example response · 422

{
    "status": "error",
    "http_code": 0,
    "payload": [],
    "meta": {
        "reason": "VALIDATION_ERROR",
        "validation_error": [
            {
                "field": "string",
                "message": "string"
            }
        ],
        "details": []
    }
}