Method: projects.groupStats.list

Lists the specified groups.

HTTP request

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

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

.

Query parameters

Parameters
groupId

string

[Optional] List all

ErrorGroupStats

with these IDs.

serviceFilter

object(ServiceContextFilter)

[Optional] List only

ErrorGroupStats

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 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. Only ErrorGroupStats with a non-zero count in the given time range are returned, unless the request contains an explicit groupId list. If a groupId list is given, also ErrorGroupStats with zero occurrences are returned.

timedCountDuration

string (Duration format)

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

A duration in seconds with up to nine fractional digits, terminated by 's'. Example: "3.5s".

alignment

enum(TimedCountAlignment)

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

alignmentTime

string (Timestamp format)

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

A timestamp in RFC3339 UTC "Zulu" format, accurate to nanoseconds. Example: "2014-10-02T15:01:23.045123456Z".

order

enum(ErrorGroupOrder)

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

pageSize

number

[Optional] The maximum number of results to return per response. Default is 20.

pageToken

string

[Optional] A nextPageToken provided by a previous response. To view additional results, pass this token along with the identical query parameters as the first request.

Request body

The request body must be empty.

Response body

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

Contains a set of requested error group stats.

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

object(ErrorGroupStats)

The error group stats 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. The start time is set based on the requested time range. It may be adjusted to a later time if a project has exceeded the storage quota and older data has been deleted.

A timestamp in RFC3339 UTC "Zulu" format, accurate to nanoseconds. Example: "2014-10-02T15:01:23.045123456Z".

Authorization

Requires the following OAuth scope:

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

For more information, see the Auth Guide.

TimedCountAlignment

Specifies how the time periods of error group counts are aligned.

Enums
ERROR_COUNT_ALIGNMENT_UNSPECIFIED No alignment specified.
ALIGNMENT_EQUAL_ROUNDED The time periods shall be consecutive, have width equal to the requested duration, and be aligned at the alignmentTime provided in the request. The alignmentTime does not have to be inside the query period but even if it is outside, only time periods are returned which overlap with the query period. A rounded alignment will typically result in a different size of the first or the last time period.
ALIGNMENT_EQUAL_AT_END The time periods shall be consecutive, have width equal to the requested duration, and be aligned at the end of the requested time period. This can result in a different size of the first time period.

ErrorGroupOrder

A sorting order of error groups.

Enums
GROUP_ORDER_UNSPECIFIED No group order specified.
COUNT_DESC Total count of errors in the given time window in descending order.
LAST_SEEN_DESC Timestamp when the group was last seen in the given time window in descending order.
CREATED_DESC Timestamp when the group was created in descending order.
AFFECTED_USERS_DESC Number of affected users in the given time window in descending order.

ErrorGroupStats

Data extracted for a specific group based on certain filter criteria, such as a given time period and/or service filter.

JSON representation
{
  "group": {
    object(ErrorGroup)
  },
  "count": string,
  "affectedUsersCount": string,
  "timedCounts": [
    {
      object(TimedCount)
    }
  ],
  "firstSeenTime": string,
  "lastSeenTime": string,
  "affectedServices": [
    {
      object(ServiceContext)
    }
  ],
  "numAffectedServices": number,
  "representative": {
    object(ErrorEvent)
  },
}
Fields
group

object(ErrorGroup)

Group data that is independent of the filter criteria.

count

string (int64 format)

Approximate total number of events in the given group that match the filter criteria.

affectedUsersCount

string (int64 format)

Approximate number of affected users in the given group that match the filter criteria. Users are distinguished by data in the ErrorContext of the individual error events, such as their login name or their remote IP address in case of HTTP requests. The number of affected users can be zero even if the number of errors is non-zero if no data was provided from which the affected user could be deduced. Users are counted based on data in the request context that was provided in the error report. If more users are implicitly affected, such as due to a crash of the whole service, this is not reflected here.

timedCounts[]

object(TimedCount)

Approximate number of occurrences over time. Timed counts returned by groups.list are guaranteed to be:

  • Inside the requested time interval
  • Non-overlapping, and
  • Ordered by ascending time.

firstSeenTime

string (Timestamp format)

Approximate first occurrence that was ever seen for this group and which matches the given filter criteria, ignoring the timeRange that was specified in the request.

A timestamp in RFC3339 UTC "Zulu" format, accurate to nanoseconds. Example: "2014-10-02T15:01:23.045123456Z".

lastSeenTime

string (Timestamp format)

Approximate last occurrence that was ever seen for this group and which matches the given filter criteria, ignoring the timeRange that was specified in the request.

A timestamp in RFC3339 UTC "Zulu" format, accurate to nanoseconds. Example: "2014-10-02T15:01:23.045123456Z".

affectedServices[]

object(ServiceContext)

Service contexts with a non-zero error count for the given filter criteria. This list can be truncated if multiple services are affected. Refer to numAffectedServices for the total count.

numAffectedServices

number

The total number of services with a non-zero error count for the given filter criteria.

representative

object(ErrorEvent)

An arbitrary event that is chosen as representative for the whole group. The representative event is intended to be used as a quick preview for the whole group. Events in the group are usually sufficiently similar to each other such that showing an arbitrary representative provides insight into the characteristics of the group as a whole.

TimedCount

The number of errors in a given time period. All numbers are approximate since the error events are sampled before counting them.

JSON representation
{
  "count": string,
  "startTime": string,
  "endTime": string,
}
Fields
count

string (int64 format)

Approximate number of occurrences in the given time period.

startTime

string (Timestamp format)

Start of the time period to which count refers (included).

A timestamp in RFC3339 UTC "Zulu" format, accurate to nanoseconds. Example: "2014-10-02T15:01:23.045123456Z".

endTime

string (Timestamp format)

End of the time period to which count refers (excluded).

A timestamp in RFC3339 UTC "Zulu" format, accurate to nanoseconds. Example: "2014-10-02T15:01:23.045123456Z".

Try it!

Send feedback about...

Stackdriver Error Reporting