List Activities
const url = 'https://example.com/observability/v1/activities';const options = {method: 'GET'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request GET \ --url https://example.com/observability/v1/activitiesReturns a page of activity records filtered by AIP-160 expression and ordered per AIP-132.
Parameters
Section titled “ Parameters ”Query Parameters
Section titled “Query Parameters ”The maximum number of activities to return. The service may return fewer than this value. If unspecified, at most 20 activities will be returned. The maximum value is 100; values above 100 will be coerced to 100.
A page token, received from a previous ListActivities call.
AIP-160 filter expression. Filterable fields: action, create_time, id, occur_time, principal_id, resource_type, scope_id, scope_type, source_operation_id, trace_id.
AIP-132 order_by expression. Sortable fields: action, create_time, occur_time, resource_type.
AIP-158 offset mode: number of resources to skip from the start of the filtered, sorted set. Use EITHER skip (offset paging) OR page_token (cursor paging) — never both in the same request. Supplying both is an invalid request. Default 0 (no skip).
Responses
Section titled “ Responses ”OK
ListActivitiesResponse
Response message for ListActivities.
object
The list of activities.
ActivityRecord
A read-only audit projection of a single platform activity. Each record is derived from the operation that produced it; it is addressed by its own id (and its source operation id), and carries no engine axis.
object
The unique identifier of the activity record.
The identifier of the operation that produced this activity.
The individual — a person or a robot — who performed or triggered the activity. Empty for system-driven activity that no principal initiated.
The type of resource the activity acted upon.
The action performed.
The category of scope the activity ran in or was triggered from. OBSERVABILITY_SCOPE_TYPE_UNSPECIFIED when the activity is not scoped.
The resource id of that scope — for example, when scope_type is OBSERVABILITY_SCOPE_TYPE_WORKSPACE this is the workspace id. Empty for OBSERVABILITY_SCOPE_TYPE_PLATFORM or when the activity is not scoped.
The distributed trace identifier correlating this activity.
When the activity occurred.
The opaque JSON audit snapshot captured for this activity.
When the record was created.
A token, which can be sent as page_token to retrieve the next page.
If this field is empty, there are no subsequent pages.
Exact count of resources matching the request’s filter and scope (both pagination modes).
Example
{ "activities": [ { "scope_type": "OBSERVABILITY_SCOPE_TYPE_UNSPECIFIED" } ]}default
Section titled “default ”Default error response
The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC. Each Status message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the API Design Guide.
object
The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].
A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.
A list of messages that carry the error details. There is a common set of message types for APIs to use.
Contains an arbitrary serialized message along with a @type that describes the type of the serialized message.
object
The type of the serialized message.
Example generated
{ "code": 1, "message": "example", "details": [ { "@type": "example" } ]}