DataKit Docs

AuthCheck

Object

Field	Type	Description
error	String
oAuthUrl	String
required	Boolean!required
success	Boolean!required
type	ServiceAuthType!required

BaseServiceMetadata

Object

Field	Type	Description
customActions	[CustomActionMetadata!]!required
eventSources	[EventSourceMetadata!]!required
events	[EventMetadata!]!required

Catalog

Object

Field	Type	Description
alias	String!required
autoSync	Boolean!required
connection	Connection!required
connectionID	ID!required
createdAt	Time!required
deletedAt	Time
description	String
id	ID!required
label	String!required
metaGraph	MetaGraph!required
models	ModelConnection!required
name	String!required
organization	Organization!required
organizationID	ID!required
queryDialect	String!required
schemas	SchemaRefConnection!required
sources	SourceConnection!required
spaces	[Space!]
syncError	String
syncStatus	SyncStatus!required
syncedAt	Time
updatedAt	Time!required

CatalogConnection

Object

A connection to a list of items.

Field	Type	Description
edges	[CatalogEdge]	A list of edges.
pageInfo	PageInfo!required	Information to aid in pagination.
totalCount	Int!required	Identifies the total count of items in the connection.

CatalogCreated

Object

Field	Type	Description
catalog	Catalog
created	Boolean!required
error	String

CatalogDeleted

Object

Field	Type	Description
deleted	Boolean!required
error	String
id	ID

CatalogEdge

Object

An edge in a connection.

Field	Type	Description
cursor	Cursor!required	A cursor for use in pagination.
node	Catalog	The item at the end of the edge.

CatalogServiceMetadata

Object

Field	Type	Description
dataTypes	[DataTypeMetadata!]!required
defaultCatalog	String
queryDialect	String!required

CatalogUpdated

Object

Field	Type	Description
catalog	Catalog
error	String
updated	Boolean!required

ColumnRef

Object

Field	Type	Description
alias	String!required
createdAt	Time!required
deletedAt	Time
description	String
dtype	String!required
fields	[Field]
id	ID!required
name	String!required
nullable	Boolean!required
ordinal	Int!required
primaryKey	Boolean!required
repeated	Boolean!required
sqlQueries	SQLQueryConnection!required
table	TableRef!required
tableID	ID!required
updatedAt	Time!required

ColumnRefConnection

Object

A connection to a list of items.

Field	Type	Description
edges	[ColumnRefEdge]	A list of edges.
pageInfo	PageInfo!required	Information to aid in pagination.
totalCount	Int!required	Identifies the total count of items in the connection.

ColumnRefCreated

Object

Field	Type	Description
columnRef	ColumnRef
created	Boolean!required
error	String

ColumnRefDeleted

Object

Field	Type	Description
deleted	Boolean!required
error	String
id	ID

ColumnRefEdge

Object

An edge in a connection.

Field	Type	Description
cursor	Cursor!required	A cursor for use in pagination.
node	ColumnRef	The item at the end of the edge.

ColumnRefUpdated

Object

Field	Type	Description
columnRef	ColumnRef
error	String
updated	Boolean!required

ConfigCheck

Object

Field	Type	Description
error	String
success	Boolean!required

Connection

Object

Field	Type	Description
baseService	BaseServiceMetadata!required
catalogService	CatalogServiceMetadata
catalogs	CatalogConnection!required
connectionUsers	[ConnectionUser!]
createdAt	Time!required
destinationService	DestinationServiceMetadata
embeddingService	EmbeddingServiceMetadata
id	ID!required
integration	Integration!required
integrationID	ID!required
name	String!required
organizationID	ID!required
organizations	[Organization!]
owner	Organization!required
slug	String!required
sourceService	SourceServiceMetadata
sourceTypes	SourceTypeConnection!required
sources	SourceConnection!required
updatedAt	Time!required
visibility	Visibility!required

ConnectionCheck

Object

Field	Type	Description
authCheck	AuthCheck!required
configCheck	ConfigCheck!required

ConnectionConnection

Object

A connection to a list of items.

Field	Type	Description
edges	[ConnectionEdge]	A list of edges.
pageInfo	PageInfo!required	Information to aid in pagination.
totalCount	Int!required	Identifies the total count of items in the connection.

ConnectionCreated

Object

Field	Type	Description
connection	Connection
created	Boolean!required
error	String

ConnectionDeleted

Object

Field	Type	Description
deleted	Boolean!required
error	String
id	ID

ConnectionEdge

Object

An edge in a connection.

Field	Type	Description
cursor	Cursor!required	A cursor for use in pagination.
node	Connection	The item at the end of the edge.

ConnectionUpdated

Object

Field	Type	Description
connection	Connection
error	String
updated	Boolean!required

ConnectionUser

Object

