Skip to content

Events_ListActivityFacets_Account

GET
/v1/accounts/{account}/events:activityFacets
curl --request GET \
--url https://dev-api.qualiastudios.dev/v1/accounts/example/events:activityFacets \
--header 'X-API-Key: <X-API-Key>'

Lists the values the TEAM_ACTIVITY list holds for a filter, with counts: the suggestions a search box offers under each key.

account
required
string

The account id.

filter
string

A ListEvents TEAM_ACTIVITY filter. The whole filter applies: after verb = EDIT the verbs are only EDIT.

OK

Media type application/json

The values the newest eligible actions hold, each with how many of them hold it, most first. Ids only: names come from ReadActivityActors (by sample_event) and from the workspaces the caller reads. (— api-linter: core::0132::response-unknown-fields=disabled api-linter: core::0158::response-next-page-token-field=disabled aip.dev/not-precedent: counts per facet, not a page of resources. —)

object
verbs

Verb names (ActivitySummary.Verb).

Array<object>

One value of a facet.

object
value

The value, as the filter takes it.

string
count

Actions holding it.

string
sampleEvent

The newest of those actions, for people and keys: pass it to ReadActivityActors for the name. Empty otherwise.

string
actors

Summary actor kinds (ActivityActor.Kind).

Array<object>

One value of a facet.

object
value

The value, as the filter takes it.

string
count

Actions holding it.

string
sampleEvent

The newest of those actions, for people and keys: pass it to ReadActivityActors for the name. Empty otherwise.

string
people

People (actor.user ids) who acted without a key.

Array<object>

One value of a facet.

object
value

The value, as the filter takes it.

string
count

Actions holding it.

string
sampleEvent

The newest of those actions, for people and keys: pass it to ReadActivityActors for the name. Empty otherwise.

string
keys

Keys (actor.api_key ids).

Array<object>

One value of a facet.

object
value

The value, as the filter takes it.

string
count

Actions holding it.

string
sampleEvent

The newest of those actions, for people and keys: pass it to ReadActivityActors for the name. Empty otherwise.

string
subjectTypes

Subject types (dataset, episode, task, …).

Array<object>

One value of a facet.

object
value

The value, as the filter takes it.

string
count

Actions holding it.

string
sampleEvent

The newest of those actions, for people and keys: pass it to ReadActivityActors for the name. Empty otherwise.

string
workspaces

Workspace ids; set for an organization only. The organization’s own actions have none.

Array<object>

One value of a facet.

object
value

The value, as the filter takes it.

string
count

Actions holding it.

string
sampleEvent

The newest of those actions, for people and keys: pass it to ReadActivityActors for the name. Empty otherwise.

string
truncated

True when more actions matched than the counts cover.

boolean
scanned

How many actions the counts cover: the newest ones, at most 5000.

integer format: int32
Example generated
{
"verbs": [
{
"value": "example",
"count": "example",
"sampleEvent": "example"
}
],
"actors": [
{
"value": "example",
"count": "example",
"sampleEvent": "example"
}
],
"people": [
{
"value": "example",
"count": "example",
"sampleEvent": "example"
}
],
"keys": [
{
"value": "example",
"count": "example",
"sampleEvent": "example"
}
],
"subjectTypes": [
{
"value": "example",
"count": "example",
"sampleEvent": "example"
}
],
"workspaces": [
{
"value": "example",
"count": "example",
"sampleEvent": "example"
}
],
"truncated": true,
"scanned": 1
}

Default error response

Media type application/json

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
code

The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].

integer format: int32
message

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.

string
details

A list of messages that carry the error details. There is a common set of message types for APIs to use.

Array<object>

Contains an arbitrary serialized message along with a @type that describes the type of the serialized message.

object
@type

The type of the serialized message.

string
key
additional properties
any
Example generated
{
"code": 1,
"message": "example",
"details": [
{
"@type": "example"
}
]
}