Payload

Endpoint

POST https://ingress.flareapp.io/v1/errors

Headers

Authentication

Authenticate using your project's API key in the x-api-token header. Both the private and public API key can be used for this endpoint.

Payload

overriddenGrouping Values

By default, Flare groups errors by exception class and the top application frame in the stacktrace. Set overriddenGrouping to override this with a different strategy:

Events

Spans and span events are combined into a single events array on the root payload. Spans represent operations with a duration (e.g. a query or HTTP request) and have both a start and end time. Span events represent point-in-time occurrences (e.g. a log entry or cache hit) and only have a start time, endTimeUnixNano is always null. For the full list of types and their attributes, see Events.

Stacktrace Frames

Arguments

Each entry in the arguments array:

Argument value Reduction Guidelines

Arguments must be reduced to JSON-serializable values before sending. The exact reduction strategy is up to the implementer, but the following guidelines should be followed:

• Primitive values (int, float, bool, string, null) should be kept as-is.
• Large arrays should be truncated to a reasonable size (e.g. 25 items) and truncated set to true.
• Nested arrays should be recursively reduced.
• Objects that cannot be safely serialized should be reduced to a string representation, with the original type stored in original_type.
• Sensitive values (passwords, tokens, secrets) should never be sent. Replace them with a placeholder string.
• Closures and callbacks should be reduced to their source location if possible.
• Keep the total payload size in mind. Argument data is one of the first things trimmed when the payload exceeds the size limit.

Solutions

Responses

All responses include CORS headers (Access-Control-Allow-Origin: *) and return application/json.

All error responses follow this structure:

{
    "message": "Description of the error",
    "errors": {}
}

Example

{
    "exceptionClass": "App\\Exceptions\\PaymentFailedException",
    "seenAtUnixNano": 1710252000000000000,
    "message": "Payment declined by gateway",
    "code": "402",
    "applicationPath": "/var/www/app",
    "openFrameIndex": 0,
    "sourcemapVersionId": null,
    "trackingUuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "handled": false,
    "overriddenGrouping": null,
    "attributes": {
        "service.name": "My Application",
        "service.version": "1.0.0",
        "service.stage": "production",
        "telemetry.sdk.language": "PHP",
        "telemetry.sdk.name": "spatie/flare-client-php",
        "telemetry.sdk.version": "1.0.0",
        "flare.language.name": "PHP",
        "flare.language.version": "8.4.0",
        "flare.framework.name": "Laravel",
        "flare.framework.version": "12.0.0",
        "host.name": "web-01",
        "host.arch": "arm64",
        "os.type": "linux",
        "os.name": "Ubuntu",
        "git.hash": "abc123",
        "git.branch": "main",
        "flare.entry_point.type": "web",
        "flare.entry_point.value": "https://example.com/checkout",
        "flare.entry_point.class": "App\\Http\\Controllers\\CheckoutController",
        "url.full": "https://example.com/checkout",
        "url.scheme": "https",
        "url.path": "/checkout",
        "http.request.method": "POST",
        "http.route": "checkout",
        "http.request.body.size": 256,
        "client.address": "192.168.1.1",
        "user_agent.original": "Mozilla/5.0",
        "laravel.route.name": "checkout.store",
        "laravel.route.action": "App\\Http\\Controllers\\CheckoutController@store"
    },
    "events": [
        {
            "type": "php_query",
            "startTimeUnixNano": 1710251999500000000,
            "endTimeUnixNano": 1710251999800000000,
            "attributes": {
                "db.system": "mysql",
                "db.statement": "select * from `orders` where `id` = ?",
                "db.sql.bindings": [42]
            }
        },
        {
            "type": "php_log",
            "startTimeUnixNano": 1710251999900000000,
            "endTimeUnixNano": null,
            "attributes": {
                "log.message": "Processing payment for order 42",
                "log.level": "info"
            }
        }
    ],
    "stacktrace": [
        {
            "file": "/var/www/app/Services/PaymentService.php",
            "lineNumber": 45,
            "method": "charge",
            "class": "App\\Services\\PaymentService",
            "isApplicationFrame": true,
            "codeSnippet": {
                "43": "    $response = $gateway->charge($amount);",
                "44": "    if (! $response->successful()) {",
                "45": "        throw new PaymentFailedException($response->message());",
                "46": "    }",
                "47": ""
            },
            "arguments": [
                {
                    "name": "$amount",
                    "value": 2999,
                    "original_type": "int",
                    "passed_by_reference": false,
                    "is_variadic": false,
                    "truncated": false
                }
            ]
        },
        {
            "file": "/var/www/app/Http/Controllers/CheckoutController.php",
            "lineNumber": 32,
            "method": "store",
            "class": "App\\Http\\Controllers\\CheckoutController",
            "isApplicationFrame": true,
            "codeSnippet": null,
            "arguments": null
        }
    ],
    "solutions": [
        {
            "class": "App\\Solutions\\RetryPaymentSolution",
            "title": "Retry the payment",
            "description": "The payment gateway returned a temporary error. Try again.",
            "links": {},
            "actionDescription": null,
            "isRunnable": false,
            "aiGenerated": false
        }
    ]
}