Field	Type	Description
connection	Connection!required
connectionID	ID!required
createdAt	Time!required
id	ID!required
organization	Organization!required
organizationID	ID!required
updatedAt	Time!required
user	User!required
userID	ID!required

ConnectionUserConnection

Object

A connection to a list of items.

Field	Type	Description
edges	[ConnectionUserEdge]	A list of edges.
pageInfo	PageInfo!required	Information to aid in pagination.
totalCount	Int!required	Identifies the total count of items in the connection.

ConnectionUserCreated

Object

Field	Type	Description
connectionUser	ConnectionUser
created	Boolean!required
error	String

ConnectionUserDeleted

Object

Field	Type	Description
deleted	Boolean!required
error	String
id	ID

ConnectionUserEdge

Object

An edge in a connection.

Field	Type	Description
cursor	Cursor!required	A cursor for use in pagination.
node	ConnectionUser	The item at the end of the edge.

ConnectionUserUpdated

Object

Field	Type	Description
connectionUser	ConnectionUser
error	String
updated	Boolean!required

CustomActionMetadata

Object

Field	Type	Description
description	String!required
inputSchema	String!required
name	String!required
outputSchema	String!required

DataTypeMetadata

Object

Field	Type	Description
jsonType	String!required
nativeType	String!required

Destination

Object

Field	Type	Description
connection	Connection!required
connectionID	ID!required
createdAt	Time!required
id	ID!required
name	String!required
organization	Organization!required
organizationID	ID!required
providerID	String!required
sources	[Source!]
tzName	String!required	Timezone name (e.g. America/Los_Angeles)
updatedAt	Time!required

DestinationConfig

Object

Field	Type	Description
schema	String!required
service	String!required

DestinationConnection

Object

A connection to a list of items.

Field	Type	Description
edges	[DestinationEdge]	A list of edges.
pageInfo	PageInfo!required	Information to aid in pagination.
totalCount	Int!required	Identifies the total count of items in the connection.

DestinationCreated

Object

Field	Type	Description
created	Boolean!required
destination	Destination
error	String

DestinationDeleted

Object

Field	Type	Description
deleted	Boolean!required
error	String
id	ID

DestinationEdge

Object

An edge in a connection.

Field	Type	Description
cursor	Cursor!required	A cursor for use in pagination.
node	Destination	The item at the end of the edge.

DestinationServiceMetadata

Object

Field	Type	Description
destinationConfigs	[DestinationConfig!]!required

DestinationUpdated

Object

Field	Type	Description
destination	Destination
error	String
updated	Boolean!required

EmbeddingModelMetadata

Object

Field	Type	Description
id	String!required
maxDimensions	Int!required
minDimensions	Int!required
name	String!required

EmbeddingServiceMetadata

Object

Field	Type	Description
models	[EmbeddingModelMetadata!]!required

EventMetadata

Object

Field	Type	Description
description	String!required
payloadSchema	String!required
type	String!required

EventSource

Object

Field	Type	Description
connection	Connection!required
connectionID	ID!required
createdAt	Time!required
creationAt	Time
error	String
id	ID!required
name	String!required
pullFreq	String	Pull frequency in string format, e.g.: "1s", "2.3h" or "4h35m"
pushUrl	String
requiresCreation	Boolean!required
slug	String!required
startedAt	Time
status	EventSourceStatus!required
stoppedAt	Time
strategy	EventSourceStrategy!required
updatedAt	Time!required

EventSourceConnection

Object

A connection to a list of items.

Field	Type	Description
edges	[EventSourceEdge]	A list of edges.
pageInfo	PageInfo!required	Information to aid in pagination.
totalCount	Int!required	Identifies the total count of items in the connection.

EventSourceCreated

Object

Field	Type	Description
created	Boolean!required
error	String
eventSource	EventSource

EventSourceDeleted

Object

Field	Type	Description
deleted	Boolean!required
error	String
id	ID

EventSourceEdge

Object

An edge in a connection.

Field	Type	Description
cursor	Cursor!required	A cursor for use in pagination.
node	EventSource	The item at the end of the edge.

EventSourceMetadata

Object

Field	Type	Description
configSchema	String!required
description	String!required
name	String!required
strategy	EventSourceStrategy!required

EventSourceUpdated

Object

Field	Type	Description
error	String
eventSource	EventSource
updated	Boolean!required

ExternalDataSource

Object

Field	Type	Description
id	String!required
provider	ReportProvider!required
url	String!required

ExternalReport

Object

Field	Type	Description
dataSource	ExternalDataSource
id	String!required
provider	ReportProvider!required
url	String!required

Field

Object

Field	Type	Description
description	String
fields	[Field!]
name	String!required
nullable	Boolean!required
ordinal	Int!required
repeated	Boolean!required
type	String!required

