Method: projects.events.list

Lists the specified events.

HTTP request

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

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
projectName

string

Required. The resource name of the Google Cloud Platform project. Written as projects/{projectID}, where {projectID} is the Google Cloud Platform project ID.

Example: projects/my-project-123.

Query parameters

Parameters
groupId

string

Required. The group for which events shall be returned. The groupId is a unique identifier for a particular error group. The identifier is derived from key parts of the error-log content and is treated as Service Data. For information about how Service Data is handled, see Google Cloud Privacy Notice.

serviceFilter

object (ServiceContextFilter)

Optional. List only ErrorGroups which belong to a service context that matches the filter. Data for all service contexts is returned if this field is not specified.

timeRange

object (QueryTimeRange)

Optional. List only data for the given time range. If not set a default time range is used. The field timeRangeBegin in the response will specify the beginning of this time range.

pageSize

integer

Optional. The maximum number of results to return per response.

pageToken

string

Optional. A nextPageToken provided by a previous response.

Request body

The request body must be empty.

Response body

Contains a set of requested error events.

If successful, the response body contains data with the following structure:

JSON representation
{
  "errorEvents": [
    {
      object (ErrorEvent)
    }
  ],
  "nextPageToken": string,
  "timeRangeBegin": string
}
Fields
errorEvents[]

object (ErrorEvent)

The error events which match the given request.

nextPageToken

string

If non-empty, more results are available. Pass this token, along with the same query parameters as the first request, to view the next page of results.

timeRangeBegin

string (Timestamp format)

The timestamp specifies the start time to which the request was restricted.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

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 Authentication Overview.