Icon

GCP Stackdriver Error Reporting (version v1.*.*)

delete_all_events

Deletes all error events of a given project.

Parameters

projectName (required)

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.

Type: string

$.xgafv

V1 error format.

Type: string

Potential values: 1, 2

access_token

OAuth access token.

Type: string

alt

Data format for response.

Type: string

Potential values: json, media, proto

callback

JSONP

Type: string

fields

Selector specifying which fields to include in a partial response.

Type: string

key

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token

OAuth 2.0 token for the current user.

Type: string

prettyPrint

Returns response with indentations and line breaks.

Type: boolean

quotaUser

Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

Type: string

uploadType

Legacy upload protocol for media (e.g. "media", "multipart").

Type: string

upload_protocol

Upload protocol for media (e.g. "raw", "multipart").

Type: string

get_group

Get the specified group.

Parameters

groupName (required)

Required. The group resource name. Written as
projects/projectID/groups/group_name.
Call

groupStats.list to return a list of groups belonging to
this project.

Example: projects/my-project-123/groups/my-group

Type: string

$.xgafv

V1 error format.

Type: string

Potential values: 1, 2

access_token

OAuth access token.

Type: string

alt

Data format for response.

Type: string

Potential values: json, media, proto

callback

JSONP

Type: string

fields

Selector specifying which fields to include in a partial response.

Type: string

key

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token

OAuth 2.0 token for the current user.

Type: string

prettyPrint

Returns response with indentations and line breaks.

Type: boolean

quotaUser

Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

Type: string

uploadType

Legacy upload protocol for media (e.g. "media", "multipart").

Type: string

upload_protocol

Upload protocol for media (e.g. "raw", "multipart").

Type: string

list_events

Lists the specified events.

Parameters

projectName (required)

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.

Type: string

$.xgafv

V1 error format.

Type: string

Potential values: 1, 2

access_token

OAuth access token.

Type: string

alt

Data format for response.

Type: string

Potential values: json, media, proto

callback

JSONP

Type: string

fields

Selector specifying which fields to include in a partial response.

Type: string

groupId

Required. The group for which events shall be returned.

Type: string

key

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token

OAuth 2.0 token for the current user.

Type: string

prettyPrint

Returns response with indentations and line breaks.

Type: boolean

quotaUser

Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

Type: string

serviceFilter.resourceType

Optional. The exact value to match against
ServiceContext.resource_type.

Type: string

serviceFilter.service

Optional. The exact value to match against
ServiceContext.service.

Type: string

serviceFilter.version

Optional. The exact value to match against
ServiceContext.version.

Type: string

timeRange.period

Restricts the query to the specified time range.

Type: string

Potential values: PERIOD_UNSPECIFIED, PERIOD_1_HOUR, PERIOD_6_HOURS, PERIOD_1_DAY, PERIOD_1_WEEK, PERIOD_30_DAYS

uploadType

Legacy upload protocol for media (e.g. "media", "multipart").

Type: string

upload_protocol

Upload protocol for media (e.g. "raw", "multipart").

Type: string

list_group_stats

Lists the specified groups.

Parameters

projectName (required)

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.

Type: string

$.xgafv

V1 error format.

Type: string

Potential values: 1, 2

access_token

OAuth access token.

Type: string

alignment

Optional. The alignment of the timed counts to be returned.
Default is ALIGNMENT_EQUAL_AT_END.

Type: string

Potential values: ERROR_COUNT_ALIGNMENT_UNSPECIFIED, ALIGNMENT_EQUAL_ROUNDED, ALIGNMENT_EQUAL_AT_END

alignmentTime

Optional. Time where the timed counts shall be aligned if rounded
alignment is chosen. Default is 00:00 UTC.

Type: string

alt

Data format for response.

Type: string

Potential values: json, media, proto

callback

JSONP

Type: string

fields

Selector specifying which fields to include in a partial response.

Type: string

groupId

Optional. List all ErrorGroupStats with these IDs.

Type: array

[ "string" ]

key

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token

OAuth 2.0 token for the current user.

Type: string

order

Optional. The sort order in which the results are returned.
Default is COUNT_DESC.

Type: string

Potential values: GROUP_ORDER_UNSPECIFIED, COUNT_DESC, LAST_SEEN_DESC, CREATED_DESC, AFFECTED_USERS_DESC

prettyPrint

Returns response with indentations and line breaks.

Type: boolean

quotaUser

Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

Type: string

serviceFilter.resourceType

Optional. The exact value to match against
ServiceContext.resource_type.

Type: string

serviceFilter.service

Optional. The exact value to match against
ServiceContext.service.

Type: string

serviceFilter.version

Optional. The exact value to match against
ServiceContext.version.

Type: string

timeRange.period

Restricts the query to the specified time range.

Type: string

Potential values: PERIOD_UNSPECIFIED, PERIOD_1_HOUR, PERIOD_6_HOURS, PERIOD_1_DAY, PERIOD_1_WEEK, PERIOD_30_DAYS

timedCountDuration

Optional. The preferred duration for a single returned TimedCount.
If not set, no timed counts are returned.

Type: string

uploadType

Legacy upload protocol for media (e.g. "media", "multipart").

Type: string

upload_protocol

Upload protocol for media (e.g. "raw", "multipart").

Type: string

report_event

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

Parameters

projectName (required)

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.

Type: string

$.xgafv

V1 error format.

Type: string

Potential values: 1, 2

$body

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

Type: object

