discovery

Aggregate artifacts of a kind

As POST /aggregate, narrowed to one registered kind — and the kind is validated, so an unregistered or retired kind is a 404 rather than an empty result.

A kind's own properties are not dimensions or measures here, and that is the contract rather than a gap: a kind declares its properties at registration without declaring which of them are queryable, so the grammar has no name to validate against. Only the shared artifact fields group here, exactly as on POST /aggregate.

post/registry/v1/aggregate/{artifact_kind}

Request

  • Base URL: https://api.atlan.com (the document declares no server; this is the origin it was published from)
  • URL: https://api.atlan.com/registry/v1/aggregate/{artifact_kind}
  • Auth: HTTP bearer

Path parameters

artifact_kindstring required

Registered kind (file, skill, …)

Headers

Content-Encoding'base64' | 'gzip, base64'

Codings applied to the request body, outermost last. Send base64, or gzip, base64 to compress first; the body is decoded before it is read and Content-Type still names the inner media type. Omit for an unencoded body.

Request body

is_all_versions_includedboolean nullable

Aggregate every live version rather than only the heads. Defaults to false.

is_archived_includedboolean nullable

Include archived artifacts. Defaults to false, matching the collection reads — an aggregate that counted archived rows would disagree with the list it summarises.

is_system_includedboolean nullable

Include artifacts the deployment wrote. Defaults to false.

limitinteger nullable

Max groups. Defaults to 50; a larger value than 500 is clamped to 500, and 0 is refused.

offsetinteger nullable

Groups to skip. Defaults to 0, rejected above 10000.

project_idstring nullable

Narrow to one project: the artifacts it owns (project_id) and the ones linked into it, the same scope POST /search applies. A project linking more than 1000 artifacts is refused (422 project_link_limit_exceeded). Grouping by project_id still groups by the artifact's own column.

sortstring[]

Sort keys over a group_by field name or a metric alias, -key for descending. Omitted ⇒ the first metric descending, tiebroken by the dimensions so offset pages stay stable.

workspace_idstring nullable

Narrow to one workspace. Omitted ⇒ every workspace the caller can read.

Response

OK

Changes

No recorded changes to this operation across all 1 revision of this API.