Skip to content
Ona API Reference
Ona Docs
API Reference
Errors

ReportErrors

errors.report_errors(ErrorReportErrorsParams**kwargs) -> object
POST/gitpod.v1.ErrorsService/ReportErrors

ReportErrors allows clients to report batches of errors that will be sent to error reporting systems. The structure is fully compatible with Sentry’s event payload format.

Use this method to:

  • Report client-side errors and exceptions
  • Track application crashes and panics
  • Send error context and metadata for debugging

Examples

  • Report a JavaScript error with Sentry-compatible structure: The service accepts events with comprehensive error information including stack traces, identity context, breadcrumbs, and metadata that align with Sentry’s event payload format.
ParametersExpand Collapse
events: Optional[Iterable[ErrorEventParam]]

Error events to be reported (batch) - now using Sentry-compatible structure

One of the following:
environment: Optional[str]

Environment (e.g., “production”, “staging”, “development”)

maxLength100
event_id: Optional[str]

Unique event identifier (required by Sentry)

maxLength32
minLength32
exceptions: Optional[List[ExceptionInfo]]

Exception information (primary error data)

mechanism: Optional[ExceptionMechanism]

Exception mechanism

data: Optional[Dict[str, str]]

Additional mechanism-specific data

description: Optional[str]

Human-readable description of the mechanism

maxLength1000
handled: Optional[bool]

Whether the exception was handled by user code

synthetic: Optional[bool]

Whether this is a synthetic exception (created by SDK)

type: Optional[str]

Type of mechanism (e.g., “generic”, “promise”, “onerror”)

maxLength100
minLength1
module: Optional[str]

Module or package where the exception type is defined

maxLength200
stacktrace: Optional[List[StackFrame]]

Stack trace frames

colno: Optional[int]

Column number in the line

formatint32
context_line: Optional[str]
maxLength1000
filename: Optional[str]

File name or path

maxLength1000
function: Optional[str]

Function name

maxLength1000
in_app: Optional[bool]

Whether this frame is in application code (vs library/framework code)

lineno: Optional[int]

Line number in the file

formatint32
module: Optional[str]

Module or package name

maxLength1000
post_context: Optional[List[str]]
pre_context: Optional[List[str]]

Source code context around the error line

vars: Optional[Dict[str, str]]

Additional frame-specific variables/locals

thread_id: Optional[str]

Thread ID if applicable

maxLength100
type: Optional[str]

Exception type/class name

maxLength200
minLength1
value: Optional[str]

Exception message/value

maxLength10000
extra: Optional[Dict[str, str]]

Additional arbitrary metadata

fingerprint: Optional[List[str]]

Custom fingerprint for grouping

identity_id: Optional[str]

Identity ID of the user (UUID)

level: Optional[ErrorLevel]

Error severity level

One of the following:
"ERROR_LEVEL_UNSPECIFIED"
"ERROR_LEVEL_DEBUG"
"ERROR_LEVEL_INFO"
"ERROR_LEVEL_WARNING"
"ERROR_LEVEL_ERROR"
"ERROR_LEVEL_FATAL"
logger: Optional[str]

Logger name

maxLength200
modules: Optional[Dict[str, str]]

Modules/dependencies information

platform: Optional[str]

Platform identifier (required by Sentry)

maxLength100
minLength1
release: Optional[str]

Release version

maxLength200
request: Optional[RequestInfo]

Request information

data: Optional[str]

Request body (truncated if large)

maxLength10000
headers: Optional[Dict[str, str]]

Request headers

method: Optional[str]

HTTP method

maxLength10
query_string: Optional[Dict[str, str]]

Query parameters

url: Optional[str]

Request URL

maxLength2000
sdk: Optional[Dict[str, str]]

SDK information

server_name: Optional[str]

Server/host name

maxLength200
tags: Optional[Dict[str, str]]

Tags for filtering and grouping

timestamp: Optional[datetime]

When the event occurred (required by Sentry)

formatdate-time
transaction: Optional[str]

Transaction name (e.g., route name, function name)

maxLength200
ReturnsExpand Collapse
object

ReportErrors

import os
from gitpod import Gitpod

client = Gitpod(
    bearer_token=os.environ.get("GITPOD_API_KEY"),  # This is the default and can be omitted
)
response = client.errors.report_errors()
print(response)
{}
Returns Examples
{}