Flow

Object

Field	Type	Description
body	Map!required
createdAt	Time!required
description	String
id	ID!required
metaGraph	MetaGraph!required
name	String!required
organization	Organization!required
organizationID	ID!required
resources	FlowResourceConnection!required
revision	FlowRevision
revisionID	ID
revisions	FlowRevisionConnection!required
runs	FlowRunConnection!required
slug	String!required
updatedAt	Time!required

FlowConfig

Object

Field	Type	Description
eventSources	[FlowEventSource!]
inputs	Map
packages	[FlowPackage!]

FlowConnection

Object

A connection to a list of items.

Field	Type	Description
edges	[FlowEdge]	A list of edges.
pageInfo	PageInfo!required	Information to aid in pagination.
totalCount	Int!required	Identifies the total count of items in the connection.

FlowCreated

Object

Field	Type	Description
created	Boolean!required
error	String
flow	Flow

FlowDeleted

Object

Field	Type	Description
deleted	Boolean!required
error	String
id	ID

FlowEdge

Object

An edge in a connection.

Field	Type	Description
cursor	Cursor!required	A cursor for use in pagination.
node	Flow	The item at the end of the edge.

FlowEnv

Object

Field	Type	Description
nodes	[FlowNodeState!]!required

FlowEventSource

Object

Field	Type	Description
eventSource	EventSource
eventSourceId	ID!required
nodeId	String!required

FlowNodeState

Object

Field	Type	Description
nodeId	String!required
nodeType	String!required
status	FlowNodeStatus!required

FlowPackage

Object

Field	Type	Description
connection	Connection
connectionId	ID!required
nodeId	String!required

FlowResource

Object

Field	Type	Description
createdAt	Time!required
flow	Flow!required
flowID	ID!required
id	ID!required
nodeID	String!required
nodeType	String!required
resourceID	ID!required
resourceType	String!required
revision	FlowRevision!required
revisionID	ID!required
run	FlowRun!required
runID	ID!required
updatedAt	Time!required

FlowResourceConnection

Object

A connection to a list of items.

Field	Type	Description
edges	[FlowResourceEdge]	A list of edges.
pageInfo	PageInfo!required	Information to aid in pagination.
totalCount	Int!required	Identifies the total count of items in the connection.

FlowResourceCreated

Object

Field	Type	Description
created	Boolean!required
error	String
flowResource	FlowResource

FlowResourceDeleted

Object

Field	Type	Description
deleted	Boolean!required
error	String
id	ID

FlowResourceEdge

Object

An edge in a connection.

Field	Type	Description
cursor	Cursor!required	A cursor for use in pagination.
node	FlowResource	The item at the end of the edge.

FlowResourceUpdated

Object

Field	Type	Description
error	String
flowResource	FlowResource
updated	Boolean!required

FlowRevision

Object

Field	Type	Description
body	Map!required
checksum	String!required
config	FlowConfig!required
createdAt	Time!required
flow	Flow!required
flowID	ID!required
id	ID!required
metaGraph	MetaGraph!required
resources	FlowResourceConnection!required
runs	FlowRunConnection!required
updatedAt	Time!required

FlowRevisionConnection

Object

A connection to a list of items.

Field	Type	Description
edges	[FlowRevisionEdge]	A list of edges.
pageInfo	PageInfo!required	Information to aid in pagination.
totalCount	Int!required	Identifies the total count of items in the connection.

FlowRevisionCreated

Object

Field	Type	Description
created	Boolean!required
error	String
flowRevision	FlowRevision

FlowRevisionDeleted

Object

Field	Type	Description
deleted	Boolean!required
error	String
id	ID

FlowRevisionEdge

Object

An edge in a connection.

Field	Type	Description
cursor	Cursor!required	A cursor for use in pagination.
node	FlowRevision	The item at the end of the edge.

FlowRevisionUpdated

Object

Field	Type	Description
error	String
flowRevision	FlowRevision
updated	Boolean!required

FlowRun

Object

Field	Type	Description
body	Map!required
config	FlowConfig!required
createdAt	Time!required
env	FlowEnv!required
error	String
flow	Flow!required
flowID	ID!required
id	ID!required
metaGraph	MetaGraph!required
resources	FlowResourceConnection!required
revision	FlowRevision!required
revisionID	ID!required
runTimeout	String!required	Run timeout in string format, e.g.: "1s", "2.3h" or "4h35m". (Optional; when not set, run must be stopped manually)
startedAt	Time
status	FlowRunStatus!required
stopTimeout	String!required	Stop timeout in string format, e.g.: "1s", "2.3h" or "4h35m". (Default: 1s)
stoppedAt	Time
updatedAt	Time!required

FlowRunConnection

Object

A connection to a list of items.

