Apps & Surfaces

Apps

Explore the data types and operations available in Apps.

163 types · Used in operation arguments and return values.

IaCValidationResultObject

Result of validating one artifact

IDScalar

The `ID` scalar type represents a unique identifier, often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String; however, it is not intended to be human-readable. When expected as an input type, any string (such as `"4"`) or integer (such as `4`) input value will be accepted as an ID.

ImportDashboardInputInput

Input for importing a dashboard from YAML/JSON

ImportDashboardPayloadObject

Result of importing a dashboard from YAML/JSON

InstallSharedResourcePayloadObject

Result of installing a catalog template into the calling tenant. Failures are returned in this payload rather than raised as GraphQL errors.

IntScalar

The `Int` scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.

JSONScalar

Arbitrary JSON value (object, array, number, boolean, string, or null). Not introspectable — when the shape is known, prefer a typed `Type` registration. Numbers stored as numbers come back as numbers, not stringified.

MagicQueryInfoObject

A discoverable Magic Query noun and its accepted options.

MagicQueryOperationObject

The real GraphQL operation + variables a Magic Query resolves to.

MagicQuerySchemaObject

Input (JSON Schema) and output (introspection) contract for a Magic Query noun.

OpenCustomAppPreviewPayloadObject

Result of opening a custom app preview.

PreviewDataClipInputInput

Input for `previewDataClip`: run a candidate query and inspect its rows before committing it to a clip.

ProtobufSchemaByIdInputInput

Input for fetching a protobuf schema by ID

ProtobufSchemaByNameInputInput

Input for fetching a protobuf schema by name

ProtobufSchemaConnectionObject

Paginated list of protobuf schemas

ProtobufSchemaFilterInputInput

Filter criteria for protobuf schemas

ProtobufSchemaIDScalar

Unique identifier for a protobuf schema

ProtobufSchemaSortInputInput

Sort order for protobuf schemas

ProtobufSchemaStateObject

A tenant-scoped protobuf schema used by scripts to decode binary payloads

QueryScalarScalar

A URI-style string defining an entity, optional ID, and filter parameters. Format: <noun>[#<id>][?<key>=<value>,...]. Examples: 'jobs?limit=100,status=approved', 'job#01H...'.

ReportQueryPayloadObject

Result of a MicroSQL reporting query

RollShareTokenInputInput

Input for `rollDataClipShareToken`.

RollShareTokenPayloadObject

Result of rolling a data clip's share token. On success the clip carries the new token and every previously shared link is dead.

SaveAPIClientDefinitionPayloadObject

Result of saving an API client definition.

SchemaDocSearchResultObject

One semantic-search hit against the introspected GraphQL schema: the matched schema element, its documentation text, and how closely it matched the query.

SetCustomAppEngineVersionInputInput

Input for upgrading an app's engine version after a script-shape lint

SharedResourceConnectionObject

A page of shared-resource catalog templates matching the requested filters.

SharedResourceEnvelopeObject

A template published in the shared-resource catalog: the metadata a tenant browses before installing it. Served by ControlApp, not by this tenant's database; the template's payload itself is not exposed here.

SharedResourceInstallationStateObject

A record, held by ControlApp, that this tenant installed a given catalog template at a given version. Describes the installation, not the installed resource.

SharedResourceTemplateIDScalar

Unique identifier for a shared resource template

SharedResourceTypeEnum

Type of shared resource in the catalog

StringScalar

The `String` scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.

UpdateCustomAppInputInput

Input for updating a custom app. Only provided fields are changed.

UpdateCustomAppPreviewPayloadObject

Result of pushing new source to a custom app preview.

UpdateCustomDataContainerInputInput

Input for updating a custom data container. Only provided fields are changed.

UpdateDashboardCardInputInput

Fields for updating a dashboard card — only provided fields are changed

UpdateDashboardInputInput

Input for updating a dashboard. Only provided fields are changed.

UpdateDashboardLayoutInputInput

Input for bulk-updating card positions after drag/resize

UpdateDashboardLayoutPayloadObject

Result of updating dashboard card layout positions

UpdateDataClipInputInput

Input for `updateDataClip`. Every field is optional — omitted fields are left as-is.

UpdateDataRecordInputInput

Input for updating a data record. Only provided fields are changed.

UpdateDataSchemaInputInput

Input for updating a data schema. Only provided fields are changed.

UpdateExternalSchemaInputInput

Input for updating an external schema. Only provided fields are changed.

UpdateProtobufSchemaInputInput

Input for updating a protobuf schema. Only provided fields are changed.

UpsertCustomAppInputInput

Input for creating or updating a custom app

UpsertCustomAppPayloadObject

Result of creating or updating a custom app

UpsertCustomDataContainerInputInput

Input for creating or updating a custom data container

UpsertCustomDataContainerPayloadObject

Result of creating or updating a custom data container

UpsertDashboardCardInputInput

Input for creating or updating a dashboard card

UpsertDashboardCardPayloadObject

Result of creating or updating a dashboard card