Schema Types

Table of Contents * [Query](#query) * [Objects](#objects) * [Application](#application) * [Batch](#batch) * [ClickstreamConfig](#clickstreamconfig) * [ClickstreamPrototype](#clickstreamprototype) * [Connection](#connection) * [ConnectionConfig](#connectionconfig) * [DecodedToken](#decodedtoken) * [Email](#email) * [Event](#event) * [EventReportResponse](#eventreportresponse) * [Integration](#integration) * [LegacyUserProfile](#legacyuserprofile) * [LifetimeEventResponse](#lifetimeeventresponse) * [Mutation](#mutation) * [Organization](#organization) * [StatusMessage](#statusmessage) * [Subscription](#subscription) * [Token](#token) * [User](#user) * [UserPolicy](#userpolicy) * [UserProfile](#userprofile) * [Enums](#enums) * [ConnectionActions](#connectionactions) * [IntegrationActions](#integrationactions) * [TimePeriods](#timeperiods) * [Scalars](#scalars) * [Boolean](#boolean) * [Date](#date) * [Float](#float) * [ID](#id) * [Int](#int) * [JSON](#json) * [String](#string) * [Interfaces](#interfaces)

Query

Field Argument Type Description
application ⚠️ Application Find application by id

⚠️ DEPRECATED

No longer supported
id String!
applications [Application] Find all applications associated with an organization
orgId ID
appId String
applicationLifetimeEvents LifetimeEventResponse
appId String!
timezone String
healthcheck String
dipstick String
connection ConnectionConfig Find specific connection by id
connectionId String!
orgConnections [ConnectionConfig] Find all connections that an organization has access to, optional filter to screen for a specific type of integration
orgId String!
connectionPrototype ID
integrations ⚠️ [Integration]

⚠️ DEPRECATED

No longer supported
code String
platform String
organizations [Organization] Find all organizations that a user is added to
userId String
orgId ID
organization ⚠️ Organization Find organization by id

⚠️ DEPRECATED

No longer supported
orgId String!
airflowStatus JSON
orgId String!
self User Find current session's user data
clickstreamLiveEvents [JSON]
clickstreamPrototypes [ClickstreamPrototype]
code String
platform String
clickstreamConfigs [ClickstreamConfig] Find all integrations configured for a specific application
appId String!
clickstreamConfig ClickstreamConfig
id ID!
dataPaceByApplications JSON
applications [String!]
eventTotals EventReportResponse
dates EventReport!
applications [String!]
units String!
timezone String

Objects

Application

The event broadcaster (data source), sends data to integrations (data destinations)

Field Argument Type Description
id String
name String
platform String
clickstream [ClickstreamConfig]

Batch

Field Argument Type Description
hostname String
connection String
dagURI String
dagRepo String
monitoringURL String
dashboardURL String
apiKey String

ClickstreamConfig

The event reciever (data destination), specific settings for a event broadcaster (data source)

Field Argument Type Description
id String
application String
name String
code String
enabled Boolean
config JSON
connection ID

ClickstreamPrototype

Field Argument Type Description
id String
code String
name String
branding JSON
platforms [String]
configPrototype [JSON]
connectionPrototype [JSON]
connectionPrototypeId ID

Connection

Field Argument Type Description
id ID
provider String
category String
connectionPrototype [JSON]
details ⚠️ JSON

⚠️ DEPRECATED

No longer supported
name ⚠️ String

⚠️ DEPRECATED

No longer supported
code ⚠️ String

⚠️ DEPRECATED

No longer supported

ConnectionConfig

Field Argument Type Description
id ID
name String
code ⚠️ String

⚠️ DEPRECATED

No longer supported
connectionPrototype JSON
category String
details JSON
organization ID
vpnConnection ID

DecodedToken

User properities decoded directly from the generated token

Field Argument Type Description
id ID User's ID
sU Boolean SuperUser: If the user can do super-cool things... like admin roles ;)
iat Int Birthdate, in epoch
exp Int Deathdate, in epoch

Email

User email object, modeled after Meteor

Field Argument Type Description
address String
verified Boolean

Event

Field Argument Type Description
id String
name String
time String

EventReportResponse

Field Argument Type Description
success Boolean
message String
startTime String String until get API to support epoch
endTime String String until get API to support epoch
total Int
results JSON

Integration

DEPRECATED: The event reciever (data destination), this is the model in with Clickstrem Integration Configs are modeled after

Field Argument Type Description
id String
code String
name String
color String
platforms [String]
config [JSON]
privateConfig [JSON]
advancedConfig [JSON]
info String
branding JSON
connectionPrototype [JSON]

LegacyUserProfile