Field	Type	Description
edges	[FlowRunEdge]	A list of edges.
pageInfo	PageInfo!required	Information to aid in pagination.
totalCount	Int!required	Identifies the total count of items in the connection.

FlowRunCreated

Object

Field	Type	Description
created	Boolean!required
error	String
flowRun	FlowRun

FlowRunDeleted

Object

Field	Type	Description
deleted	Boolean!required
error	String
id	ID

FlowRunDone

Object

Field	Type	Description
eventType	FlowRunEventType!required
flowRun	FlowRun!required

FlowRunEdge

Object

An edge in a connection.

Field	Type	Description
cursor	Cursor!required	A cursor for use in pagination.
node	FlowRun	The item at the end of the edge.

FlowRunError

Object

Field	Type	Description
error	String!required
eventType	FlowRunEventType!required
flowRun	FlowRun!required

FlowRunNodeStatus

Object

Field	Type	Description
eventType	FlowRunEventType!required
flowRun	FlowRun!required
nodeState	FlowNodeState!required

FlowRunOutput

Object

Field	Type	Description
eventType	FlowRunEventType!required
flowRun	FlowRun!required
nodeId	String!required
nodeType	String!required
value	Any!required

FlowRunUpdated

Object

Field	Type	Description
error	String
flowRun	FlowRun
updated	Boolean!required

FlowRunUserAction

Object

Field	Type	Description
eventType	FlowRunEventType!required
flowRun	FlowRun!required
nodeId	String!required
nodeType	String!required

FlowUpdated

Object

Field	Type	Description
error	String
flow	Flow
updated	Boolean!required

IOSchema

Object

Field	Type	Description
createdAt	Time!required
id	ID!required
inputSchema	String
nodeID	ID!required
nodeType	String!required
organization	Organization
organizationID	ID
outputSchema	String
updatedAt	Time!required

IOSchemaConnection

Object

A connection to a list of items.

Field	Type	Description
edges	[IOSchemaEdge]	A list of edges.
pageInfo	PageInfo!required	Information to aid in pagination.
totalCount	Int!required	Identifies the total count of items in the connection.

IOSchemaCreated

Object

Field	Type	Description
created	Boolean!required
error	String
ioSchema	IOSchema

IOSchemaDeleted

Object

Field	Type	Description
deleted	Boolean!required
error	String
id	ID

IOSchemaEdge

Object

An edge in a connection.

Field	Type	Description
cursor	Cursor!required	A cursor for use in pagination.
node	IOSchema	The item at the end of the edge.

IOSchemaUpdated

Object

Field	Type	Description
error	String
ioSchema	IOSchema
updated	Boolean!required

Integration

Object

Field	Type	Description
configSchema	String!required
connections	[Connection!]
createdAt	Time!required
description	String!required
icon	String!required
id	ID!required
localHost	String
localPort	String
name	String!required
network	NetworkType!required
organization	Organization!required
organizationID	ID!required
packages	IntegrationPackageConnection!required
published	IntegrationPackage
publishedID	ID
serverConfig	String
serviceTypes	[String!]!required
slug	String!required
updatedAt	Time!required
version	String!required

IntegrationConnection

Object

A connection to a list of items.

Field	Type	Description
edges	[IntegrationEdge]	A list of edges.
pageInfo	PageInfo!required	Information to aid in pagination.
totalCount	Int!required	Identifies the total count of items in the connection.

IntegrationCreated

Object

Field	Type	Description
created	Boolean!required
error	String
integration	Integration

IntegrationDeleted

Object

Field	Type	Description
deleted	Boolean!required
error	String
id	ID

IntegrationEdge

Object

An edge in a connection.

Field	Type	Description
cursor	Cursor!required	A cursor for use in pagination.
node	Integration	The item at the end of the edge.

IntegrationPackage

Object

Field	Type	Description
author	User!required
authorID	ID!required
body	Map!required
checksum	String!required
createdAt	Time!required
id	ID!required
integration	Integration!required
integrationID	ID!required
updatedAt	Time!required

IntegrationPackageConnection

Object

A connection to a list of items.

Field	Type	Description
edges	[IntegrationPackageEdge]	A list of edges.
pageInfo	PageInfo!required	Information to aid in pagination.
totalCount	Int!required	Identifies the total count of items in the connection.

IntegrationPackageCreated

Object

Field	Type	Description
created	Boolean!required
error	String
integrationPackage	IntegrationPackage

IntegrationPackageDeleted

Object

Field	Type	Description
deleted	Boolean!required
error	String
id	ID

IntegrationPackageEdge

Object

An edge in a connection.

Field	Type	Description
cursor	Cursor!required	A cursor for use in pagination.
node	IntegrationPackage	The item at the end of the edge.

IntegrationPackageUpdated

Object

