Skip to main content
POST
ListActors

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

compute_sort_needs_platform // sorting by compute needs a platform

until
string<date-time>

The window ends at the start of this hour, exclusive. Unset is the current hour.

Examples:

"2023-01-15T01:30:15.01Z"

"2024-12-25T12:00:00Z"

windowDays
integer

The window's length in days, back from until. Unset is 30.

Required range: x <= 92
selection
public_query · object

Only the access to these entities, such as a data product's. Unset is the whole workspace. Under a selection an actor is its access to the selected entities: its reads, inputs and writes and its shares of their cost, with no queries and no weights. A selection of more than 50,000 entities, counting the entities each is the same as, is refused with INVALID_ARGUMENT.

kinds
enum<string>[]

Only actors of these kinds. Empty is every kind the caller may see.

Maximum array length: 5

ActorKind is what an actor of ListActors is.

Available options:
ACTOR_KIND_UNSPECIFIED,
ACTOR_KIND_COALESCE,
ACTOR_KIND_SERVICE_ACCOUNT,
ACTOR_KIND_TOOL,
ACTOR_KIND_PERSON,
ACTOR_KIND_LOGIN
sort
enum<string>

ActorSort is the order of ListActors, highest first, then by kind and actor.

Available options:
ACTOR_SORT_UNSPECIFIED,
ACTOR_SORT_ACCESS,
ACTOR_SORT_QUERIES,
ACTOR_SORT_READS,
ACTOR_SORT_WRITES,
ACTOR_SORT_COMPUTE
platform
enum<string>

The platform ACTOR_SORT_COMPUTE sorts on and compute_fraction is of. Required with it.

Available options:
DATA_PLATFORM_TYPE_UNSPECIFIED,
DATA_PLATFORM_TYPE_BIGQUERY,
DATA_PLATFORM_TYPE_LOOKER,
DATA_PLATFORM_TYPE_DBT,
DATA_PLATFORM_TYPE_DBT_CLOUD,
DATA_PLATFORM_TYPE_DBT_SELF_HOSTED,
DATA_PLATFORM_TYPE_SNOWFLAKE,
DATA_PLATFORM_TYPE_GCP,
DATA_PLATFORM_TYPE_GIT,
DATA_PLATFORM_TYPE_GITHUB,
DATA_PLATFORM_TYPE_REDSHIFT,
DATA_PLATFORM_TYPE_TABLEAU,
DATA_PLATFORM_TYPE_AIRFLOW,
DATA_PLATFORM_TYPE_CLICKHOUSE,
DATA_PLATFORM_TYPE_POSTGRES,
DATA_PLATFORM_TYPE_MYSQL,
DATA_PLATFORM_TYPE_DATABRICKS,
DATA_PLATFORM_TYPE_SQLMESH,
DATA_PLATFORM_TYPE_DUCKDB,
DATA_PLATFORM_TYPE_TRINO,
DATA_PLATFORM_TYPE_ATLAN,
DATA_PLATFORM_TYPE_COALESCE,
DATA_PLATFORM_TYPE_CASTORDOC,
DATA_PLATFORM_TYPE_FIVETRAN,
DATA_PLATFORM_TYPE_DAGSTER,
DATA_PLATFORM_TYPE_AIRBYTE,
DATA_PLATFORM_TYPE_STITCH,
DATA_PLATFORM_TYPE_SNOWPLOW,
DATA_PLATFORM_TYPE_POWERBI,
DATA_PLATFORM_TYPE_THOUGHTSPOT,
DATA_PLATFORM_TYPE_SIGMA,
DATA_PLATFORM_TYPE_DOMO,
DATA_PLATFORM_TYPE_MSSQL,
DATA_PLATFORM_TYPE_ORACLE,
DATA_PLATFORM_TYPE_ATHENA,
DATA_PLATFORM_TYPE_FABRIC,
DATA_PLATFORM_TYPE_DB2,
DATA_PLATFORM_TYPE_LOOKER_STUDIO,
DATA_PLATFORM_TYPE_HEX,
DATA_PLATFORM_TYPE_OMNI,
DATA_PLATFORM_TYPE_METABASE,
DATA_PLATFORM_TYPE_GOOGLE_SHEETS,
DATA_PLATFORM_TYPE_GRAFANA,
DATA_PLATFORM_TYPE_STREAMLIT,
DATA_PLATFORM_TYPE_ASTRATO,
DATA_PLATFORM_TYPE_SNOWFLAKE_CORTEX,
DATA_PLATFORM_TYPE_SNOWFLAKE_INTELLIGENCE,
DATA_PLATFORM_TYPE_CUBE,
DATA_PLATFORM_TYPE_CENSUS,
DATA_PLATFORM_TYPE_HIGHTOUCH,
DATA_PLATFORM_TYPE_WORKATO,
DATA_PLATFORM_TYPE_ESTUARY,
DATA_PLATFORM_TYPE_DLT,
DATA_PLATFORM_TYPE_TERRAFORM,
DATA_PLATFORM_TYPE_HEVO,
DATA_PLATFORM_TYPE_DATASTREAM,
DATA_PLATFORM_TYPE_SYNQ
pagination
Pagination · object