Field Argument Type Description
id String
applications [String]
migratedApplications [String]
emails [Email]

LifetimeEventResponse

Field Argument Type Description
success Boolean
message String
total Int String until get API to support epoch
dailyAverage Int

Mutation

Field Argument Type Description
createApplication StatusMessage Create an application within a organization
name String!
orgId String!
platform String!
removeApplication StatusMessage Remove an application and no longer reference it within this organization
appId String!
orgId String!
updateApplication StatusMessage Update applicaion data. actions are "UPDATE_NAME", "UPDATE_PLATFORM". Payload needs to be an object with the key of what you want to replace changes of
appId String!
action String!
payload JSON!
retrieveConnection ⚠️ Connection

⚠️ DEPRECATED

No longer supported
id ID!
createConnection StatusMessage
integrationCode String
details JSON!
name String!
orgId String!
connectionPrototypeId ID!
updateConnection StatusMessage
connectionId String!
action String!
payload JSON
retrieveIntegration ClickstreamConfig Find specific integration by it's id
id ID!
createIntegration StatusMessage
appId String!
integrationCode String!
configPayload JSON!
connectionId String!
name String!
updateIntegration StatusMessage
integrationId String!
action String!
payload JSON
createOrganization StatusMessage Create an organization and link to a user (the creator is added as a owner)
name String!
userId String!
deleteOrganization StatusMessage
orgId String!
addOrganizationUser StatusMessage Adds a user (by email or id) as a Org User
email String
userId String
orgId String!
updateOrganizationUser StatusMessage "REMOVE", "PROMOTE" (to admin) or "DEMOTE" (from admin) for an org.
userId String!
orgId String!
action String!
updateOrganization StatusMessage Update Organization data, right now it's only "UPDATE_NAME"
orgId String!
action String!
payload JSON!
airflowDeploy StatusMessage
orgId String!
package String!
createToken Token Verify user's credentials and issues a token if valid
username String!
password String!
orgId String
permission String
verifyToken Token Check a user's token to make sure it is still valid, decode the user object hidden inside
token String!
forgotPasswordEmail StatusMessage
email String!
createNewUser Token Add a new user to Astronomer
email String!
password String!
profile JSON
changeUserPassword StatusMessage
userId String!
password String!
updateUser StatusMessage Expects UPDATE_NAME, UPDATE_POLICY, or DELETE
userId String!
action String!
payload JSON
verifyUserEmail StatusMessage
userId String!
email String!

Organization

User groups that own applications, and all that lays within applications

Field Argument Type Description
id ID
name String
applications [ID]
users [User]
owners [User]
plan JSON
status String
batch Batch

StatusMessage

Response to most mutations, will always give a TRUE/FALSE for success and a message describing the success of a mutation

Field Argument Type Description
success Boolean Did it work?
code Int Not implimented yet, will return standardized code value for front-end control over human-friendly messages
message String Houston provided human-friendly messages
id String Returns the id of whatever was affected by the mutation

Subscription

Field Argument Type Description
newClickstreamLiveEvent JSON Subscription fires on every comment added
channel String!

Token

Token response. Will always pass back the token submitted, unless one was created. So feel free to store whatever is returned. Tie success/error to the “success” properity, as the rest of the fields (expect message) will return null otherwise

Field Argument Type Description
success Boolean Is the token valid?
message String (Mostly) human-friendly message about token result
token String Returns the token either generated or passed back thru
decoded DecodedToken Will give the user object that is stored within the token

User

User from App.Astronomer

Field Argument Type Description
id ID
emails [Email]
profile UserProfile
username String
status String

UserPolicy

Field Argument Type Description
terms Float
privacy Float

UserProfile

Field Argument Type Description
firstName String
lastName String
company String
image String
referrals [String]
v1 LegacyUserProfile
policy UserPolicy

Enums

ConnectionActions

Value Description
UPDATE_ALL
UPDATE_CREDENTIALS
UPDATE_NAME
DELETE

IntegrationActions

Value Description
ENABLE
DISABLE
DELETE
UPDATE_CONFIG Requires payload.config, replaces current integration config value with provided one
UPDATE_CONNECTION Requires payload.connectionId, replaces current integration connection id with provided one
UPDATE_NAME
UPDATE_ALL

TimePeriods

Value Description
seconds Units of time measurement that match Kairos standards
minutes
hours
days
weeks
months
years

Scalars

Boolean

The Boolean scalar type represents true or false.

Date

Float

The Float scalar type represents signed double-precision fractional values as specified by IEEE 754.

ID

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.

Int

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

JSON

The JSON scalar type represents JSON values as specified by ECMA-404.

String

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.

Interfaces