Field	Type	Description
error	String
integrationPackage	IntegrationPackage
updated	Boolean!required

IntegrationUpdated

Object

Field	Type	Description
error	String
integration	Integration
updated	Boolean!required

MetaEdge

Object

Field	Type	Description
data	Map
sourceId	ID!required
targetId	ID!required
type	MetaEdgeType!required

MetaGraph

Object

Field	Type	Description
edges	[MetaEdge!]!required
nodes	[MetaGraphNode!]!required

MetaNode

Object

Field	Type	Description
data	Map!required
id	ID!required
type	String!required

Model

Object

Field	Type	Description
autoSync	Boolean!required
catalog	Catalog!required
catalogID	ID!required
createdAt	Time!required
externalReports	[ExternalReport]
id	ID!required
metadata	Map
name	String!required
schema	SchemaRef!required
sources	SourceConnection!required
syncError	String
syncStatus	SyncStatus!required
syncedAt	Time
type	ModelType!required
typeID	ID!required
updatedAt	Time!required

ModelConnection

Object

A connection to a list of items.

Field	Type	Description
edges	[ModelEdge]	A list of edges.
pageInfo	PageInfo!required	Information to aid in pagination.
totalCount	Int!required	Identifies the total count of items in the connection.

ModelCreated

Object

Field	Type	Description
created	Boolean!required
error	String
model	Model

ModelDeleted

Object

Field	Type	Description
deleted	Boolean!required
error	String
id	ID

ModelEdge

Object

An edge in a connection.

Field	Type	Description
cursor	Cursor!required	A cursor for use in pagination.
node	Model	The item at the end of the edge.

ModelType

Object

Field	Type	Description
category	String!required
configTemplate	Map
createdAt	Time!required
dependencies	[ModelType!]
description	String!required
id	ID!required
maxPerType	Int!required
minPerType	Int!required
minSources	Int!required
modeler	ModelerType!required
models	[Model!]
name	String!required
parents	[ModelType!]
slug	String!required
sourceTypes	[SourceType!]!required
sourceURL	String!required
sourceVersion	String
updatedAt	Time!required

ModelTypeConnection

Object

A connection to a list of items.

Field	Type	Description
edges	[ModelTypeEdge]	A list of edges.
pageInfo	PageInfo!required	Information to aid in pagination.
totalCount	Int!required	Identifies the total count of items in the connection.

ModelTypeCreated

Object

Field	Type	Description
created	Boolean!required
error	String
modelType	ModelType

ModelTypeDeleted

Object

Field	Type	Description
deleted	Boolean!required
error	String
id	ID

ModelTypeEdge

Object

An edge in a connection.

Field	Type	Description
cursor	Cursor!required	A cursor for use in pagination.
node	ModelType	The item at the end of the edge.

ModelTypeUpdated

Object

Field	Type	Description
error	String
modelType	ModelType
updated	Boolean!required

ModelUpdated

Object

Field	Type	Description
error	String
model	Model
updated	Boolean!required

NodeEvent

Object

Field	Type	Description
action	NodeAction
actionType	ActionType!required
eventType	String!required
metadata	Map
node	Node
nodeID	ID!required
nodeType	String!required

Organization

Object

Field	Type	Description
catalogs	CatalogConnection!required
connectionUsers	ConnectionUserConnection!required
connections	ConnectionConnection!required
connectionsOwned	ConnectionConnection!required
createdAt	Time!required
customerID	String!required
destinations	DestinationConnection!required
flows	FlowConnection!required
id	ID!required
integrations	IntegrationConnection!required
name	String!required
slug	String!required
spaces	SpaceConnection!required
tzName	String!required	Timezone name (e.g. America/Los_Angeles)
updatedAt	Time!required

OrganizationConnection

Object

A connection to a list of items.

Field	Type	Description
edges	[OrganizationEdge]	A list of edges.
pageInfo	PageInfo!required	Information to aid in pagination.
totalCount	Int!required	Identifies the total count of items in the connection.

OrganizationCreated

Object

Field	Type	Description
created	Boolean!required
error	String
organization	Organization

OrganizationDeleted

Object

Field	Type	Description
deleted	Boolean!required
error	String
id	ID

OrganizationEdge

Object

An edge in a connection.

Field	Type	Description
cursor	Cursor!required	A cursor for use in pagination.
node	Organization	The item at the end of the edge.

OrganizationUpdated

Object

Field	Type	Description
error	String
organization	Organization
updated	Boolean!required

PageInfo

Object

Information about pagination in a connection. https://relay.dev/graphql/connections.htm#sec-undefined.PageInfo

Field	Type	Description
endCursor	Cursor	When paginating forwards, the cursor to continue.
hasNextPage	Boolean!required	When paginating forwards, are there more items?
hasPreviousPage	Boolean!required	When paginating backwards, are there more items?
startCursor	Cursor	When paginating backwards, the cursor to continue.

