Method: projects.events.report

• HTTP request
• Path parameters
• Request body
• Response body
• Authorization Scopes
• ReportedErrorEvent
  • JSON representation
• Try it!

Report an individual error event.

This endpoint accepts either an OAuth token, or an API key for authentication. To use an API key, append it to the URL as the value of a key parameter. For example:

POST https://clouderrorreporting.googleapis.com/v1beta1/projects/example-project/events:report?key=123ABC456

HTTP request

POST https://clouderrorreporting.googleapis.com/v1beta1/{projectName=projects/*}/events:report

The URL uses Google API HTTP annotation syntax.

Path parameters

Parameters
projectName	string [Required] The resource name of the Google Cloud Platform project. Written as projects/ plus the Google Cloud Platform project ID. Example: projects/my-project-123.

Request body

The request body contains an instance of ReportedErrorEvent.

Response body

If successful, the response body will be empty.

Authorization Scopes

Requires one of the following OAuth scopes:

• https://www.googleapis.com/auth/cloud-platform
• https://www.googleapis.com/auth/stackdriver-integration

For more information, see the Auth Guide.

ReportedErrorEvent

An error event which is reported to the Error Reporting system.

JSON representation
{ "eventTime": string, "serviceContext": { object(ServiceContext) }, "message": string, "context": { object(ErrorContext) } }

Fields
eventTime	string (Timestamp format) [Optional] Time when the event occurred. If not provided, the time when the event was received by the Error Reporting system will be used. A timestamp in RFC3339 UTC "Zulu" format, accurate to nanoseconds. Example: "2014-10-02T15:01:23.045123456Z".
serviceContext	object(ServiceContext) [Required] The service context in which this error has occurred.
message	string [Required] The error message. If no context.reportLocation is provided, the message must contain a header (typically consisting of the exception type name and an error message) and an exception stack trace in one of the supported programming languages and formats. Supported languages are Java, Python, JavaScript, Ruby, C#, PHP, and Go. Supported stack trace formats are: Java: Must be the return value of Throwable.printStackTrace(). Python: Must be the return value of traceback.format_exc(). JavaScript: Must be the value of error.stack as returned by V8. Ruby: Must contain frames returned by Exception.backtrace. C#: Must be the return value of Exception.ToString(). PHP: Must start with PHP (Notice|Parse error|Fatal error|Warning) and contain the result of (string)$exception. Go: Must be the return value of runtime.Stack().
context	object(ErrorContext) [Optional] A description of the context in which the error occurred.

Try it!