Skip to content

Events_ListActivityFacets_Account

GET
/v1/accounts/{account}/events:activityFacets
curl --request GET \
--url https://junction-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.

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
One of:
API error

A refusal from the API itself.

object
code
required

The gRPC code name in upper case, e.g. NOT_FOUND.

string
message
required
string
retryable
required

Whether the same call may succeed if retried.

boolean
details
required

Empty, except when a dataset copy or move is refused: then one google.rpc.ErrorInfo with the refusal’s reason code, its domain and, in metadata, the datasets it names.

Array<object>
object
Example generated
{
"code": "example",
"message": "example",
"retryable": true,
"details": [
{}
]
}