Param

Object

Field	Type	Description
fields	[Param!]
name	String!required
repeated	Boolean
type	String!required
value	Any
values	[Any]

Permission

Object

Permission is a type that represents the permissions a role or user has on a resource.

Field	Type	Description
actions	[ActionType!]!required
resource	Node!required
resourcePath	String!required

PersonalAccessToken

Object

Field	Type	Description
createdAt	Time!required
expiresAt	Time!required
id	ID!required
name	String!required
token	String!required
updatedAt	Time!required
user	User!required
userID	ID!required

PersonalAccessTokenConnection

Object

A connection to a list of items.

Field	Type	Description
edges	[PersonalAccessTokenEdge]	A list of edges.
pageInfo	PageInfo!required	Information to aid in pagination.
totalCount	Int!required	Identifies the total count of items in the connection.

PersonalAccessTokenCreated

Object

Field	Type	Description
created	Boolean!required
error	String
personalAccessToken	PersonalAccessToken

PersonalAccessTokenDeleted

Object

Field	Type	Description
deleted	Boolean!required
error	String
id	ID

PersonalAccessTokenEdge

Object

An edge in a connection.

Field	Type	Description
cursor	Cursor!required	A cursor for use in pagination.
node	PersonalAccessToken	The item at the end of the edge.

PersonalAccessTokenUpdated

Object

Field	Type	Description
error	String
personalAccessToken	PersonalAccessToken
updated	Boolean!required

ReadTableOutput

Object

Field	Type	Description
rows	[Map!]!required
table	TableRef!required

Role

Object

Role is a type that represents the role a user has in an organization and/or space.

Field	Type	Description
id	String!required
orgID	ID!required
permissions	[Permission]!required
spaceID	ID
type	RoleType!required
users	[User]!required

SQLQuery

Object

Field	Type	Description
columns	ColumnRefConnection!required
connectionID	ID
createdAt	Time!required
dialect	String!required
fields	[Field]
id	ID!required
ioSchema	IOSchema
metaGraph	MetaGraph!required
metadata	Map
params	[Param]
results	SQLQueryOutput
space	Space!required
spaceID	ID!required
sql	String!required
sqlCanonical	String!required
updatedAt	Time!required
user	User!required
userID	ID!required

SQLQueryConnection

Object

A connection to a list of items.

Field	Type	Description
edges	[SQLQueryEdge]	A list of edges.
pageInfo	PageInfo!required	Information to aid in pagination.
totalCount	Int!required	Identifies the total count of items in the connection.

SQLQueryCreated

Object

Field	Type	Description
created	Boolean!required
error	String
sqlQuery	SQLQuery

SQLQueryDeleted

Object

Field	Type	Description
deleted	Boolean!required
error	String
id	ID

SQLQueryEdge

Object

An edge in a connection.

Field	Type	Description
cursor	Cursor!required	A cursor for use in pagination.
node	SQLQuery	The item at the end of the edge.

SQLQueryOutput

Object

Field	Type	Description
fields	[Field!]
nextPage	String
params	[Param!]
prevPage	String
rows	[Map]!required
rowsCount	Int!required
totalPages	Int!required
totalRows	Int!required

SQLQueryUpdated

Object

Field	Type	Description
error	String
sqlQuery	SQLQuery
updated	Boolean!required

SQLQueryValidation

Object

Field	Type	Description
columnIDs	[ID!]
connectionID	ID
dialect	String!required
error	String
fields	[Field!]
isValid	Boolean!required
params	[Param!]
spaceID	ID!required
sql	String!required

SchemaRef

Object

Field	Type	Description
alias	String!required
autoSync	Boolean!required
catalog	Catalog!required
catalogID	ID!required
createdAt	Time!required
deletedAt	Time
description	String
id	ID!required
model	Model
modelID	ID
name	String!required
source	Source
sourceID	ID
syncError	String
syncStatus	SyncStatus!required
syncedAt	Time
tables	TableRefConnection!required
updatedAt	Time!required

SchemaRefConnection

Object

A connection to a list of items.

Field	Type	Description
edges	[SchemaRefEdge]	A list of edges.
pageInfo	PageInfo!required	Information to aid in pagination.
totalCount	Int!required	Identifies the total count of items in the connection.

SchemaRefCreated

Object

Field	Type	Description
created	Boolean!required
error	String
schemaRef	SchemaRef

SchemaRefDeleted

Object

Field	Type	Description
deleted	Boolean!required
error	String
id	ID

SchemaRefEdge

Object

An edge in a connection.

Field	Type	Description
cursor	Cursor!required	A cursor for use in pagination.
node	SchemaRef	The item at the end of the edge.

SchemaRefUpdated

Object