{
"context" : {
"sourceReferences" : [ {
"revisionId" : "The canonical and persistent identifier of the deployed revision.\nExample (git): \"0035781c50ec7aa23385dc841529ce8a4b70db1b\"",
"repository" : "Optional. A URI string identifying the repository.\nExample: \"https://github.com/GoogleCloudPlatform/kubernetes.git\""
} ],
"httpRequest" : {
"referrer" : "The referrer information that is provided with the request.",
"responseStatusCode" : "The HTTP response status code for the request.",
"remoteIp" : "The IP address from which the request originated.\nThis can be IPv4, IPv6, or a token which is derived from the\nIP address, depending on the data that has been provided\nin the error report.",
"method" : "The type of HTTP request, such as `GET`, `POST`, etc.",
"userAgent" : "The user agent information that is provided with the request.",
"url" : "The URL of the request."
},
"user" : "The user who caused or was affected by the crash.\nThis can be a user ID, an email address, or an arbitrary token that\nuniquely identifies the user.\nWhen sending an error report, leave this field empty if the user was not\nlogged in. In this case the\nError Reporting system will use other data, such as remote IP address, to\ndistinguish affected users. See `affected_users_count` in\n`ErrorGroupStats`.",
"reportLocation" : {
"functionName" : "Human-readable name of a function or method.\nThe value can include optional context like the class or package name.\nFor example, `my.package.MyClass.method` in case of Java.",
"filePath" : "The source code filename, which can include a truncated relative\npath, or a full path from a production machine.",
"lineNumber" : "1-based. 0 indicates that the line number is unknown."
}
},
"eventTime" : "Optional. Time when the event occurred.\nIf not provided, the time when the event was received by the\nError Reporting system will be used.",
"message" : "Required. The error message.\nIf no `context.reportLocation` is provided, the message must contain a\nheader (typically consisting of the exception type name and an error\nmessage) and an exception stack trace in one of the supported programming\nlanguages and formats.\nSupported languages are Java, Python, JavaScript, Ruby, C#, PHP, and Go.\nSupported stack trace formats are:\n\n* **Java**: Must be the return value of\n[`Throwable.printStackTrace()`](https://docs.oracle.com/javase/7/docs/api/java/lang/Throwable.html#printStackTrace%28%29).\n* **Python**: Must be the return value of\n[`traceback.format_exc()`](https://docs.python.org/2/library/traceback.html#traceback.format_exc).\n* **JavaScript**: Must be the value of\n[`error.stack`](https://github.com/v8/v8/wiki/Stack-Trace-API) as returned\nby V8.\n* **Ruby**: Must contain frames returned by\n[`Exception.backtrace`](https://ruby-doc.org/core-2.2.0/Exception.html#method-i-backtrace).\n* **C#**: Must be the return value of\n[`Exception.ToString()`](https://msdn.microsoft.com/en-us/library/system.exception.tostring.aspx).\n* **PHP**: Must start with `PHP (Notice|Parse error|Fatal error|Warning)`\nand contain the result of\n[`(string)$exception`](http://php.net/manual/en/exception.tostring.php).\n* **Go**: Must be the return value of\n[`runtime.Stack()`](https://golang.org/pkg/runtime/debug/#Stack).",
"serviceContext" : {
"service" : "An identifier of the service, such as the name of the\nexecutable, job, or Google App Engine service name. This field is expected\nto have a low number of values that are relatively stable over time, as\nopposed to `version`, which can be changed whenever new code is deployed.\n\nContains the service name for error reports extracted from Google\nApp Engine logs or `default` if the App Engine default service is used.",
"version" : "Represents the source code version that the developer provided,\nwhich could represent a version label or a Git SHA-1 hash, for example.\nFor App Engine standard environment, the version is set to the version of\nthe app.",
"resourceType" : "Type of the MonitoredResource. List of possible values:\nhttps://cloud.google.com/monitoring/api/resources\n\nValue is set automatically for incoming errors and must not be set when\nreporting errors."
}
}

access_token

OAuth access token.

Type: string

alt

Data format for response.

Type: string

Potential values: json, media, proto

callback

JSONP

Type: string

fields

Selector specifying which fields to include in a partial response.

Type: string

key

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token

OAuth 2.0 token for the current user.

Type: string

prettyPrint

Returns response with indentations and line breaks.

Type: boolean

quotaUser

Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

Type: string

uploadType

Legacy upload protocol for media (e.g. "media", "multipart").

Type: string

upload_protocol

Upload protocol for media (e.g. "raw", "multipart").

Type: string

update_group

Replace the data for the specified group.
Fails if the group does not exist.

Parameters

name (required)

The group resource name.
Example: projects/my-project-123/groups/my-groupid

Type: string

$.xgafv

V1 error format.

Type: string

Potential values: 1, 2

$body

Description of a group of similar error events.

Type: object

{
"groupId" : "Group IDs are unique for a given project. If the same kind of error\noccurs in different service contexts, it will receive the same group ID.",
"name" : "The group resource name.\nExample: projects/my-project-123/groups/my-groupid",
"trackingIssues" : [ {
"url" : "A URL pointing to a related entry in an issue tracking system.\nExample: https://github.com/user/project/issues/4"
} ]
}

access_token

OAuth access token.

Type: string

alt

Data format for response.

Type: string

Potential values: json, media, proto

callback

JSONP

Type: string

fields

Selector specifying which fields to include in a partial response.

Type: string

key

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Type: string

oauth_token

OAuth 2.0 token for the current user.

Type: string

prettyPrint

Returns response with indentations and line breaks.

Type: boolean

quotaUser

Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

Type: string

uploadType

Legacy upload protocol for media (e.g. "media", "multipart").

Type: string

upload_protocol

Upload protocol for media (e.g. "raw", "multipart").

Type: string