Without a page size every actor is returned.

Response

200 - application/json

Success

actors
ListedActor · object[]

In the asked order.

from
string<date-time>

A Timestamp represents a point in time independent of any time zone or local calendar, encoded as a count of seconds and fractions of seconds at nanosecond resolution. The count is relative to an epoch at UTC midnight on January 1, 1970, in the proleptic Gregorian calendar which extends the Gregorian calendar backwards to year one.

All minutes are 60 seconds long. Leap seconds are "smeared" so that no leap second table is needed for interpretation, using a 24-hour linear smear.

The range is from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z. By restricting to that range, we ensure that we can convert to and from RFC 3339 date strings.

Examples

Example 1: Compute Timestamp from POSIX time().

Example 2: Compute Timestamp from POSIX gettimeofday().

Example 3: Compute Timestamp from Win32 GetSystemTimeAsFileTime().

Example 4: Compute Timestamp from Java System.currentTimeMillis().

Example 5: Compute Timestamp from Java Instant.now().

Example 6: Compute Timestamp from current time in Python.

JSON Mapping

In JSON format, the Timestamp type is encoded as a string in the RFC 3339 format. That is, the format is "{year}-{month}-{day}T{hour}:{min}:{sec}[.{frac_sec}]Z" where {year} is always expressed using four digits while {month}, {day}, {hour}, {min}, and {sec} are zero-padded to two digits each. The fractional seconds, which can go up to 9 digits (i.e. up to 1 nanosecond resolution), are optional. The "Z" suffix indicates the timezone ("UTC"); the timezone is required. A proto3 JSON serializer should always use UTC (as indicated by "Z") when printing the Timestamp type and a proto3 JSON parser should be able to accept both UTC and other timezones (as indicated by an offset).

For example, "2017-01-15T01:30:15.01Z" encodes 15.01 seconds past 01:30 UTC on January 15, 2017.

In JavaScript, one can convert a Date object to this format using the standard toISOString() method. In Python, a standard datetime.datetime object can be converted to this format using strftime with the time format spec '%Y-%m-%dT%H:%M:%S.%fZ'. Likewise, in Java, one can use the Joda Time's ISODateTimeFormat.dateTime() to obtain a formatter capable of generating timestamps in this format.

Examples:

"2023-01-15T01:30:15.01Z"

"2024-12-25T12:00:00Z"

to
string<date-time>

A Timestamp represents a point in time independent of any time zone or local calendar, encoded as a count of seconds and fractions of seconds at nanosecond resolution. The count is relative to an epoch at UTC midnight on January 1, 1970, in the proleptic Gregorian calendar which extends the Gregorian calendar backwards to year one.

All minutes are 60 seconds long. Leap seconds are "smeared" so that no leap second table is needed for interpretation, using a 24-hour linear smear.

The range is from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z. By restricting to that range, we ensure that we can convert to and from RFC 3339 date strings.

Examples

Example 1: Compute Timestamp from POSIX time().

Example 2: Compute Timestamp from POSIX gettimeofday().

Example 3: Compute Timestamp from Win32 GetSystemTimeAsFileTime().

Example 4: Compute Timestamp from Java System.currentTimeMillis().

Example 5: Compute Timestamp from Java Instant.now().

Example 6: Compute Timestamp from current time in Python.

JSON Mapping

In JSON format, the Timestamp type is encoded as a string in the RFC 3339 format. That is, the format is "{year}-{month}-{day}T{hour}:{min}:{sec}[.{frac_sec}]Z" where {year} is always expressed using four digits while {month}, {day}, {hour}, {min}, and {sec} are zero-padded to two digits each. The fractional seconds, which can go up to 9 digits (i.e. up to 1 nanosecond resolution), are optional. The "Z" suffix indicates the timezone ("UTC"); the timezone is required. A proto3 JSON serializer should always use UTC (as indicated by "Z") when printing the Timestamp type and a proto3 JSON parser should be able to accept both UTC and other timezones (as indicated by an offset).

For example, "2017-01-15T01:30:15.01Z" encodes 15.01 seconds past 01:30 UTC on January 15, 2017.

In JavaScript, one can convert a Date object to this format using the standard toISOString() method. In Python, a standard datetime.datetime object can be converted to this format using strftime with the time format spec '%Y-%m-%dT%H:%M:%S.%fZ'. Likewise, in Java, one can use the Joda Time's ISODateTimeFormat.dateTime() to obtain a formatter capable of generating timestamps in this format.

Examples:

"2023-01-15T01:30:15.01Z"

"2024-12-25T12:00:00Z"

pageInfo
PageInfo · object
peopleHidden
boolean

Set when the caller may not see people and logins: no PERSON or LOGIN actor is listed.