Field	Type	Description
error	String
schemaRef	SchemaRef
updated	Boolean!required

SearchLexeme

Object

Field	Type	Description
createdAt	Time!required
id	ID!required
nodeID	ID!required
nodeType	String!required
organization	Organization
organizationID	ID
searchText	String!required
updatedAt	Time!required

SearchLexemeConnection

Object

A connection to a list of items.

Field	Type	Description
edges	[SearchLexemeEdge]	A list of edges.
pageInfo	PageInfo!required	Information to aid in pagination.
totalCount	Int!required	Identifies the total count of items in the connection.

SearchLexemeCreated

Object

Field	Type	Description
created	Boolean!required
error	String
searchLexeme	SearchLexeme

SearchLexemeDeleted

Object

Field	Type	Description
deleted	Boolean!required
error	String
id	ID

SearchLexemeEdge

Object

An edge in a connection.

Field	Type	Description
cursor	Cursor!required	A cursor for use in pagination.
node	SearchLexeme	The item at the end of the edge.

SearchLexemeUpdated

Object

Field	Type	Description
error	String
searchLexeme	SearchLexeme
updated	Boolean!required

SearchResult

Object

Field	Type	Description
node	Node!required	The result node.
rank	Float!required	The score of the search result.
text	String!required	The textual representation of the node.

SearchResults

Object

Field	Type	Description
results	[SearchResult]!required	The search results.
totalCount	Int!required	Identifies the total count of items in the connection.

SearchSemantic

Object

Field	Type	Description
autoSync	Boolean!required
createdAt	Time!required
id	ID!required
nodeID	ID!required
nodeType	String!required
organization	Organization
organizationID	ID
searchText	String!required
syncError	String
syncStatus	SyncStatus!required
syncedAt	Time
updatedAt	Time!required

SearchSemanticConnection

Object

A connection to a list of items.

Field	Type	Description
edges	[SearchSemanticEdge]	A list of edges.
pageInfo	PageInfo!required	Information to aid in pagination.
totalCount	Int!required	Identifies the total count of items in the connection.

SearchSemanticCreated

Object

Field	Type	Description
created	Boolean!required
error	String
searchSemantic	SearchSemantic

SearchSemanticDeleted

Object

Field	Type	Description
deleted	Boolean!required
error	String
id	ID

SearchSemanticEdge

Object

An edge in a connection.

Field	Type	Description
cursor	Cursor!required	A cursor for use in pagination.
node	SearchSemantic	The item at the end of the edge.

SearchSemanticUpdated

Object

Field	Type	Description
error	String
searchSemantic	SearchSemantic
updated	Boolean!required

Source

Object

Field	Type	Description
autoSync	Boolean!required
catalog	Catalog!required
catalogID	ID!required
config	Map
connection	Connection!required
connectionID	ID!required
createdAt	Time!required
deletedAt	Time
destination	Destination!required
destinationID	ID!required
externalReports	[ExternalReport]
id	ID!required
models	[Model!]
name	String!required
providerID	String!required
schema	SchemaRef!required
syncError	String
syncFreq	Int!required	Frequency of sync in minutes (default: 360 minutes (6 hours))
syncStatus	SyncStatus!required
syncTime	String!required	Time of day to sync, has no effect when syncFreq is < 24 hours (default: 00:00)
syncedAt	Time
type	SourceType!required
typeID	ID!required
updatedAt	Time!required

SourceConfig

Object

Field	Type	Description
category	String!required
description	String!required
iconUrl	String!required
id	String!required
name	String!required
schema	String!required
service	String!required

SourceConnection

Object

A connection to a list of items.

Field	Type	Description
edges	[SourceEdge]	A list of edges.
pageInfo	PageInfo!required	Information to aid in pagination.
totalCount	Int!required	Identifies the total count of items in the connection.

SourceCreated

Object

Field	Type	Description
created	Boolean!required
error	String
source	Source

SourceDeleted

Object

Field	Type	Description
deleted	Boolean!required
error	String
id	ID

SourceEdge

Object

An edge in a connection.

Field	Type	Description
cursor	Cursor!required	A cursor for use in pagination.
node	Source	The item at the end of the edge.

SourceServiceMetadata

Object

Field	Type	Description
sourceConfigs	[SourceConfig!]!required

SourceType

Object

Field	Type	Description
category	String!required
check	SourceTypeCheck!required
configSchema	String!required
connection	Connection!required
connectionID	ID!required
createdAt	Time!required
description	String!required
iconURL	String!required
id	ID!required
modelTypes	[ModelType!]
name	String!required
providerID	String!required
slug	String!required
sources	[Source!]
updatedAt	Time!required

SourceTypeCheck

Object

Field	Type	Description
authCheck	AuthCheck!required
configData	Map

SourceTypeConnection

Object

A connection to a list of items.

Field	Type	Description
edges	[SourceTypeEdge]	A list of edges.
pageInfo	PageInfo!required	Information to aid in pagination.
totalCount	Int!required	Identifies the total count of items in the connection.

SourceTypeCreated

Object

Field	Type	Description
created	Boolean!required
error	String
sourceType	SourceType

SourceTypeDeleted

Object

Field	Type	Description
deleted	Boolean!required
error	String
id	ID

SourceTypeEdge

Object

An edge in a connection.

Field	Type	Description
cursor	Cursor!required	A cursor for use in pagination.
node	SourceType	The item at the end of the edge.

SourceTypeUpdated

Object

Field	Type	Description
error	String
sourceType	SourceType
updated	Boolean!required

SourceUpdated

Object

Field	Type	Description
error	String
source	Source
updated	Boolean!required

Space

Object

Field	Type	Description
catalogs	CatalogConnection!required
createdAt	Time!required
id	ID!required
metaGraph	MetaGraph!required
name	String!required
organization	Organization!required
organizationID	ID!required
slug	String!required
sqlQueries	SQLQueryConnection!required
tzName	String!required	Timezone name (e.g. America/Los_Angeles)
updatedAt	Time!required

SpaceConnection

Object

A connection to a list of items.

Field	Type	Description
edges	[SpaceEdge]	A list of edges.
pageInfo	PageInfo!required	Information to aid in pagination.
totalCount	Int!required	Identifies the total count of items in the connection.

SpaceCreated

Object

Field	Type	Description
created	Boolean!required
error	String
space	Space

SpaceDeleted

Object

Field	Type	Description
deleted	Boolean!required
error	String
id	ID

SpaceEdge

Object

An edge in a connection.

Field	Type	Description
cursor	Cursor!required	A cursor for use in pagination.
node	Space	The item at the end of the edge.

SpaceUpdated

Object

Field	Type	Description
error	String
space	Space
updated	Boolean!required

Subscription

Object

Field	Type	Description
flowRunSubscribe	FlowRunEvent!required
nodeSubscribe	NodeEvent!required

TableRef

Object

Field	Type	Description
alias	String!required
autoSync	Boolean!required
columns	ColumnRefConnection!required
createdAt	Time!required
deletedAt	Time
description	String
fields	[Field]
id	ID!required
ioSchema	IOSchema
metaGraph	MetaGraph!required
name	String!required
schema	SchemaRef!required
schemaID	ID!required
syncError	String
syncStatus	SyncStatus!required
syncedAt	Time
tableType	String
totalBytes	Int
totalRows	Int
updatedAt	Time!required

TableRefConnection

Object

A connection to a list of items.

Field	Type	Description
edges	[TableRefEdge]	A list of edges.
pageInfo	PageInfo!required	Information to aid in pagination.
totalCount	Int!required	Identifies the total count of items in the connection.

TableRefCreated

Object

Field	Type	Description
created	Boolean!required
error	String
tableRef	TableRef

TableRefDeleted

Object

Field	Type	Description
deleted	Boolean!required
error	String
id	ID

TableRefEdge

Object

An edge in a connection.

Field	Type	Description
cursor	Cursor!required	A cursor for use in pagination.
node	TableRef	The item at the end of the edge.

TableRefUpdated

Object

Field	Type	Description
error	String
tableRef	TableRef
updated	Boolean!required

User

Object

Field	Type	Description
banexpires	Time
banned	Boolean!required
banreason	String
connectionUser	[ConnectionUser!]
createdAt	Time!required
email	String
emailVerified	Boolean
id	ID!required
image	String
name	String
packages	[IntegrationPackage!]
personalAccessTokens	[PersonalAccessToken!]
role	String
sqlQueries	SQLQueryConnection!required
termsAndPrivacyAcceptedAt	Time
twoFactorEnabled	Boolean!required
tzName	String!required	Timezone name (e.g. America/Los_Angeles)
updatedAt	Time!required

UserConnection

Object

A connection to a list of items.

Field	Type	Description
edges	[UserEdge]	A list of edges.
pageInfo	PageInfo!required	Information to aid in pagination.
totalCount	Int!required	Identifies the total count of items in the connection.

UserCreated

Object

Field	Type	Description
created	Boolean!required
error	String
user	User

UserDeleted

Object

Field	Type	Description
deleted	Boolean!required
error	String
id	ID

UserEdge

Object

An edge in a connection.

Field	Type	Description
cursor	Cursor!required	A cursor for use in pagination.
node	User	The item at the end of the edge.

UserUpdated

Object

Field	Type	Description
error	String
updated	Boolean!required
user	User

WriteTableOutput

Object

Field	Type	Description
rowsWritten	Int64!required
table	TableRef!required